Enum AcceleratorKey

pub enum AcceleratorKey {
    Ctrl,
    Alt,
    Shift,
    Key(VirtualKeyCode),
}

Utility function for easier creation of a keymap - i.e. [vec![Ctrl, S], my_function]

Variants

Ctrl

Alt

Shift

Key(VirtualKeyCode)

Implementations

impl AcceleratorKey

pub fn matches(&self, keyboard_state: &KeyboardState) -> bool

Checks if the current keyboard state contains the given char or modifier, i.e. if the keyboard state currently has the shift key pressed and the accelerator key is Shift, evaluates to true, otherwise to false.

Trait Implementations

impl Clone for AcceleratorKey

fn clone(&self) -> AcceleratorKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AcceleratorKey

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

Formats the value using the given formatter.

impl Hash for AcceleratorKey

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 Ord for AcceleratorKey

fn cmp(&self, other: &AcceleratorKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AcceleratorKey

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

fn partial_cmp(&self, other: &AcceleratorKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for AcceleratorKey

impl Eq for AcceleratorKey

impl StructuralPartialEq for AcceleratorKey