Struct KeyBinding 

pub struct KeyBinding { /* private fields */ }

A keybinding and its associated metadata, from the keymap.

Implementations

impl KeyBinding

pub fn new<A: Action>( keystrokes: &str, action: A, context: Option<&str>, ) -> Self

Construct a new keybinding from the given data. Panics on parse error.

pub fn load( keystrokes: &str, action: Box<dyn Action>, context_predicate: Option<Rc<KeyBindingContextPredicate>>, use_key_equivalents: bool, action_input: Option<SharedString>, keyboard_mapper: &dyn PlatformKeyboardMapper, ) -> Result<Self, InvalidKeystrokeError>

Load a keybinding from the given raw data.

pub fn with_meta(self, meta: KeyBindingMetaIndex) -> Self

Set the metadata for this binding.

pub fn set_meta(&mut self, meta: KeyBindingMetaIndex)

Set the metadata for this binding.

pub fn match_keystrokes(&self, typed: &[impl AsKeystroke]) -> Option<bool>

Check if the given keystrokes match this binding.

pub fn keystrokes(&self) -> &[KeybindingKeystroke]

Get the keystrokes associated with this binding

pub fn action(&self) -> &dyn Action

Get the action associated with this binding

pub fn predicate(&self) -> Option<Rc<KeyBindingContextPredicate>>

Get the predicate used to match this binding

pub fn meta(&self) -> Option<KeyBindingMetaIndex>

Get the metadata for this binding

pub fn action_input(&self) -> Option<SharedString>

Get the action input associated with the action for this binding

Trait Implementations

impl Clone for KeyBinding

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 KeyBinding

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

Formats the value using the given formatter.