Struct i_slint_core::input::KeyEvent

#[repr(C)]
pub struct KeyEvent {
    pub modifiers: KeyboardModifiers,
    pub text: SharedString,
    pub event_type: KeyEventType,
    pub preedit_selection_start: usize,
    pub preedit_selection_end: usize,
}

Represents a key event.

Fields

modifiers: KeyboardModifiers

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

text: SharedString

The unicode representation of the key pressed.

event_type: KeyEventType

Indicates whether the key was pressed or released

preedit_selection_start: usize

If the event type is KeyEventType::UpdateComposition, then this field specifies the start of the selection as byte offsets within the preedit text.

preedit_selection_end: usize

If the event type is KeyEventType::UpdateComposition, then this field specifies the end of the selection as byte offsets within the preedit text.

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