Struct ShortcutEvent

pub struct ShortcutEvent {
    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 GlobalHotKeyEvent

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 Receiver<GlobalHotKeyEvent>

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

Note

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

pub fn set_event_handler<F>(f: Option<F>)

where F: Fn(GlobalHotKeyEvent) + Send + Sync + 'static,

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 GlobalHotKeyEvent::receiver

Trait Implementations

impl Clone for GlobalHotKeyEvent

fn clone(&self) -> GlobalHotKeyEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalHotKeyEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GlobalHotKeyEvent

fn deserialize<__D>( __deserializer: __D, ) -> Result<GlobalHotKeyEvent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for GlobalHotKeyEvent

fn cmp(&self, other: &GlobalHotKeyEvent) -> 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 GlobalHotKeyEvent

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

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

const 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 GlobalHotKeyEvent

fn partial_cmp(&self, other: &GlobalHotKeyEvent) -> 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 Serialize for GlobalHotKeyEvent

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for GlobalHotKeyEvent

impl Eq for GlobalHotKeyEvent

impl StructuralPartialEq for GlobalHotKeyEvent