Struct web_sys::MouseEvent

[+] Show declaration

[+] Expand attributes
#[repr(transparent)]pub struct MouseEvent { /* fields omitted */ }

[−] Expand description

The MouseEvent class.

MDN Documentation

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

Implementations

impl MouseEvent[−]

pub fn screen_x(&self) -> i32[−]

Getter for the screenX field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn screen_y(&self) -> i32[−]

Getter for the screenY field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn client_x(&self) -> i32[−]

Getter for the clientX field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn client_y(&self) -> i32[−]

Getter for the clientY field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn x(&self) -> i32[−]

Getter for the x field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn y(&self) -> i32[−]

Getter for the y field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn offset_x(&self) -> i32[−]

Getter for the offsetX field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn offset_y(&self) -> i32[−]

Getter for the offsetY field of this object.

MDN Documentation

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

impl MouseEvent[−]

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

impl MouseEvent[−]

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

impl MouseEvent[−]

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

impl MouseEvent[−]

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

impl MouseEvent[−]

pub fn button(&self) -> i16[−]

Getter for the button field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn buttons(&self) -> u16[−]

Getter for the buttons field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn related_target(&self) -> Option<EventTarget>[−]

Getter for the relatedTarget field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn region(&self) -> Option<String>[−]

Getter for the region field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn movement_x(&self) -> i32[−]

Getter for the movementX field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn movement_y(&self) -> i32[−]

Getter for the movementY field of this object.

MDN Documentation

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

impl MouseEvent[−]

pub fn new(type_arg: &str) -> Result<MouseEvent, JsValue>[−]

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

MDN Documentation

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

impl MouseEvent[−]

pub fn get_modifier_state(&self, key_arg: &str) -> bool[−]

The getModifierState() method.

MDN Documentation

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

impl MouseEvent[−]

pub fn init_mouse_event(&self, type_arg: &str)[−]

The initMouseEvent() method.

MDN Documentation

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

impl MouseEvent[−]

pub fn init_mouse_event_with_can_bubble_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool
)[−]

The initMouseEvent() method.

MDN Documentation

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

impl MouseEvent[−]

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool
)[−]

The initMouseEvent() method.

MDN Documentation

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

Methods from Deref<Target = UiEvent>

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 const SCROLL_PAGE_UP: i32

pub const SCROLL_PAGE_DOWN: i32

Trait Implementations

impl AsRef<Event> for MouseEvent[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &Event[−]

Performs the conversion.

impl AsRef<JsValue> for MouseEvent[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &JsValue[−]

Performs the conversion.

impl AsRef<MouseEvent> for MouseEvent[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &MouseEvent[−]

Performs the conversion.

impl AsRef<Object> for MouseEvent[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &Object[−]

Performs the conversion.

impl AsRef<UiEvent> for MouseEvent[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &UiEvent[−]

Performs the conversion.

impl Clone for MouseEvent[+]

[+] Show hidden undocumented items

fn clone(&self) -> MouseEvent[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for MouseEvent[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Deref for MouseEvent[+]

[+] Show hidden undocumented items

type Target = UiEvent

The resulting type after dereferencing.

fn deref(&self) -> &UiEvent[−]

Dereferences the value.

impl Eq for MouseEvent

impl From<JsValue> for MouseEvent[+]

[+] Show hidden undocumented items

fn from(obj: JsValue) -> MouseEvent[−]

Performs the conversion.

impl From<MouseEvent> for JsValue[+]

[+] Show hidden undocumented items

fn from(obj: MouseEvent) -> JsValue[−]

Performs the conversion.

impl From<MouseEvent> for UiEvent[+]

[+] Show hidden undocumented items

fn from(obj: MouseEvent) -> UiEvent[−]

Performs the conversion.

impl From<MouseEvent> for Event[+]

[+] Show hidden undocumented items

fn from(obj: MouseEvent) -> Event[−]

Performs the conversion.

impl From<MouseEvent> for Object[+]

[+] Show hidden undocumented items

fn from(obj: MouseEvent) -> Object[−]

Performs the conversion.

impl FromWasmAbi for MouseEvent[+]

[+] Show hidden undocumented items

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) -> Self[−]

Recover a Self from Self::Abi.

impl IntoWasmAbi for MouseEvent[+]

[+] Show hidden undocumented items

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi[−]

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

impl<'a> IntoWasmAbi for &'a MouseEvent[+]

[+] Show hidden undocumented items

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

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

fn into_abi(self) -> Self::Abi[−]

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

impl JsCast for MouseEvent[+]

[+] Show hidden undocumented items

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 MouseEvent[+]

[+] Show hidden undocumented items

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 MouseEvent[+]

[+] Show hidden undocumented items

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 MouseEvent[+]

[+] Show hidden undocumented items

fn none() -> Self::Abi[−]

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

impl PartialEq<MouseEvent> for MouseEvent[+]

[+] Show hidden undocumented items

fn eq(&self, other: &MouseEvent) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MouseEvent) -> bool[−]

This method tests for !=.

impl RefFromWasmAbi for MouseEvent[+]

[+] Show hidden undocumented items

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<MouseEvent>

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 StructuralEq for MouseEvent

impl StructuralPartialEq for MouseEvent

impl WasmDescribe for MouseEvent[+]

[+] Show hidden undocumented items

fn describe()