Struct KeyEventArgs 

pub struct KeyEventArgs {
    pub key: Key,
    pub key_modifiers: KeyModifiers,
    pub physical_key: PhysicalKey,
    pub key_symbol: Option<String>,
    pub key_device_type: KeyDeviceType,
    /* private fields */
}

Provides information specific to a keyboard event.

Fields

key: Key

The virtual-key for the associated event.

A given physical key can result in different virtual keys depending on the current keyboard layout. This is the key that is generally referred to when creating keyboard shortcuts. For example, when pressing the key located at the Z position on standard US English QWERTY keyboard, this property returns:

• Key::Z for an English (QWERTY) layout
• Key::W for a French (AZERTY) layout
• Key::Y for a German (QWERTZ) layout
• Key::Z for a Russian (JCUKEN) layout

key_modifiers: KeyModifiers

The key modifiers for the associated event.

physical_key: PhysicalKey

The physical key for the associated event.

This value is independent of the current keyboard layout and usually corresponds to the key printed on a standard US English QWERTY keyboard. This is the key to use for position-dependent bindings such as WASD movement in games.

key_symbol: Option<String>

The unicode symbol of the key, or None if none is applicable.

For example, when pressing the key located at the Z position on standard US English QWERTY keyboard, this property returns:

• z for an English (QWERTY) layout
• w for a French (AZERTY) layout
• y for a German (QWERTZ) layout
• я for a Russian (JCUKEN) layout

key_device_type: KeyDeviceType

The type of key device that sent this event.

Implementations

impl KeyEventArgs

pub fn new() -> Self

Creates args with default values and no routed event.

Methods from Deref<Target = RoutedEventArgs>

pub fn handled(&self) -> bool

Whether the routed event has already been handled.

Once handled, the event keeps travelling along its route but is only delivered to handlers registered for handled events too.

pub fn set_handled(&self, value: bool)

Marks the routed event as handled or unhandled.

pub fn routed_event(&self) -> Option<RoutedEvent>

The routed event associated with these args.

pub fn set_routed_event<T: ?Sized>(&self, value: Option<&RoutedEvent<T>>)

Sets the routed event associated with these args.

pub fn route(&self) -> RoutingStrategies

The routing strategy currently being applied to the event.

pub fn set_route(&self, value: RoutingStrategies)

Sets the routing strategy currently being applied to the event.

pub fn source(&self) -> Option<Ref<FerroObject>>

The object that raised the event.

pub fn set_source(&self, value: impl Into<Nullable<FerroObject>>)

Sets the object that raised the event.

pub fn is_source(&self, object: &FerroObject) -> bool

Whether object is the source of the event (C# e.Source == object).

Trait Implementations

impl Clone for KeyEventArgs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for KeyEventArgs

fn default() -> Self

Returns the “default value” for a type.

impl Deref for KeyEventArgs

type Target = RoutedEventArgs

The resulting type after dereferencing.

fn deref(&self) -> &RoutedEventArgs

Dereferences the value.

impl IKeyModifiersEventArgs for KeyEventArgs

fn key_modifiers(&self) -> KeyModifiers

The key modifiers associated with this event.

impl IRoutedEventArgs for KeyEventArgs

fn as_routed_event_args(&self) -> &RoutedEventArgs

The base routed event args: the routing state of the event.

fn query_args(&self, type_id: TypeId) -> Option<&dyn Any>

Returns the args viewed as the args type identified by type_id, if the args are of that type or of a type derived from it.

fn is_args_type(type_id: TypeId) -> bool

Whether this args type is the args type identified by type_id or is derived from it.

fn share(&self) -> Rc<dyn IRoutedEventArgs>

A shared handle to these args: what untyped code (a handler wired up by markup) is given, since a borrow cannot be held in an untyped value. The handle refers to the live args: the state handlers change (handled, the source, a cancel flag, ..) is shared with them.

impl MarkupTyped for KeyEventArgs

const MARKUP: &'static MarkupType

The markup metadata of the type.