Struct webui::InputEvent

#[repr(transparent)]
pub struct InputEvent { /* private fields */ }

The InputEvent class.

MDN Documentation

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

Implementations

impl InputEvent

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: InputEvent

impl InputEvent

pub fn input_type(&self) -> String

Getter for the inputType field of this object.

MDN Documentation

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

impl InputEvent

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

Getter for the data field of this object.

MDN Documentation

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

impl InputEvent

pub fn new(type_: &str) -> Result<InputEvent, JsValue>

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

MDN Documentation

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

impl InputEvent

pub fn new_with_event_init_dict(
    type_: &str,
    event_init_dict: &InputEventInit
) -> Result<InputEvent, JsValue>

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

MDN Documentation

This API requires the following crate features to be activated: InputEvent, InputEventInit

impl InputEvent

pub fn get_target_ranges(&self) -> Array

The getTargetRanges() method.

MDN Documentation

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

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 = JsValue{ idx: JSIDX_NULL, _marker: marker::PhantomData,}

pub const UNDEFINED: JsValue = JsValue{ idx: JSIDX_UNDEFINED, _marker: marker::PhantomData,}

pub const TRUE: JsValue = JsValue{ idx: JSIDX_TRUE, _marker: marker::PhantomData,}

pub const FALSE: JsValue = JsValue{ idx: JSIDX_FALSE, _marker: marker::PhantomData,}

pub fn into_serde<T>(&self) -> Result<T, Error>where
    T: for<'a> Deserialize<'a>,

👎Deprecated: causes dependency cycles, use serde-wasm-bindgen or gloo_utils::format::JsValueSerdeExt instead

Invokes JSON.stringify on this value and then parses the resulting JSON into an arbitrary Rust value.

This function is deprecated, due to creating a dependency cycle in some circumstances. Use serde-wasm-bindgen or gloo_utils::format::JsValueSerdeExt instead.

This function will first call JSON.stringify on the JsValue itself. The resulting string is then passed into Rust which then parses it as JSON into the resulting value.

Usage of this API requires activating the serde-serialize feature of the wasm-bindgen crate.

Errors

Returns any error encountered when parsing the JSON into a T.

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

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

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

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

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

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

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

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

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

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

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

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

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

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

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

Applies the binary ** JS operator on the two JsValues.

MDN documentation

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

Applies the binary < JS operator on the two JsValues.

MDN documentation

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

Applies the binary <= JS operator on the two JsValues.

MDN documentation

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

Applies the binary >= JS operator on the two JsValues.

MDN documentation

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

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<Event> for InputEvent

fn as_ref(&self) -> &Event

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

impl AsRef<InputEvent> for InputEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<JsValue> for InputEvent

fn as_ref(&self) -> &JsValue

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

impl AsRef<Object> for InputEvent

fn as_ref(&self) -> &Object

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

impl AsRef<UiEvent> for InputEvent

fn as_ref(&self) -> &UiEvent

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

impl Clone for InputEvent

fn clone(&self) -> InputEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputEvent

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

Formats the value using the given formatter.

impl Deref for InputEvent

type Target = UiEvent

The resulting type after dereferencing.

fn deref(&self) -> &UiEvent

Dereferences the value.

impl From<InputEvent> for Event

fn from(obj: InputEvent) -> Event

Converts to this type from the input type.

impl From<InputEvent> for JsValue

fn from(obj: InputEvent) -> JsValue

Converts to this type from the input type.

impl From<InputEvent> for Object

fn from(obj: InputEvent) -> Object

Converts to this type from the input type.

impl From<InputEvent> for UiEvent

fn from(obj: InputEvent) -> UiEvent

Converts to this type from the input type.

impl From<JsValue> for InputEvent

fn from(obj: JsValue) -> InputEvent

Converts to this type from the input type.

impl FromWasmAbi for InputEvent

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: <InputEvent as FromWasmAbi>::Abi) -> InputEvent

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a InputEvent

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

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

fn into_abi(self) -> <&'a InputEvent as IntoWasmAbi>::Abi

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

impl IntoWasmAbi for InputEvent

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> <InputEvent as IntoWasmAbi>::Abi

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

impl JsCast for InputEvent

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) -> InputEvent

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

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

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

fn has_type<T>(&self) -> boolwhere
    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) -> Twhere
    T: JsCast,

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

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

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

fn is_instance_of<T>(&self) -> boolwhere
    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 InputEvent

fn is_none(abi: &<InputEvent as FromWasmAbi>::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<'a> OptionIntoWasmAbi for &'a InputEvent

fn none() -> <&'a InputEvent as IntoWasmAbi>::Abi

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

impl OptionIntoWasmAbi for InputEvent

fn none() -> <InputEvent as IntoWasmAbi>::Abi

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

impl PartialEq<InputEvent> for InputEvent

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

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<InputEvent>

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: <InputEvent as RefFromWasmAbi>::Abi
) -> <InputEvent as RefFromWasmAbi>::Anchor

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

impl Eq for InputEvent

impl StructuralEq for InputEvent

impl StructuralPartialEq for InputEvent