Struct RawKeyInputArgs 

pub struct RawKeyInputArgs {
    pub timestamp: DInstant,
    pub window_id: WindowId,
    pub device_id: InputDeviceId,
    pub key_code: KeyCode,
    pub key_location: KeyLocation,
    pub state: KeyState,
    pub key: Key,
    pub key_modified: Key,
    pub text: Txt,
    pub propagation: EventPropagationHandle,
}

Arguments for the RAW_KEY_INPUT_EVENT.

Fields

timestamp: DInstant

Instant the event happened.

window_id: WindowId

Window that received the event.

device_id: InputDeviceId

Keyboard device that generated the event.

key_code: KeyCode

Physical key.

key_location: KeyLocation

The location of the key on the keyboard.

state: KeyState

If the key was pressed or released.

key: Key

Semantic key.

Pressing Shift+A key will produce Key::Char('a') in QWERTY keyboards, the modifiers are not applied.

key_modified: Key

Semantic key modified by the current active modifiers.

Pressing Shift+A key will produce Key::Char('A') in QWERTY keyboards, the modifiers are applied.

text: Txt

Text typed.

This is only set for KeyState::Pressed of a key that generates text.

This is usually the key_modified char, but is also '\r' for Key::Enter. On Windows when a dead key was pressed earlier but cannot be combined with the character from this key press, the produced text will consist of two characters: the dead-key-character followed by the character resulting from this key press.

propagation: EventPropagationHandle

Propagation handle associated with this event instance.

Cloned arguments share the same handle, some arguments may also share the handle of another event if they share the same cause.

Implementations

impl RawKeyInputArgs

pub fn new( timestamp: impl Into<DInstant>, propagation: EventPropagationHandle, window_id: impl Into<WindowId>, device_id: impl Into<InputDeviceId>, key_code: impl Into<KeyCode>, key_location: impl Into<KeyLocation>, state: impl Into<KeyState>, key: impl Into<Key>, key_modified: impl Into<Key>, text: impl Into<Txt>, ) -> Self

New args from values that convert into the argument types.

pub fn now( window_id: impl Into<WindowId>, device_id: impl Into<InputDeviceId>, key_code: impl Into<KeyCode>, key_location: impl Into<KeyLocation>, state: impl Into<KeyState>, key: impl Into<Key>, key_modified: impl Into<Key>, text: impl Into<Txt>, ) -> Self

Arguments for event that happened now (INSTANT.now).

Trait Implementations

impl AnyEventArgs for RawKeyInputArgs

fn is_in_target(&self, id: WidgetId) -> bool

Broadcast to all widgets.

fn timestamp(&self) -> DInstant

Instant this event update happened.

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance.

fn clone_boxed(&self) -> Box<dyn AnyEventArgs>

Clone the args to a new box.

impl Clone for RawKeyInputArgs

fn clone(&self) -> RawKeyInputArgs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RawKeyInputArgs

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

Formats the value using the given formatter.

impl PartialEq for RawKeyInputArgs

fn eq(&self, other: &RawKeyInputArgs) -> 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 EventArgs for RawKeyInputArgs

impl StructuralPartialEq for RawKeyInputArgs