Struct HotKey

pub struct HotKey {
    pub mods: Modifiers,
    pub key: Code,
    pub id: u32,
    pub name: Option<String>,
}

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

Fields

mods: Modifiers

The hotkey modifiers.

key: Code

The hotkey key.

id: u32

The hotkey id.

name: Option<String>

The hotkey name.

Implementations

impl HotKey

pub fn new(mods: Option<Modifiers>, key: Code, name: Option<String>) -> Self

Creates a new hotkey 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 hotKey which is a hash of the string represention of modifiers and key within this hotKey.

pub fn name(&self) -> Option<String>

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

Returns true if this Code and Modifiers matches this hotkey.

pub fn into_string(&self) -> String

Converts this hotkey into a string.

Trait Implementations

impl Clone for HotKey

fn clone(&self) -> HotKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HotKey

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

Formats the value using the given formatter.

impl Display for HotKey

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

Formats the value using the given formatter.

impl FromStr for HotKey

type Err = HotKeyParseError

The associated error which can be returned from parsing.

fn from_str(hotkey_string: &str) -> Result<Self, Self::Err>

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

impl Hash for HotKey

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 HotKey

fn eq(&self, other: &HotKey) -> 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 HotKey

type Error = HotKeyParseError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for HotKey

type Error = HotKeyParseError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for HotKey

impl StructuralPartialEq for HotKey