Struct wezterm_input_types::KeyEvent

pub struct KeyEvent {
    pub key: KeyCode,
    pub modifiers: Modifiers,
    pub leds: KeyboardLedStatus,
    pub repeat_count: u16,
    pub key_is_down: bool,
    pub raw: Option<RawKeyEvent>,
    pub win32_uni_char: Option<char>,
}

Fields

key: KeyCode

Which key was pressed. This is the potentially processed/composed version of the input.

modifiers: Modifiers

Which modifiers are down

leds: KeyboardLedStatus

repeat_count: u16

How many times this key repeats

key_is_down: bool

If true, this is a key down rather than a key up event

raw: Option<RawKeyEvent>

If triggered from a raw key event, here it is.

win32_uni_char: Option<char>

Implementations

impl KeyEvent

pub fn normalize_shift(self) -> Self

if SHIFT is held and we have KeyCode::Char(‘c’) we want to normalize that keycode to KeyCode::Char(‘C’); that is what this function does.

pub fn resurface_positional_modifier_key(self) -> Self

If the key code is a modifier key (Control, Alt, Shift), check the underlying raw event to see if we had a positional version of that key. If so, switch to the positional version.

pub fn normalize_ctrl(self) -> Self

If CTRL is held down and we have KeyCode::Char(_) with the ASCII control value encoded, decode it back to the ASCII alpha keycode instead.

pub fn encode_win32_input_mode(&self) -> Option<String>

https://github.com/microsoft/terminal/blob/main/doc/specs/%234999%20-%20Improved%20keyboard%20handling%20in%20Conpty.md

pub fn encode_kitty(&self, flags: KittyKeyboardFlags) -> String

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 Debug for KeyEvent

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

Formats the value using the given formatter.

impl PartialEq for KeyEvent

fn eq(&self, other: &KeyEvent) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for KeyEvent

impl StructuralEq for KeyEvent

impl StructuralPartialEq for KeyEvent