Struct druid_shell::KeyEvent

pub struct KeyEvent {
    pub key_code: KeyCode,
    pub is_repeat: bool,
    pub mods: KeyModifiers,
    // some fields omitted
}

A keyboard event, generated on every key press and key release.

Fields

key_code: KeyCode

The platform independent keycode.

is_repeat: bool

Whether or not this event is a repeat (the key was held down)

mods: KeyModifiers

The modifiers for this event.

Methods

impl KeyEvent

pub fn text(&self) -> Option<&str>

The resolved input text for this event. This takes into account modifiers, e.g. the chars on macOS for opt+s is 'ß'.

pub fn unmod_text(&self) -> Option<&str>

The unmodified input text for this event. On macOS, for opt+s, this is 's'.

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeyEvent

impl Debug for KeyEvent

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

Formats the value using the given formatter.