Struct Accel 

pub struct Accel {
    pub code: KeyCode,
    pub mods: KeyMods,
}

A keyboard shortcut, parsed out of the string an item declares.

The core binds nothing to it and never has (MenuItem::accel is display); this exists for the one consumer that needs the parts rather than the words — a platform menu bar, which sets a real key equivalent and then matches it before the window ever sees the key.

Both spellings parse, because both are written in the field: the portable one ("mod+shift+s", where mod is Command on macOS and Control elsewhere) and the platform one a menu is read in ("⇧⌘S", "Ctrl+Shift+S"). Accel::display is the second, which is what declare_menu_bar normalizes a declaration into so the drawn bar and the platform’s read the same.

Fields

code: KeyCode

mods: KeyMods

Implementations

impl Accel

pub fn parse(s: &str) -> Option<Accel>

Parses "mod+s", "ctrl+shift+p", "f5", "⇧⌘S". None for anything this vocabulary cannot name — the caller then leaves the string alone and draws it as written, since a shortcut kui cannot parse is still a shortcut the app’s own keymap runs.

pub fn display(&self) -> String

How the platform writes it: the macOS glyph run (⇧⌘S, in AppKit’s order, no separators) or the spelled form (Ctrl+Shift+S).

pub fn label(spelled: &str) -> Cow<'_, str>

What a menu draws for the accelerator spelled: its Accel::display when it parses, and spelled itself when it does not — a shortcut kui cannot name is still one the app’s own keymap runs, and its spelling is the app’s (ADR 0018, decision 7). The drawn menu, the drawn bar and open_menu all read an accelerator through this, so a portable "mod+shift+n" never reaches the screen as written (backlog F127).

pub fn spelling(&self) -> String

The portable spelling, the one Accel::parse reads back to the same chord on every platform: the modifiers held as ctrl, super, alt, shift in that order, then the key by its wire name ("ctrl+shift+i", "super+alt+f12"). What a binding hands out when it reads a chord back; Accel::display is what a person reads.

pub fn key_equivalent(&self) -> Option<String>

The key equivalent an NSMenuItem takes: the character, lowercased (AppKit reads an uppercase one as Shift being held), or None for a key AppKit spells with a function-key code this does not carry.

Trait Implementations

impl Clone for Accel

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Accel

impl Debug for Accel

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

Formats the value using the given formatter.

impl Eq for Accel

impl PartialEq for Accel

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Accel