Struct KeyAccelerator 

pub struct KeyAccelerator { /* private fields */ }

A keyboard shortcut based on logical Key values.

Unlike Accelerator which uses physical Code keys, KeyAccelerator uses logical Key values which can represent any character including Unicode characters like +, €, {, etc.

Examples

They can be created directly

let accel = KeyAccelerator::new(Some(Modifiers::CONTROL), Key::Character("+".into()));

or converted from an existing Accelerator

let old_accel = Accelerator::new(Some(Modifiers::CONTROL), Code::KeyC);
let new_accel: KeyAccelerator = old_accel.into();

or parsed from a string, which supports literal character keys

let accel: KeyAccelerator = "Ctrl++".parse().unwrap();
let accel2: KeyAccelerator = "Ctrl+€".parse().unwrap();

Implementations

impl KeyAccelerator

pub fn new(mods: Option<Modifiers>, key: Key) -> KeyAccelerator

Creates a new key accelerator to define keyboard shortcuts throughout your application. Only Modifiers::ALT, Modifiers::SHIFT, Modifiers::CONTROL, and Modifiers::SUPER

pub fn id(&self) -> u32

Returns the id associated with this accelerator which is a hash of the string representation of modifiers and key within this accelerator.

pub fn modifiers(&self) -> Modifiers

Returns the modifiers for this accelerator.

pub fn key(&self) -> &Key

Returns the key for this accelerator.

pub fn matches( &self, modifiers: impl Borrow<Modifiers>, key: impl Borrow<Key>, ) -> bool

Returns true if this Key and Modifiers matches this KeyAccelerator.

Trait Implementations

impl Clone for KeyAccelerator

fn clone(&self) -> KeyAccelerator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyAccelerator

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

Formats the value using the given formatter.

impl Eq for KeyAccelerator

impl From<Accelerator> for KeyAccelerator

fn from(accel: Accelerator) -> KeyAccelerator

Converts to this type from the input type.

impl FromStr for KeyAccelerator

type Err = AcceleratorParseError

The associated error which can be returned from parsing.

fn from_str( accelerator_string: &str, ) -> Result<KeyAccelerator, <KeyAccelerator as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for KeyAccelerator

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

where __H: Hasher,

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 KeyAccelerator

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyAccelerator

impl TryFrom<&str> for KeyAccelerator

type Error = AcceleratorParseError

The type returned in the event of a conversion error.

fn try_from( value: &str, ) -> Result<KeyAccelerator, <KeyAccelerator as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for KeyAccelerator

type Error = AcceleratorParseError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<KeyAccelerator, <KeyAccelerator as TryFrom<String>>::Error>

Performs the conversion.