Struct hookmap::interface::ConditionalHotkey

pub struct ConditionalHotkey { /* fields omitted */ }

A struct for selecting the target of the conditional hook.

Example

use hookmap::*;
let hotkey = Hotkey::new();
let mod_ctrl = hotkey.add_modifiers((&[Button::LCtrl.into()], &[]));
mod_ctrl.remap(Button::H).to(Button::LeftArrow);

Implementations

impl ConditionalHotkey

pub fn builder() -> ConditionalHotkeyBuilder<((), (), ())>

Create a builder for building ConditionalHotkey. On the builder, call .register(...), .modifier_keys(...)(optional), .event_block(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ConditionalHotkey.

Trait Implementations

impl SelectHandleTarget for ConditionalHotkey

fn bind(&self, trigger: impl Into<ButtonSet>) -> ButtonEventHandlerEntry

Returns a ButtonEventHandlerEntry for registering a hook to the button.

fn bind_all(&self) -> ButtonEventHandlerEntry

Returns a ButtonEventHandlerEntry for registering a hook to the every button.

fn remap(&self, target: impl Into<ButtonSet>) -> RemapEntry

Remap keys.

fn bind_mouse_wheel(&self) -> MouseWheelHotkeyEntry

Returns a MouseWheelHotkeyEntry for registering a hook to the mouse wheel.

fn bind_mouse_cursor(&self) -> MouseCursorHotKeyEntry

Returns a MouseCursorHotKeyEntry for registering a hook to the mouse wheel.

fn add_modifiers(
    &self,
    (pressed, released): (&[ButtonSet], &[ButtonSet])
) -> ConditionalHotkey

Add a modifier button to the hotkey to be registered.

impl SetEventBlock for ConditionalHotkey

fn block(&self) -> Self

Blocks the input event when the hook to be registered is enable.

fn unblock(&self) -> Self

Do not block the input event when the hook to be registered is enable.