Struct PointerEvent

pub struct PointerEvent(/* private fields */);

Implementations

impl PointerEvent

pub fn get_predicted_events(&self) -> Array<PointerEvent>

pub fn get_coalesced_events(&self) -> Array<PointerEvent>

pub fn new( browser: &Browser, type_: &dyn ToJs<JsString>, eventInitDict: &dyn ToJs<JsNullable<PointerEventInit>>, ) -> PointerEvent

pub fn get_width(&self) -> JsNumber

pub fn set_width(&self, value: &dyn ToJs<JsNumber>)

pub fn get_twist(&self) -> JsNumber

pub fn set_twist(&self, value: &dyn ToJs<JsNumber>)

pub fn get_tilt_y(&self) -> JsNumber

pub fn set_tilt_y(&self, value: &dyn ToJs<JsNumber>)

pub fn get_tilt_x(&self) -> JsNumber

pub fn set_tilt_x(&self, value: &dyn ToJs<JsNumber>)

pub fn get_tangential_pressure(&self) -> JsNumber

pub fn set_tangential_pressure(&self, value: &dyn ToJs<JsNumber>)

pub fn get_pressure(&self) -> JsNumber

pub fn set_pressure(&self, value: &dyn ToJs<JsNumber>)

pub fn get_pointer_type(&self) -> JsString

pub fn set_pointer_type(&self, value: &dyn ToJs<JsString>)

pub fn get_pointer_id(&self) -> JsNumber

pub fn set_pointer_id(&self, value: &dyn ToJs<JsNumber>)

pub fn get_is_primary(&self) -> JsBoolean

pub fn set_is_primary(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_height(&self) -> JsNumber

pub fn set_height(&self, value: &dyn ToJs<JsNumber>)

pub fn get_prototype(browser: &Browser) -> PointerEvent

pub fn set_prototype(browser: &Browser, value: &PointerEvent)

Methods from Deref<Target = MouseEvent>

pub fn get_modifier_state(&self, keyArg: &dyn ToJs<JsString>) -> JsBoolean

pub fn init_mouse_event( &self, typeArg: &dyn ToJs<JsString>, canBubbleArg: &dyn ToJs<JsBoolean>, cancelableArg: &dyn ToJs<JsBoolean>, viewArg: &Window, detailArg: &dyn ToJs<JsNumber>, screenXArg: &dyn ToJs<JsNumber>, screenYArg: &dyn ToJs<JsNumber>, clientXArg: &dyn ToJs<JsNumber>, clientYArg: &dyn ToJs<JsNumber>, ctrlKeyArg: &dyn ToJs<JsBoolean>, altKeyArg: &dyn ToJs<JsBoolean>, shiftKeyArg: &dyn ToJs<JsBoolean>, metaKeyArg: &dyn ToJs<JsBoolean>, buttonArg: &dyn ToJs<JsNumber>, relatedTargetArg: &dyn ToJs<JsNullable<EventTarget>>, ) -> JsNullish

pub fn get_y(&self) -> JsNumber

pub fn set_y(&self, value: &dyn ToJs<JsNumber>)

pub fn get_x(&self) -> JsNumber

pub fn set_x(&self, value: &dyn ToJs<JsNumber>)

pub fn get_shift_key(&self) -> JsBoolean

pub fn set_shift_key(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_screen_y(&self) -> JsNumber

pub fn set_screen_y(&self, value: &dyn ToJs<JsNumber>)

pub fn get_screen_x(&self) -> JsNumber

pub fn set_screen_x(&self, value: &dyn ToJs<JsNumber>)

pub fn get_related_target(&self) -> JsNullable<EventTarget>

pub fn set_related_target(&self, value: &dyn ToJs<JsNullable<EventTarget>>)

pub fn get_page_y(&self) -> JsNumber

pub fn set_page_y(&self, value: &dyn ToJs<JsNumber>)

pub fn get_page_x(&self) -> JsNumber

pub fn set_page_x(&self, value: &dyn ToJs<JsNumber>)

pub fn get_offset_y(&self) -> JsNumber

pub fn set_offset_y(&self, value: &dyn ToJs<JsNumber>)

pub fn get_offset_x(&self) -> JsNumber

pub fn set_offset_x(&self, value: &dyn ToJs<JsNumber>)

pub fn get_movement_y(&self) -> JsNumber

pub fn set_movement_y(&self, value: &dyn ToJs<JsNumber>)

pub fn get_movement_x(&self) -> JsNumber

pub fn set_movement_x(&self, value: &dyn ToJs<JsNumber>)

pub fn get_meta_key(&self) -> JsBoolean

pub fn set_meta_key(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_ctrl_key(&self) -> JsBoolean

pub fn set_ctrl_key(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_client_y(&self) -> JsNumber

pub fn set_client_y(&self, value: &dyn ToJs<JsNumber>)

pub fn get_client_x(&self) -> JsNumber

pub fn set_client_x(&self, value: &dyn ToJs<JsNumber>)

pub fn get_buttons(&self) -> JsNumber

pub fn set_buttons(&self, value: &dyn ToJs<JsNumber>)

pub fn get_button(&self) -> JsNumber

pub fn set_button(&self, value: &dyn ToJs<JsNumber>)

pub fn get_alt_key(&self) -> JsBoolean

pub fn set_alt_key(&self, value: &dyn ToJs<JsBoolean>)

Methods from Deref<Target = UIEvent>

pub fn init_uievent( &self, typeArg: &dyn ToJs<JsString>, bubblesArg: &dyn ToJs<JsNullable<JsBoolean>>, cancelableArg: &dyn ToJs<JsNullable<JsBoolean>>, viewArg: &dyn ToJs<JsNullable<Window>>, detailArg: &dyn ToJs<JsNullable<JsNumber>>, ) -> JsNullish

pub fn get_which(&self) -> JsNumber

pub fn set_which(&self, value: &dyn ToJs<JsNumber>)

pub fn get_view(&self) -> JsNullable<Window>

pub fn set_view(&self, value: &dyn ToJs<JsNullable<Window>>)

pub fn get_detail(&self) -> JsNumber

pub fn set_detail(&self, value: &dyn ToJs<JsNumber>)

Methods from Deref<Target = Event>

pub fn stop_propagation(&self) -> JsNullish

pub fn stop_immediate_propagation(&self) -> JsNullish

pub fn prevent_default(&self) -> JsNullish

pub fn composed_path(&self) -> Array<EventTarget>

pub fn init_event( &self, type_: &dyn ToJs<JsString>, bubbles: &dyn ToJs<JsNullable<JsBoolean>>, cancelable: &dyn ToJs<JsNullable<JsBoolean>>, ) -> JsNullish

pub fn get_bubbling__phase(&self) -> JsNumber

pub fn set_bubbling__phase(&self, value: &dyn ToJs<JsNumber>)

pub fn get_at__target(&self) -> JsNumber

pub fn set_at__target(&self, value: &dyn ToJs<JsNumber>)

pub fn get_capturing__phase(&self) -> JsNumber

pub fn set_capturing__phase(&self, value: &dyn ToJs<JsNumber>)

pub fn get_none(&self) -> JsNumber

pub fn set_none(&self, value: &dyn ToJs<JsNumber>)

pub fn get_type(&self) -> JsString

pub fn set_type(&self, value: &dyn ToJs<JsString>)

pub fn get_time_stamp(&self) -> JsNumber

pub fn set_time_stamp(&self, value: &dyn ToJs<JsNumber>)

pub fn get_target(&self) -> JsNullable<EventTarget>

pub fn set_target(&self, value: &dyn ToJs<JsNullable<EventTarget>>)

pub fn get_src_element(&self) -> JsNullable<EventTarget>

pub fn set_src_element(&self, value: &dyn ToJs<JsNullable<EventTarget>>)

pub fn get_return_value(&self) -> JsBoolean

pub fn set_return_value(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_is_trusted(&self) -> JsBoolean

pub fn set_is_trusted(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_event_phase(&self) -> JsNumber

pub fn set_event_phase(&self, value: &dyn ToJs<JsNumber>)

pub fn get_default_prevented(&self) -> JsBoolean

pub fn set_default_prevented(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_current_target(&self) -> JsNullable<EventTarget>

pub fn set_current_target(&self, value: &dyn ToJs<JsNullable<EventTarget>>)

pub fn get_composed(&self) -> JsBoolean

pub fn set_composed(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_cancelable(&self) -> JsBoolean

pub fn set_cancelable(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_cancel_bubble(&self) -> JsBoolean

pub fn set_cancel_bubble(&self, value: &dyn ToJs<JsBoolean>)

pub fn get_bubbles(&self) -> JsBoolean

pub fn set_bubbles(&self, value: &dyn ToJs<JsBoolean>)

Methods from Deref<Target = JsObject>

pub fn js_get_field(&self, property: &dyn UseInJsCode) -> JsValue

Get a field value of in this object.

WSDOM provides built-in getters so you should use that instead when possible.

Use js_get_field only when needed

fn example(browser: Browser) {
    // you can get `window["location"]["href"]` like this
    let href: JsValue = wsdom::dom::location(&browser).js_get_field(&"href");

    // but you should use built-in getters instead
    let href: JsString = wsdom::dom::location(&browser).get_href();
}

pub fn js_set_field(&self, property: &dyn UseInJsCode, value: &dyn UseInJsCode)

Set a field value of in this object.

WSDOM provides built-in setters so you should use that instead when possible.

Use js_set_field only when needed

fn example(browser: Browser) {
    // you can set `window["location"]["href"]` like this
    wsdom::dom::location(&browser).js_set_field(&"href", &"https://example.com/");

    // but you should use built-in setters instead
    wsdom::dom::location(&browser).set_href(&"https://example.com");
}

pub fn js_call_method<'a>( &'a self, method_name: &'a str, args: impl IntoIterator<Item = &'a dyn UseInJsCode>, last_arg_variadic: bool, ) -> JsValue

Call a method on this object.

Most types in WSDOM already come with safe Rust wrappers for their methods, so you should use those instead.

fn example(browser: &Browser) {
    let console = wsdom::dom::console(browser);
    // you can call console.log like this
    console.js_call_method("log", [&"hello" as &_], false);
     
    // but the better way is to use
    wsdom::dom::console(&browser).log(&[&"Hello" as &_]);
}

Be aware that the first argument (method_name) is NOT escaped.

Set last_arg_variadic to true if you want to “spread” the last argument as obj.method(arg1, arg2, ...arg3).

pub fn js_call_self<'a>( &'a self, args: impl IntoIterator<Item = &'a dyn UseInJsCode>, last_arg_variadic: bool, ) -> JsValue

Call this object: obj().

Most types in WSDOM already come with safe Rust wrappers for their methods, so you should use those instead.

Methods from Deref<Target = JsValue>

pub fn browser(&self) -> &Browser

pub fn retrieve_json(&self) -> RetrieveFuture<'_, Value>

Retrive this value from the JS side to the Rust side. Returns Future whose output is a serde_json::Value.

use wsdom::dom::Browser

use wsdom::dom::HTMLInputElement;

async fn example(input: &HTMLInputElement) { let _val = input.get_value().retrieve_json().await; }

Trait Implementations

impl AsRef<Event> for PointerEvent

fn as_ref(&self) -> &Event

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

impl AsRef<JsObject> for PointerEvent

fn as_ref(&self) -> &JsObject

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

impl AsRef<JsValue> for PointerEvent

fn as_ref(&self) -> &JsValue

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

impl AsRef<MouseEvent> for PointerEvent

fn as_ref(&self) -> &MouseEvent

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

impl AsRef<PointerEvent> for PointerEvent

fn as_ref(&self) -> &Self

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

impl AsRef<UIEvent> for PointerEvent

fn as_ref(&self) -> &UIEvent

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

impl Clone for PointerEvent

fn clone(&self) -> PointerEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for PointerEvent

type Target = MouseEvent

The resulting type after dereferencing.

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

Dereferences the value.

impl Into<Event> for PointerEvent

fn into(self) -> Event

Converts this type into the (usually inferred) input type.

impl Into<JsObject> for PointerEvent

fn into(self) -> JsObject

Converts this type into the (usually inferred) input type.

impl Into<JsValue> for PointerEvent

fn into(self) -> JsValue

Converts this type into the (usually inferred) input type.

impl Into<MouseEvent> for PointerEvent

fn into(self) -> MouseEvent

Converts this type into the (usually inferred) input type.

impl Into<UIEvent> for PointerEvent

fn into(self) -> UIEvent

Converts this type into the (usually inferred) input type.

impl JsCast for PointerEvent

fn unchecked_from_js(val: JsValue) -> Self

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

fn unchecked_into<T>(self) -> T

where T: JsCast,

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

where T: JsCast,

impl RefCast for PointerEvent

type From = JsValue

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl UseInJsCode for PointerEvent

fn serialize_to(&self, buf: &mut Formatter<'_>) -> Result