Struct Chord 

pub struct Chord {
    pub key: Key,
    pub mods: Modifiers,
}

The keyboard vocabulary app code names: a Chord bound with shortcuts in a ShortcutScope, the ShortcutHint a palette lists (RenderRoot::shortcut_hints, labels rendered with Chord::display), the FocusRingPolicy deciding when a Tab-focused control shows its ring, and the OverlayKeys class that makes a floated surface modal for keys. Lifted flat for EditCommand’s reason. A key plus the exact modifier set it must be pressed with.

Fields

key: Key

A character key is stored lowercased and matched case-insensitively.

mods: Modifiers

Implementations

impl Chord

pub fn new(key: Key, mods: Modifiers) -> Chord

A chord from its parts; a character key is lowercased so it matches either case, and a Shift-insensitive symbol key (see Chord::matches) drops mods.shift.

pub fn parse(spec: &str) -> Result<Chord, ChordParseError>

Parse "Mod+K", "Shift+Tab", "Ctrl+Shift+P", "1", "F2": +-separated, case-insensitive modifiers then one key. Mod is Command on macOS/iOS and Ctrl elsewhere, chosen at compile time, so a web build running on a Mac maps it to Ctrl. A symbol key (+, ?, !) ignores Shift, so "Shift+?" parses as "?"; spell Shift+1 as !.

pub fn matches(&self, event: &KeyEvent) -> bool

Whether event presses this chord: the same key (characters case-insensitively) and exactly the same modifiers. A symbol key (a character that is neither alphanumeric nor whitespace) ignores event.modifiers.shift, because shells report Shift for the keys that need it; ctrl, alt and meta still compare. An auto-repeat matches like a fresh press.

pub fn display(&self) -> String

The chord as a hint surface shows it, by Mod’s compile-time rule: "⌘K", "⇧⌘P" on macOS/iOS (symbols in ⌃⌥⇧⌘ order, unseparated), "Ctrl+K", "Ctrl+Shift+P" elsewhere.

Trait Implementations

impl Clone for Chord

fn clone(&self) -> Chord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chord

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

Formats the value using the given formatter.

impl Eq for Chord

impl PartialEq for Chord

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Chord