Struct web_sys::KeyboardEvent

#[repr(transparent)]
pub struct KeyboardEvent { /* fields omitted */ }

The KeyboardEvent object

MDN Documentation

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

Methods

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 fn char_code(&self) -> u32

The charCode getter

MDN Documentation

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

impl KeyboardEvent

pub fn key_code(&self) -> u32

The keyCode getter

MDN Documentation

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

impl KeyboardEvent

pub fn alt_key(&self) -> bool

The altKey getter

MDN Documentation

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

impl KeyboardEvent

pub fn ctrl_key(&self) -> bool

The ctrlKey getter

MDN Documentation

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

impl KeyboardEvent

pub fn shift_key(&self) -> bool

The shiftKey getter

MDN Documentation

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

impl KeyboardEvent

pub fn meta_key(&self) -> bool

The metaKey getter

MDN Documentation

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

impl KeyboardEvent

pub fn location(&self) -> u32

The location getter

MDN Documentation

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

impl KeyboardEvent

pub fn repeat(&self) -> bool

The repeat getter

MDN Documentation

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

impl KeyboardEvent

pub fn is_composing(&self) -> bool

The isComposing getter

MDN Documentation

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

impl KeyboardEvent

pub fn key(&self) -> String

The key getter

MDN Documentation

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

impl KeyboardEvent

pub fn code(&self) -> String

The code getter

MDN Documentation

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

impl KeyboardEvent

pub const DOM_KEY_LOCATION_STANDARD: u32

impl KeyboardEvent

pub const DOM_KEY_LOCATION_LEFT: u32

impl KeyboardEvent

pub const DOM_KEY_LOCATION_RIGHT: u32

impl KeyboardEvent

pub const DOM_KEY_LOCATION_NUMPAD: u32

Methods from Deref<Target = 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 fn view(&self) -> Option<Window>

The view getter

MDN Documentation

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

pub fn detail(&self) -> i32

The detail getter

MDN Documentation

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

pub fn layer_x(&self) -> i32

The layerX getter

MDN Documentation

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

pub fn layer_y(&self) -> i32

The layerY getter

MDN Documentation

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

pub fn page_x(&self) -> i32

The pageX getter

MDN Documentation

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

pub fn page_y(&self) -> i32

The pageY getter

MDN Documentation

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

pub fn which(&self) -> u32

The which getter

MDN Documentation

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

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

The rangeParent getter

MDN Documentation

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

pub fn range_offset(&self) -> i32

The rangeOffset getter

MDN Documentation

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

pub const SCROLL_PAGE_UP: i32

pub const SCROLL_PAGE_DOWN: i32

Trait Implementations

impl AsRef<JsValue> for KeyboardEvent

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<UiEvent> for KeyboardEvent

fn as_ref(&self) -> &UiEvent

Performs the conversion.

impl AsRef<Event> for KeyboardEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Object> for KeyboardEvent

fn as_ref(&self) -> &Object

Performs the conversion.

impl From<JsValue> for KeyboardEvent

fn from(obj: JsValue) -> KeyboardEvent

Performs the conversion.

impl From<KeyboardEvent> for JsValue

fn from(obj: KeyboardEvent) -> JsValue

Performs the conversion.

impl From<KeyboardEvent> for UiEvent

fn from(obj: KeyboardEvent) -> UiEvent

Performs the conversion.

impl From<KeyboardEvent> for Event

fn from(obj: KeyboardEvent) -> Event

Performs the conversion.

impl From<KeyboardEvent> for Object

fn from(obj: KeyboardEvent) -> Object

Performs the conversion.

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

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 FromWasmAbi for KeyboardEvent

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for KeyboardEvent

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<'a> IntoWasmAbi for &'a KeyboardEvent

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl WasmDescribe for KeyboardEvent

fn describe()

impl OptionFromWasmAbi for KeyboardEvent

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for KeyboardEvent

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl<'a> OptionIntoWasmAbi for &'a KeyboardEvent

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for KeyboardEvent

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<KeyboardEvent>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl JsCast for KeyboardEvent

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

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

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

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

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

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T where
    T: JsCast, 

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

Performs a zero-cost unchecked cast into a reference to the specified type.