Struct KeyEvent

pub struct KeyEvent {
    pub state: KeyState,
    pub key: Key,
    pub modifiers: Modifiers,
    pub repeat: bool,
    pub pointer_pos: Option<Point>,
    pub text: Option<String>,
}

Keyboard input event in logical coordinates.

Examples

use ailloli_ui_core::event::{Key, KeyEvent, KeyState, Modifiers};
let event = KeyEvent {
    state: KeyState::Pressed,
    key: Key::Character("a".into()),
    modifiers: Modifiers::default(),
    repeat: false,
    pointer_pos: None,
    text: Some("a".into()),
};
assert_eq!(event.text.as_deref(), Some("a"));

Fields

state: KeyState

Press or release transition.

key: Key

Provider-normalized logical key.

modifiers: Modifiers

Modifier snapshot observed with this transition.

repeat: bool

true when the OS reports auto-repeat.

pointer_pos: Option<Point>

Cursor position in logical window coordinates at event time, if known.

text: Option<String>

Committed or composed text from the platform, when provided.

None means no text payload was supplied; Some("") preserves an explicitly supplied empty payload.

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

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