Struct Event 

pub struct Event<'alloc> { /* private fields */ }

Keyboard input event containing information about the physical key pressed, modifiers, and generated text.

Implementations

impl<'alloc> Event<'alloc>

pub fn new() -> Result<Self>

Create a new key event instance.

pub fn new_with_alloc<'ctx: 'alloc>( alloc: &'alloc Allocator<'ctx>, ) -> Result<Self>

Create a new key event instance with a custom allocator.

See the crate-level documentation regarding custom memory management and lifetimes.

pub fn set_action(&mut self, action: Action) -> &mut Self

Set the key action (press, release, repeat).

pub fn action(&self) -> Action

Get the key action (press, release, repeat).

pub fn set_key(&mut self, key: Key) -> &mut Self

Set the physical key code.

pub fn key(&self) -> Key

Get the physical key code.

pub fn set_mods(&mut self, mods: Mods) -> &mut Self

Set the modifier keys bitmask.

pub fn mods(&self) -> Mods

Get the modifier keys bitmask.

pub fn set_consumed_mods(&mut self, mods: Mods) -> &mut Self

Set the consumed modifiers bitmask.

pub fn consumed_mods(&self) -> Mods

Get the consumed modifiers bitmask.

pub fn set_composing(&mut self, composing: bool) -> &mut Self

Set whether the key event is part of a composition sequence.

pub fn is_composing(&self) -> bool

Get whether the key event is part of a composition sequence.

pub fn set_utf8<S: Into<String>>(&mut self, text: Option<S>) -> &mut Self

Set the UTF-8 text generated by the key for the current keyboard layout.

Must contain the unmodified character before any Ctrl/Meta transformations. The encoder derives modifier sequences from the logical key and mods bitmask, not from this text. Do not pass C0 control characters (U+0000-U+001F, U+007F) or platform function key codes (e.g. macOS PUA U+F700-U+F8FF); pass NULL instead and let the encoder use the logical key.

The event makes an internal copy of the text since the C API may reuse it without any rigid lifetime guarantees.

pub fn utf8(&mut self) -> Option<&str>

Get the UTF-8 text generated by the key event.

pub fn set_unshifted_codepoint(&mut self, codepoint: char) -> &mut Self

Set the unshifted Unicode codepoint.

pub fn unshifted_codepoint(&self) -> char

Get the unshifted Unicode codepoint.

Trait Implementations

impl<'alloc> Debug for Event<'alloc>

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

Formats the value using the given formatter.

impl Drop for Event<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.