Struct dioxus::events::keyboard_types::KeyboardEvent

pub struct KeyboardEvent {
    pub state: KeyState,
    pub key: Key,
    pub code: Code,
    pub location: Location,
    pub modifiers: Modifiers,
    pub repeat: bool,
    pub is_composing: bool,
}

Available on crate feature html only.

Keyboard events are issued for all pressed and released keys.

Fields

state: KeyState

Whether the key is pressed or released.

key: Key

Logical key value.

code: Code

Physical key position.

location: Location

Location for keys with multiple instances on common keyboards.

modifiers: Modifiers

Flags for pressed modifier keys.

repeat: bool

True if the key is currently auto-repeated.

is_composing: bool

Events with this flag should be ignored in a text editor and instead composition events should be used.

Trait Implementations

impl Clone for KeyboardEvent

fn clone(&self) -> KeyboardEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardEvent

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

Formats the value using the given formatter.

impl Default for KeyboardEvent

fn default() -> KeyboardEvent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyboardEvent

fn deserialize<__D>( __deserializer: __D ) -> Result<KeyboardEvent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KeyboardEvent> for Event

fn from(v: KeyboardEvent) -> Event

Converts to this type from the input type.

impl Hash for KeyboardEvent

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyboardEvent

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

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for KeyboardEvent

impl StructuralPartialEq for KeyboardEvent