Struct KeyDownEvent 

pub struct KeyDownEvent {
    pub keystroke: Keystroke,
    pub is_held: bool,
    pub prefer_character_input: bool,
}

A key press, sent when the platform reports that a key went down.

GPUI first matches the keystroke against your key bindings and dispatches matching actions. Unless an action stops propagation, the event then reaches InteractiveElement::on_key_down listeners on the focus path. The keyboard guide explains the order.

Fields

keystroke: Keystroke

The key and modifiers that were pressed.

is_held: bool

Whether this is an automatic repeat from a key that is still held down.

prefer_character_input: bool

Whether the focused text input should receive this keystroke as text instead of matching key bindings.

Set on a keystroke that GPUI replays after a multi-stroke binding fails to complete. Bindings are skipped only if the focused input handler accepts text input.

Trait Implementations

impl Clone for KeyDownEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyDownEvent

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

Formats the value using the given formatter.

impl Eq for KeyDownEvent

impl InputEvent for KeyDownEvent

fn to_platform_input(self) -> PlatformInput

Converts this event into the PlatformInput variant that wraps it.

impl KeyEvent for KeyDownEvent

impl PartialEq for KeyDownEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyDownEvent