Struct KeyboardEvent 

#[repr(transparent)]
pub struct KeyboardEvent {
    pub obj: JsValue,
}

The KeyboardEvent class.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

Fields

obj: JsValue

Implementations

impl KeyboardEvent

pub fn char_code(&self) -> u32

Getter for the charCode field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn key_code(&self) -> u32

Getter for the keyCode field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn alt_key(&self) -> bool

Getter for the altKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn ctrl_key(&self) -> bool

Getter for the ctrlKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn shift_key(&self) -> bool

Getter for the shiftKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn meta_key(&self) -> bool

Getter for the metaKey field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn location(&self) -> u32

Getter for the location field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn repeat(&self) -> bool

Getter for the repeat field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn is_composing(&self) -> bool

Getter for the isComposing field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn key(&self) -> String

Getter for the key field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn code(&self) -> String

Getter for the code field of this object.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn new(type_arg: &str) -> Result<KeyboardEvent, JsValue>

The new KeyboardEvent(..) constructor, creating a new instance of KeyboardEvent.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn new_with_keyboard_event_init_dict( type_arg: &str, keyboard_event_init_dict: &KeyboardEventInit, ) -> Result<KeyboardEvent, JsValue>

The new KeyboardEvent(..) constructor, creating a new instance of KeyboardEvent.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, KeyboardEventInit

impl KeyboardEvent

pub fn get_modifier_state(&self, key: &str) -> bool

The getModifierState() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn init_keyboard_event(&self, type_arg: &str) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg( &self, type_arg: &str, bubbles_arg: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ctrl_key: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key_and_alt_key( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ctrl_key: bool, alt_key: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key_and_alt_key_and_shift_key( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ctrl_key: bool, alt_key: bool, shift_key: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub fn init_keyboard_event_with_bubbles_arg_and_cancelable_arg_and_view_arg_and_key_arg_and_location_arg_and_ctrl_key_and_alt_key_and_shift_key_and_meta_key( &self, type_arg: &str, bubbles_arg: bool, cancelable_arg: bool, view_arg: Option<&Window>, key_arg: &str, location_arg: u32, ctrl_key: bool, alt_key: bool, shift_key: bool, meta_key: bool, ) -> Result<(), JsValue>

The initKeyboardEvent() method.

MDN Documentation

This API requires the following crate features to be activated: KeyboardEvent, Window

impl KeyboardEvent

pub const DOM_KEY_LOCATION_STANDARD: u32 = 0u32

The KeyboardEvent.DOM_KEY_LOCATION_STANDARD const.

This API requires the following crate features to be activated: KeyboardEvent

pub const DOM_KEY_LOCATION_LEFT: u32 = 1u32

The KeyboardEvent.DOM_KEY_LOCATION_LEFT const.

This API requires the following crate features to be activated: KeyboardEvent

pub const DOM_KEY_LOCATION_RIGHT: u32 = 2u32

The KeyboardEvent.DOM_KEY_LOCATION_RIGHT const.

This API requires the following crate features to be activated: KeyboardEvent

pub const DOM_KEY_LOCATION_NUMPAD: u32 = 3u32

The KeyboardEvent.DOM_KEY_LOCATION_NUMPAD const.

This API requires the following crate features to be activated: KeyboardEvent

Methods from Deref<Target = UiEvent>

pub fn view(&self) -> Option<Window>

Getter for the view field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent, Window

pub fn detail(&self) -> i32

Getter for the detail field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn layer_x(&self) -> i32

Getter for the layerX field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn layer_y(&self) -> i32

Getter for the layerY field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn page_x(&self) -> i32

Getter for the pageX field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn page_y(&self) -> i32

Getter for the pageY field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn which(&self) -> u32

Getter for the which field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn range_parent(&self) -> Option<Node>

Getter for the rangeParent field of this object.

MDN Documentation

This API requires the following crate features to be activated: Node, UiEvent

pub fn range_offset(&self) -> i32

Getter for the rangeOffset field of this object.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event(&self, a_type: &str)

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event_with_a_can_bubble(&self, a_type: &str, a_can_bubble: bool)

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event_with_a_can_bubble_and_a_cancelable( &self, a_type: &str, a_can_bubble: bool, a_cancelable: bool, )

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent

pub fn init_ui_event_with_a_can_bubble_and_a_cancelable_and_a_view( &self, a_type: &str, a_can_bubble: bool, a_cancelable: bool, a_view: Option<&Window>, )

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent, Window

pub fn init_ui_event_with_a_can_bubble_and_a_cancelable_and_a_view_and_a_detail( &self, a_type: &str, a_can_bubble: bool, a_cancelable: bool, a_view: Option<&Window>, a_detail: i32, )

The initUIEvent() method.

MDN Documentation

This API requires the following crate features to be activated: UiEvent, Window

pub const SCROLL_PAGE_UP: i32 = -32_768i32

pub const SCROLL_PAGE_DOWN: i32 = 32_768i32

Methods from Deref<Target = Event>

pub fn type_(&self) -> String

Getter for the type field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn target(&self) -> Option<EventTarget>

Getter for the target field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

pub fn current_target(&self) -> Option<EventTarget>

Getter for the currentTarget field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event, EventTarget

pub fn event_phase(&self) -> u16

Getter for the eventPhase field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn bubbles(&self) -> bool

Getter for the bubbles field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn cancelable(&self) -> bool

Getter for the cancelable field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn default_prevented(&self) -> bool

Getter for the defaultPrevented field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn composed(&self) -> bool

Getter for the composed field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn is_trusted(&self) -> bool

Getter for the isTrusted field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn time_stamp(&self) -> f64

Getter for the timeStamp field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn cancel_bubble(&self) -> bool

Getter for the cancelBubble field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn set_cancel_bubble(&self, value: bool)

Setter for the cancelBubble field of this object.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn composed_path(&self) -> Array

The composedPath() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn init_event(&self, type_: &str)

The initEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn init_event_with_bubbles(&self, type_: &str, bubbles: bool)

The initEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn init_event_with_bubbles_and_cancelable( &self, type_: &str, bubbles: bool, cancelable: bool, )

The initEvent() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn prevent_default(&self)

The preventDefault() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn stop_immediate_propagation(&self)

The stopImmediatePropagation() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub fn stop_propagation(&self)

The stopPropagation() method.

MDN Documentation

This API requires the following crate features to be activated: Event

pub const NONE: u16 = 0u16

pub const CAPTURING_PHASE: u16 = 1u16

pub const AT_TARGET: u16 = 2u16

pub const BUBBLING_PHASE: u16 = 3u16

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn id(&self) -> u64

Get the heap ID for this value.

This is used internally for encoding values to send to JS.

pub fn unchecked_into_f64(&self) -> f64

Returns the value as f64 without type checking. Used by serde-wasm-bindgen for numeric conversions.

pub fn has_type<T>(&self) -> bool

where T: JsCast,

Check if this value is an instance of a specific JS type.

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Checked division.

pub fn pow(&self, rhs: &JsValue) -> JsValue

Power operation.

pub fn bit_and(&self, rhs: &JsValue) -> JsValue

Bitwise AND.

pub fn bit_or(&self, rhs: &JsValue) -> JsValue

Bitwise OR.

pub fn bit_xor(&self, rhs: &JsValue) -> JsValue

Bitwise XOR.

pub fn bit_not(&self) -> JsValue

Bitwise NOT.

pub fn shl(&self, rhs: &JsValue) -> JsValue

Left shift.

pub fn shr(&self, rhs: &JsValue) -> JsValue

Signed right shift.

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Unsigned right shift.

pub fn add(&self, rhs: &JsValue) -> JsValue

Add.

pub fn sub(&self, rhs: &JsValue) -> JsValue

Subtract.

pub fn mul(&self, rhs: &JsValue) -> JsValue

Multiply.

pub fn div(&self, rhs: &JsValue) -> JsValue

Divide.

pub fn rem(&self, rhs: &JsValue) -> JsValue

Remainder.

pub fn neg(&self) -> JsValue

Negate.

pub fn lt(&self, rhs: &JsValue) -> bool

Less than comparison.

pub fn le(&self, rhs: &JsValue) -> bool

Less than or equal comparison.

pub fn gt(&self, rhs: &JsValue) -> bool

Greater than comparison.

pub fn ge(&self, rhs: &JsValue) -> bool

Greater than or equal comparison.

pub fn loose_eq(&self, rhs: &JsValue) -> bool

Loose equality (==).

pub fn is_falsy(&self) -> bool

Check if this value is a falsy value in JavaScript.

pub fn is_truthy(&self) -> bool

Check if this value is a truthy value in JavaScript.

pub fn is_object(&self) -> bool

Check if this value is an object.

pub fn is_function(&self) -> bool

Check if this value is a function.

pub fn is_string(&self) -> bool

Check if this value is a string.

pub fn is_symbol(&self) -> bool

Check if this value is a symbol.

pub fn is_bigint(&self) -> bool

Check if this value is a bigint.

pub fn is_undefined(&self) -> bool

Check if this value is undefined.

pub fn is_null(&self) -> bool

Check if this value is null.

pub fn js_typeof(&self) -> JsValue

Get the typeof this value as a string.

pub fn js_in(&self, obj: &JsValue) -> bool

Check if this value has a property with the given name.

pub fn as_bool(&self) -> Option<bool>

Get the value as a bool.

pub fn as_f64(&self) -> Option<f64>

Get the value as an f64.

pub fn as_string(&self) -> Option<String>

Get the value as a string.

pub fn as_debug_string(&self) -> String

Get a debug string representation of the value.

Trait Implementations

impl AsRef<Event> for KeyboardEvent

fn as_ref(&self) -> &Event

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<JsValue> for KeyboardEvent

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<KeyboardEvent> for KeyboardEvent

fn as_ref(&self) -> &KeyboardEvent

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Object> for KeyboardEvent

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<UiEvent> for KeyboardEvent

fn as_ref(&self) -> &UiEvent

Converts this type into a shared reference of the (usually inferred) input type.

impl BatchableResult for KeyboardEvent

fn try_placeholder(batch: &mut Runtime) -> Option<Self>

Returns Some(placeholder) for opaque types that can be batched, None for types that require flushing to get the actual value.

impl BinaryDecode for KeyboardEvent

fn decode(decoder: &mut DecodedData<'_>) -> Result<Self, DecodeError>

impl BinaryEncode for &KeyboardEvent

fn encode(self, encoder: &mut EncodedData)

impl BinaryEncode for KeyboardEvent

fn encode(self, encoder: &mut EncodedData)

impl Clone for KeyboardEvent

fn clone(&self) -> KeyboardEvent

Returns a duplicate 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

Formats the value using the given formatter.

impl Deref for KeyboardEvent

type Target = UiEvent

The resulting type after dereferencing.

fn deref(&self) -> &UiEvent

Dereferences the value.

impl EncodeTypeDef for KeyboardEvent

fn encode_type_def(buf: &mut Vec<u8>)

Encode this type’s definition into the buffer. For primitives, this is just the TypeTag byte. For callbacks, this includes param count, param types, and return type.

impl From<&KeyboardEvent> for Event

fn from(val: &KeyboardEvent) -> Event

Converts to this type from the input type.

impl From<&KeyboardEvent> for JsValue

fn from(val: &KeyboardEvent) -> Self

Converts to this type from the input type.

impl From<&KeyboardEvent> for Object

fn from(val: &KeyboardEvent) -> Object

Converts to this type from the input type.

impl From<&KeyboardEvent> for UiEvent

fn from(val: &KeyboardEvent) -> UiEvent

Converts to this type from the input type.

impl From<JsValue> for KeyboardEvent

fn from(val: JsValue) -> Self

Converts to this type from the input type.

impl From<KeyboardEvent> for Event

fn from(val: KeyboardEvent) -> Event

Converts to this type from the input type.

impl From<KeyboardEvent> for JsValue

fn from(val: KeyboardEvent) -> Self

Converts to this type from the input type.

impl From<KeyboardEvent> for Object

fn from(val: KeyboardEvent) -> Object

Converts to this type from the input type.

impl From<KeyboardEvent> for UiEvent

fn from(val: KeyboardEvent) -> UiEvent

Converts to this type from the input type.

impl JsCast for KeyboardEvent

fn instanceof(__val: &JsValue) -> bool

Check if a JsValue is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Unchecked cast from JsValue to this type.

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Unchecked cast from a JsValue reference to a reference of this type.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic type check to see whether the JsValue provided is a value of this type.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Try to cast this value to type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Try to get a reference to type T from this value.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Unchecked cast to another type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Unchecked cast to a reference of another type.

impl PartialEq for KeyboardEvent

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

impl StructuralPartialEq for KeyboardEvent