Struct KeyEvent 

pub struct KeyEvent { /* private fields */ }

A keyboard input event.

Holds the key, whether it went down or up, the modifier keys held with it and the text it typed.

Implementations

impl KeyEvent

pub fn new( key: Key, text: impl Into<String>, modifiers: Modifiers, type_: KeyEventType, ) -> KeyEvent

Creates a key event. text is what the key typed with the keyboard layout and modifiers applied (Shift+A types “A”), empty for keys that type nothing.

pub fn key_down(key: Key, text: impl Into<String>) -> KeyEvent

Creates a key down event with the given key and text.

pub fn key_up(key: Key) -> KeyEvent

Creates a key up event for key.

pub fn key_down_with_modifiers( key: Key, text: impl Into<String>, modifiers: Modifiers, ) -> KeyEvent

Creates a key down event with modifiers.

pub fn with_repeat_count(self, repeat_count: u32) -> KeyEvent

This event as the repeat_countth repeat of a held key.

pub fn key(&self) -> Key

The key that went down or up.

pub fn type_(&self) -> KeyEventType

Whether the key went down or up.

pub fn text(&self) -> &str

The text this key typed, empty for keys that type nothing.

pub fn modifiers(&self) -> Modifiers

The modifier keys held with this key.

pub fn is_shift_pressed(&self) -> bool

Whether a Shift key was held.

pub fn is_ctrl_pressed(&self) -> bool

Whether a Control key was held.

pub fn is_alt_pressed(&self) -> bool

Whether an Alt key was held.

pub fn is_meta_pressed(&self) -> bool

Whether a Meta key was held.

pub fn utf16_code_point(&self) -> Option<u32>

The Unicode code point of the character this key typed, if it typed one.

pub fn native_key_event(&self) -> NativeKeyEvent

What the platform reported beyond the key, such as the repeat count.

pub fn is_key_down(&self) -> bool

Returns true if this is a key down event.

pub fn has_text(&self) -> bool

Returns true if this key produces printable text.

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Display for KeyEvent

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

Formats the value using the given formatter.

impl Eq for KeyEvent

impl PartialEq for KeyEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KeyEvent