Struct KeyEvent

#[repr(C)]
pub struct KeyEvent {
    pub text: SharedString,
    pub modifiers: KeyboardModifiers,
    pub repeat: bool,
    pub event_type: KeyEventType,
    pub replacement_range: Option<Range<i32>>,
    pub preedit_text: SharedString,
    pub preedit_selection: Option<Range<i32>>,
    pub cursor_position: Option<i32>,
    pub anchor_position: Option<i32>,
}

This structure is generated and passed to the key press and release callbacks of the FocusScope element.

Fields

text: SharedString

The unicode representation of the key pressed.

modifiers: KeyboardModifiers

The keyboard modifiers active at the time of the key press event.

repeat: bool

This field is set to true for key press events that are repeated, i.e. the key is held down. It’s always false for key release events.

event_type: KeyEventType

Indicates whether the key was pressed or released

replacement_range: Option<Range<i32>>

If the event type is KeyEventType::UpdateComposition or KeyEventType::CommitComposition, then this field specifies what part of the current text to replace. Relative to the offset of the pre-edit text within the text input element’s text.

preedit_text: SharedString

If the event type is KeyEventType::UpdateComposition, this is the new pre-edit text

preedit_selection: Option<Range<i32>>

The selection within the preedit_text

cursor_position: Option<i32>

The new cursor position, when None, the cursor is put after the text that was just inserted

anchor_position: Option<i32>

Implementations

impl KeyEvent

pub fn shortcut(&self) -> Option<StandardShortcut>

If a shortcut was pressed, this function returns Some(StandardShortcut). Otherwise it returns None.

pub fn text_shortcut(&self) -> Option<TextShortcut>

If a shortcut concerning text editing was pressed, this function returns Some(TextShortcut). Otherwise it returns None.

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

fn default() -> KeyEvent

Returns the “default value” for a type.

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