Struct KeyStroke 

pub struct KeyStroke {
    pub key: Key,
    pub modifiers: Modifiers,
}

A single keyboard chord: a key plus its modifiers.

Fields

key: Key

modifiers: Modifiers

Implementations

impl KeyStroke

pub fn new(key: Key, modifiers: Modifiers) -> Self

pub fn ctrl(key: Key) -> Self

A chord on Ctrl.

Read as a declared shortcut default this carries the cross-platform primary-accelerator convention: see with_command_convention for what the registry does with it on macOS. Use command when you want that intent stated outright, and new with Modifiers::CTRL plus ShortcutBuilder::literal_modifiers when you mean physical Control on every platform.

pub fn ctrl_shift(key: Key) -> Self

pub fn command(key: Key) -> Self

A chord on the platform’s primary accelerator: ⌘S on macOS, Ctrl+S on Windows and Linux. See Modifiers::COMMAND.

Equivalent to ctrl once a declared shortcut has been resolved, but it says so at the call site — which matters for the chords built outside the registry, like the copy/paste labels a context menu renders for itself.

pub fn command_shift(key: Key) -> Self

A chord on the platform’s primary accelerator plus Shift: ⇧⌘Z on macOS, Ctrl+Shift+Z on Windows and Linux.

pub fn alt(key: Key) -> Self

pub fn with_command_convention(self) -> Self

This chord with a declared Ctrl reinterpreted as the platform’s primary accelerator (Modifiers::COMMAND) — ⌘ on macOS, unchanged everywhere else.

This is the convention Qt spells Qt::CTRL and the one Teksilo’s native menu bar has always applied when turning a declared chord into an NSMenuItem key equivalent. ShortcutRegistry applies it to every declared default, so an app that writes KeyStroke::ctrl(Key::F) once gets Ctrl+F on Windows and Linux and ⌘F on macOS — the same chord the menu row already advertised.

It is deliberately not applied to a user override: a chord the user captured in a settings UI is a literal statement of intent, and rewriting it would make physical ⌃F unbindable on macOS.

Idempotent, and a no-op for a chord that already names Super, so Ctrl+Super survives as the genuine ⌃⌘ two-modifier chord.

Trait Implementations

impl Clone for KeyStroke

fn clone(&self) -> KeyStroke

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyStroke

impl Debug for KeyStroke

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyStroke

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for KeyStroke

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

Formats the value using the given formatter.

impl Eq for KeyStroke

impl Hash for KeyStroke

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyStroke

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for KeyStroke

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyStroke