Struct KeybindingKeystroke 

pub struct KeybindingKeystroke { /* private fields */ }

A keystroke as it appears in a keybinding, ready to display to the user.

A KeyBinding stores its keystrokes as KeybindingKeystrokes. On Windows, the modifiers and key shown to the user can differ from the ones used for matching.

Implementations

impl KeybindingKeystroke

pub fn new_with_mapper( inner: Keystroke, use_key_equivalents: bool, keyboard_mapper: &dyn PlatformKeyboardMapper, ) -> Self

Creates a keybinding keystroke from inner, mapped by keyboard_mapper.

The platform’s PlatformKeyboardMapper decides what changes. On macOS, when use_key_equivalents is true and the current layout types a different character for the key, the key is replaced with that character.

pub fn from_keystroke(keystroke: Keystroke) -> Self

Creates a keybinding keystroke from keystroke with no platform-specific mapping.

pub fn inner(&self) -> &Keystroke

Returns the Keystroke that matching uses.

pub fn modifiers(&self) -> &Modifiers

Returns the modifiers.

Platform-specific behavior:

• On macOS and Linux, this modifiers is the same as inner.modifiers, which is the GPUI representation of the keystroke.
• On Windows, this modifiers is the display modifiers, for example, a ctrl-@ keystroke will have inner.modifiers as Modifiers::control() and display_modifiers as Modifiers::control_shift().

pub fn key(&self) -> &str

Returns the key.

Platform-specific behavior:

• On macOS and Linux, this key is the same as inner.key, which is the GPUI representation of the keystroke.
• On Windows, this key is the display key, for example, a ctrl-@ keystroke will have inner.key as @ and display_key as 2.

pub fn set_modifiers(&mut self, modifiers: Modifiers)

Sets the modifiers. On Windows this modifies both inner.modifiers and display_modifiers.

pub fn set_key(&mut self, key: String)

Sets the key. On Windows this modifies both inner.key and display_key.

pub fn unparse(&self) -> String

Returns text that Keystroke::parse reads back as this keystroke, using the displayed modifiers and key on Windows. See Keystroke::unparse.

pub fn remove_key_char(&mut self)

Clears key_char, so that matching and display use only key and the modifiers.

Trait Implementations

impl AsKeystroke for KeybindingKeystroke

fn as_keystroke(&self) -> &Keystroke

Returns the Keystroke this value represents.

impl Clone for KeybindingKeystroke

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeybindingKeystroke

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

Formats the value using the given formatter.

impl Display for KeybindingKeystroke

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

Formats the value using the given formatter.

impl Eq for KeybindingKeystroke

impl Hash for KeybindingKeystroke

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 KeybindingKeystroke

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeybindingKeystroke