Struct dioxus_html::events::KeyboardData

pub struct KeyboardData {
    pub char_code: u32,
    pub key: String,
    pub key_code: KeyCode,
    pub alt_key: bool,
    pub ctrl_key: bool,
    pub meta_key: bool,
    pub shift_key: bool,
    pub location: usize,
    pub repeat: bool,
    pub which: usize,
    /* private fields */
}

Fields

char_code: u32

👎Deprecated since 0.3.0: This may not work in all environments. Use key() instead.

key: String

👎Deprecated since 0.3.0: use key() instead

Identify which “key” was entered.

key_code: KeyCode

👎Deprecated since 0.3.0: This may not work in all environments. Use code() instead.

Get the key code as an enum Variant.

alt_key: bool

👎Deprecated since 0.3.0: use modifiers() instead

Indicate if the alt modifier key was pressed during this keyboard event

ctrl_key: bool

👎Deprecated since 0.3.0: use modifiers() instead

Indicate if the ctrl modifier key was pressed during this keyboard event

meta_key: bool

👎Deprecated since 0.3.0: use modifiers() instead

Indicate if the meta modifier key was pressed during this keyboard event

shift_key: bool

👎Deprecated since 0.3.0: use modifiers() instead

Indicate if the shift modifier key was pressed during this keyboard event

location: usize

👎Deprecated since 0.3.0: use location() instead

repeat: bool

👎Deprecated since 0.3.0: use is_auto_repeating() instead

which: usize

👎Deprecated since 0.3.0: use code() or key() instead

Implementations

impl KeyboardData

pub fn new( key: Key, code: Code, location: Location, is_auto_repeating: bool, modifiers: Modifiers ) -> Self

pub fn key(&self) -> Key

The value of the key pressed by the user, taking into consideration the state of modifier keys such as Shift as well as the keyboard locale and layout.

pub fn code(&self) -> Code

A physical key on the keyboard (as opposed to the character generated by pressing the key). In other words, this property returns a value that isn’t altered by keyboard layout or the state of the modifier keys.

pub fn modifiers(&self) -> Modifiers

The set of modifier keys which were pressed when the event occurred

pub fn location(&self) -> Location

The location of the key on the keyboard or other input device.

pub fn is_auto_repeating(&self) -> bool

true iff the key is being held down such that it is automatically repeating.

Trait Implementations

impl Clone for KeyboardData

fn clone(&self) -> KeyboardData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyboardData

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

Deserialize this value from the given Serde deserializer.

impl From<&Event> for KeyboardData

fn from(e: &Event) -> Self

Converts to this type from the input type.

impl From<&KeyboardEvent> for KeyboardData

fn from(e: &KeyboardEvent) -> Self

Converts to this type from the input type.

impl From<Event> for KeyboardData

fn from(e: Event) -> Self

Converts to this type from the input type.

impl PartialEq<KeyboardData> for KeyboardData

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

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

Serialize this value into the given Serde serializer.

impl Eq for KeyboardData

impl StructuralEq for KeyboardData

impl StructuralPartialEq for KeyboardData