Struct ModifiersState

pub struct ModifiersState {
    pub ctrl: bool,
    pub alt: bool,
    pub shift: bool,
    pub caps_lock: bool,
    pub logo: bool,
    pub num_lock: bool,
    pub iso_level3_shift: bool,
    pub iso_level5_shift: bool,
    pub serialized: SerializedMods,
}

Represents the current state of the keyboard modifiers

Each field of this struct represents a modifier and is true if this modifier is active.

For some modifiers, this means that the key is currently pressed, others are toggled (like caps lock).

Fields

ctrl: bool

The “control” key

alt: bool

The “alt” key

shift: bool

The “shift” key

caps_lock: bool

The “Caps lock” key

logo: bool

The “logo” key

Also known as the “windows” key on most keyboards

num_lock: bool

The “Num lock” key

iso_level3_shift: bool

The “ISO level 3 shift” key

Also known as the “AltGr” key

iso_level5_shift: bool

The “ISO level 5 shift” key

serialized: SerializedMods

Serialized modifier state, as send e.g. by the wl_keyboard protocol

Implementations

impl ModifiersState

pub fn update_with(&mut self, state: &State)

Update the modifiers state from an xkb state

Trait Implementations

impl Clone for ModifiersState

fn clone(&self) -> ModifiersState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifiersState

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

Formats the value using the given formatter.

impl Default for ModifiersState

fn default() -> ModifiersState

Returns the “default value” for a type.

impl Hash for ModifiersState

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 ModifiersState

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

impl Eq for ModifiersState

impl StructuralPartialEq for ModifiersState