Enum winit::keyboard::KeyLocation

pub enum KeyLocation {
    Standard,
    Left,
    Right,
    Numpad,
}

The location of the key on the keyboard.

Certain physical keys on the keyboard can have the same value, but are in different locations. For instance, the Shift key can be on the left or right side of the keyboard, or the number keys can be above the letters or on the numpad. This enum allows the user to differentiate them.

See the documentation for the location field on the KeyEvent struct for more information.

Variants

Standard

The key is in its “normal” location on the keyboard.

For instance, the “1” key above the “Q” key on a QWERTY keyboard will use this location. This invariant is also returned when the location of the key cannot be identified.

_{For image attribution, see the ATTRIBUTION.md file.}

Left

The key is on the left side of the keyboard.

For instance, the left Shift key below the Caps Lock key on a QWERTY keyboard will use this location.

_{For image attribution, see the ATTRIBUTION.md file.}

Right

The key is on the right side of the keyboard.

For instance, the right Shift key below the Enter key on a QWERTY keyboard will use this location.

_{For image attribution, see the ATTRIBUTION.md file.}

Numpad

The key is on the numpad.

For instance, the “1” key on the numpad will use this location.

_{For image attribution, see the ATTRIBUTION.md file.}

Trait Implementations

impl Clone for KeyLocation

fn clone(&self) -> KeyLocation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyLocation

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

Formats the value using the given formatter.

impl Hash for KeyLocation

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 KeyLocation

fn cmp(&self, other: &KeyLocation) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for KeyLocation

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

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

impl Eq for KeyLocation

impl StructuralPartialEq for KeyLocation