Struct augdom::event::KeyPress

pub struct KeyPress(_);

A key is pressed. MDN documentation

Methods from Deref<Target = KeyboardEvent>

pub const DOM_KEY_LOCATION_STANDARD: u32

pub const DOM_KEY_LOCATION_LEFT: u32

pub const DOM_KEY_LOCATION_RIGHT: u32

pub const DOM_KEY_LOCATION_NUMPAD: u32

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl AsRef<Event> for KeyPress

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<JsValue> for KeyPress

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl Debug for KeyPress

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

Formats the value using the given formatter.

impl Deref for KeyPress

type Target = KeyboardEvent

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Event for KeyPress

const NAME: &'static str

The name used to register for this event in addEventListener.

type Builder = KeyPressBuilder

The builder type returned by new().

fn new() -> Self::Builder

Make a new event, returning a builder.

fn dispatch(self, target: &EventTarget)

Dispatch this event to the provided target.

impl From<KeyPress> for JsValue

fn from(value: KeyPress) -> Self

Performs the conversion.

impl FromWasmAbi for KeyPress

type Abi = u32

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

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for KeyPress

type Abi = u32

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

fn into_abi(self) -> u32

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

impl JsCast for KeyPress

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 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, 

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.

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

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

fn is_type_of(val: &JsValue) -> bool

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

impl OptionFromWasmAbi for KeyPress

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 KeyPress

fn none() -> Self::Abi

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

impl RefFromWasmAbi for KeyPress

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, KeyPress>

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) -> Self::Anchor

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

impl RefMutFromWasmAbi for KeyPress

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, KeyPress>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl WasmDescribe for KeyPress

fn describe()