Struct KeyChord 

#[non_exhaustive]
pub struct KeyChord {
    pub key: UiKey,
    pub modifiers: KeyModifiers,
}

A keyboard chord for app-level hotkey registration. Match a key with an exact modifier mask: KeyChord::ctrl('f') does not also match Ctrl+Shift+F, and KeyChord::vim('j') does not match if any modifier is held.

Register chords from App::hotkeys; the library matches them against incoming key presses ahead of focus activation routing and emits a UiEvent with kind = UiEventKind::Hotkey and key equal to the registered name.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: UiKey

modifiers: KeyModifiers

Implementations

impl KeyChord

pub fn vim(c: char) -> Self

A bare key with no modifiers (vim-style). KeyChord::vim('j') matches the j key with no Ctrl/Shift/Alt/Logo held.

pub fn ctrl(c: char) -> Self

Ctrl+<char>.

pub fn ctrl_shift(c: char) -> Self

Ctrl+Shift+<char>.

pub fn named(key: UiKey) -> Self

A named key with no modifiers (e.g. KeyChord::named(UiKey::Escape)).

pub fn with_modifiers(self, modifiers: KeyModifiers) -> Self

pub fn matches(&self, key: &UiKey, modifiers: KeyModifiers) -> bool

Strict match: keys equal AND modifier mask is identical. Holding extra modifiers does not match a chord that didn’t request them.

Trait Implementations

impl Clone for KeyChord

fn clone(&self) -> KeyChord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyChord

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

Formats the value using the given formatter.

impl PartialEq for KeyChord

fn eq(&self, other: &KeyChord) -> 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 Eq for KeyChord

impl StructuralPartialEq for KeyChord