Enum ModifierKey

pub enum ModifierKey {
    Hold(LayerIndex),
}

Modifier layer key affects what layers are active.

Variants

Hold(LayerIndex)

Activates the given layer when the held.

Implementations

impl ModifierKey

pub fn new_pressed_key(&self) -> (PressedModifierKeyState, LayerEvent)

Create a new input::PressedKey and key::ScheduledEvent for the given keymap index.

Pressing a ModifierKey::Hold emits a LayerEvent::LayerActivated event.

Trait Implementations

impl Clone for ModifierKey

fn clone(&self) -> ModifierKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModifierKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModifierKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ModifierKey> for BaseKey

fn from(key: ModifierKey) -> Self

Converts to this type from the input type.

impl Key for ModifierKey

type Context = Context

The associated Context is used to provide state that may affect behaviour when pressing the key. (e.g. the behaviour of layered::LayeredKey depends on which layers are active in layered::Context).

type Event = Event

The associated Event is to be handled by the associated Context, and any active PressedKeys.

type PressedKey = PressedKey<BaseKey, BasePressedKeyState>

The associated PressedKeyState implements functionality for the pressed key. (e.g. tap_hold::PressedKeyState implements behaviour resolving the pressed tap hold key as either ‘tap’ or ‘hold’).

fn new_pressed_key( &self, _context: Self::Context, keymap_index: u16, ) -> (Self::PressedKey, PressedKeyEvents<Self::Event>)

Key::new_pressed_key produces a pressed key value, and may yield some ScheduledEvents. (e.g. tap_hold::Key schedules a tap_hold::Event::TapHoldTimeout so that holding the key resolves as a hold).

impl PartialEq for ModifierKey

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

impl StructuralPartialEq for ModifierKey

impl TapHoldNestable for ModifierKey