Struct WinHotKeyEvent

pub struct WinHotKeyEvent {
    pub id: u32,
    pub state: HotKeyState,
}

Describes a global hotkey event emitted when a HotKey is pressed or released.

Fields

id: u32

Id of the associated HotKey.

state: HotKeyState

State of the associated HotKey.

Implementations

impl WinHotKeyEvent

pub fn id(&self) -> u32

Returns the id of the associated HotKey.

pub fn state(&self) -> HotKeyState

Returns the state of the associated HotKey.

pub fn receiver<'a>() -> &'a WinHotKeyEventReceiver

Gets a reference to the event channel’s WinHotKeyEventReceiver which can be used to listen for global hotkey events.

Note

This will not receive any events if WinHotKeyEvent::set_event_handler has been called with a Some value.

pub fn set_event_handler<F: Fn(WinHotKeyEvent) + Send + Sync + 'static>( f: Option<F>, )

Set a handler to be called for new events. Useful for implementing custom event sender.

Note

Calling this function with a Some value, will not send new events to the channel associated with WinHotKeyEvent::receiver

Trait Implementations

impl Clone for WinHotKeyEvent

fn clone(&self) -> WinHotKeyEvent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WinHotKeyEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for WinHotKeyEvent

fn cmp(&self, other: &WinHotKeyEvent) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WinHotKeyEvent

fn eq(&self, other: &WinHotKeyEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for WinHotKeyEvent

fn partial_cmp(&self, other: &WinHotKeyEvent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for WinHotKeyEvent

impl StructuralPartialEq for WinHotKeyEvent