Struct HotkeyManager 

pub struct HotkeyManager<T> { /* private fields */ }

The HotkeyManager is used to register, unregister and await hotkeys with their callback functions.

Note

Due to limitations with the windows event system the HotkeyManager can’t be moved to other threads.

Implementations

impl<T> HotkeyManager<T>

pub fn set_no_repeat(&mut self, no_repeat: bool)

Enable or disable the automatically applied ModKey::NoRepeat modifier. By default, this option is set to true which causes all hotkey registration calls to add the NoRepeat modifier, thereby disabling automatic retriggers of hotkeys when holding down the keys.

When this option is disabled, the ModKey::NoRepeat can still be manually added while registering hotkeys.

Note: Setting this flag doesn’t change previously registered hotkeys. It only applies to registrations performed after calling this function.

Trait Implementations

impl<T> Default for HotkeyManager<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Drop for HotkeyManager<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> HotkeyManagerImpl<T> for HotkeyManager<T>

fn new() -> HotkeyManager<T>

Create a new HotkeyManager instance. This instance can’t be moved to other threads due to limitations in the windows events system.

fn register_extrakeys( &mut self, key: VKey, key_modifiers: &[ModKey], extra_keys: &[VKey], callback: impl Fn() -> T + Send + 'static, ) -> Result<HotkeyId, HkError>

Register a new hotkey with additional required extra keys.

fn register( &mut self, key: VKey, key_modifiers: &[ModKey], callback: impl Fn() -> T + Send + 'static, ) -> Result<HotkeyId, HkError>

Same as register_extrakeys but without extra keys.

fn unregister(&mut self, id: HotkeyId) -> Result<(), HkError>

Unregister a hotkey. This will prevent the hotkey from being triggered in the future.

fn unregister_all(&mut self) -> Result<(), HkError>

Unregister all registered hotkeys. This will be called automatically when dropping the HotkeyManager instance.

fn handle_hotkey(&self) -> Option<T>

Wait for a single a hotkey event and execute the callback if all keys match. This returns the callback result if it was not interrupted. The function call will block until a hotkey is triggered or it is interrupted.

fn event_loop(&self)

Run the event loop, listening for hotkeys. This will run indefinitely until interrupted and execute any hotkeys registered before.

fn interrupt_handle(&self) -> InterruptHandle

Get an InterruptHandle for this HotkeyManager that can be used to interrupt the event loop.