Struct Accelerator

pub struct Accelerator { /* private fields */ }

A keyboard shortcut that consists of an optional combination of modifier keys (provided by Modifiers and one key (Code).

Implementations

impl Accelerator

pub fn new(mods: Option<Modifiers>, key: Code) -> Accelerator

Creates a new 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 matches( &self, modifiers: impl Borrow<Modifiers>, key: impl Borrow<Code>, ) -> bool

Returns true if this Code and Modifiers matches this Accelerator.

impl Accelerator

pub fn key_equivalent(self) -> Result<String, AcceleratorParseError>

Return the string value of this hotkey, without modifiers.

Returns the empty string if no key equivalent is known.

pub fn key_modifier_mask(self) -> NSEventModifierFlags

Return the modifiers of this hotkey, as an NSEventModifierFlags bitflag.

Trait Implementations

impl Clone for Accelerator

fn clone(&self) -> Accelerator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Accelerator

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

Formats the value using the given formatter.

impl FromStr for Accelerator

type Err = AcceleratorParseError

The associated error which can be returned from parsing.

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

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

impl Hash for Accelerator

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 Accelerator

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for Accelerator

type Error = AcceleratorParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Accelerator

type Error = AcceleratorParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Accelerator

impl Eq for Accelerator

impl StructuralPartialEq for Accelerator