Struct web_sys::MouseEvent

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

The MouseEvent object

MDN Documentation

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

Methods

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 new_with_mouse_event_init_dict(
    type_arg: &str,
    mouse_event_init_dict: &MouseEventInit
) -> 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, MouseEventInit

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg_and_screen_y_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32,
    screen_y_arg: i32
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg_and_screen_y_arg_and_client_x_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32,
    screen_y_arg: i32,
    client_x_arg: i32
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg_and_screen_y_arg_and_client_x_arg_and_client_y_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32,
    screen_y_arg: i32,
    client_x_arg: i32,
    client_y_arg: i32
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg_and_screen_y_arg_and_client_x_arg_and_client_y_arg_and_ctrl_key_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32,
    screen_y_arg: i32,
    client_x_arg: i32,
    client_y_arg: i32,
    ctrl_key_arg: bool
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg_and_screen_y_arg_and_client_x_arg_and_client_y_arg_and_ctrl_key_arg_and_alt_key_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32,
    screen_y_arg: i32,
    client_x_arg: i32,
    client_y_arg: i32,
    ctrl_key_arg: bool,
    alt_key_arg: bool
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg_and_screen_y_arg_and_client_x_arg_and_client_y_arg_and_ctrl_key_arg_and_alt_key_arg_and_shift_key_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32,
    screen_y_arg: i32,
    client_x_arg: i32,
    client_y_arg: i32,
    ctrl_key_arg: bool,
    alt_key_arg: bool,
    shift_key_arg: bool
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg_and_screen_y_arg_and_client_x_arg_and_client_y_arg_and_ctrl_key_arg_and_alt_key_arg_and_shift_key_arg_and_meta_key_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32,
    screen_y_arg: i32,
    client_x_arg: i32,
    client_y_arg: i32,
    ctrl_key_arg: bool,
    alt_key_arg: bool,
    shift_key_arg: bool,
    meta_key_arg: bool
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg_and_screen_y_arg_and_client_x_arg_and_client_y_arg_and_ctrl_key_arg_and_alt_key_arg_and_shift_key_arg_and_meta_key_arg_and_button_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32,
    screen_y_arg: i32,
    client_x_arg: i32,
    client_y_arg: i32,
    ctrl_key_arg: bool,
    alt_key_arg: bool,
    shift_key_arg: bool,
    meta_key_arg: bool,
    button_arg: i16
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg_and_view_arg_and_detail_arg_and_screen_x_arg_and_screen_y_arg_and_client_x_arg_and_client_y_arg_and_ctrl_key_arg_and_alt_key_arg_and_shift_key_arg_and_meta_key_arg_and_button_arg_and_related_target_arg(
    &self,
    type_arg: &str,
    can_bubble_arg: bool,
    cancelable_arg: bool,
    view_arg: Option<&Window>,
    detail_arg: i32,
    screen_x_arg: i32,
    screen_y_arg: i32,
    client_x_arg: i32,
    client_y_arg: i32,
    ctrl_key_arg: bool,
    alt_key_arg: bool,
    shift_key_arg: bool,
    meta_key_arg: bool,
    button_arg: i16,
    related_target_arg: Option<&EventTarget>
)

The initMouseEvent() method

MDN Documentation

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

impl MouseEvent

pub fn screen_x(&self) -> i32

The screenX getter

MDN Documentation

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

impl MouseEvent

pub fn screen_y(&self) -> i32

The screenY getter

MDN Documentation

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

impl MouseEvent

pub fn client_x(&self) -> i32

The clientX getter

MDN Documentation

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

impl MouseEvent

pub fn client_y(&self) -> i32

The clientY getter

MDN Documentation

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

impl MouseEvent

pub fn x(&self) -> i32

The x getter

MDN Documentation

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

impl MouseEvent

pub fn y(&self) -> i32

The y getter

MDN Documentation

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

impl MouseEvent

pub fn offset_x(&self) -> i32

The offsetX getter

MDN Documentation

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

impl MouseEvent

pub fn offset_y(&self) -> i32

The offsetY getter

MDN Documentation

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

impl MouseEvent

pub fn ctrl_key(&self) -> bool

The ctrlKey getter

MDN Documentation

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

impl MouseEvent

pub fn shift_key(&self) -> bool

The shiftKey getter

MDN Documentation

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

impl MouseEvent

pub fn alt_key(&self) -> bool

The altKey getter

MDN Documentation

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

impl MouseEvent

pub fn meta_key(&self) -> bool

The metaKey getter

MDN Documentation

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

impl MouseEvent

pub fn button(&self) -> i16

The button getter

MDN Documentation

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

impl MouseEvent

pub fn buttons(&self) -> u16

The buttons getter

MDN Documentation

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

impl MouseEvent

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

The relatedTarget getter

MDN Documentation

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

impl MouseEvent

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

The region getter

MDN Documentation

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

impl MouseEvent

pub fn movement_x(&self) -> i32

The movementX getter

MDN Documentation

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

impl MouseEvent

pub fn movement_y(&self) -> i32

The movementY getter

MDN Documentation

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

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

fn as_ref(&self) -> &MouseEvent

Performs the conversion.

impl AsRef<JsValue> for MouseEvent

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<UiEvent> for MouseEvent

fn as_ref(&self) -> &UiEvent

Performs the conversion.

impl AsRef<Event> for MouseEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl AsRef<Object> for MouseEvent

fn as_ref(&self) -> &Object

Performs the conversion.

impl AsRef<MouseEvent> for MouseScrollEvent

fn as_ref(&self) -> &MouseEvent

Performs the conversion.

impl AsRef<MouseEvent> for PointerEvent

fn as_ref(&self) -> &MouseEvent

Performs the conversion.

impl AsRef<MouseEvent> for WheelEvent

fn as_ref(&self) -> &MouseEvent

Performs the conversion.

impl From<DragEvent> for MouseEvent

fn from(obj: DragEvent) -> MouseEvent

Performs the conversion.

impl From<JsValue> for MouseEvent

fn from(obj: JsValue) -> MouseEvent

Performs the conversion.

impl From<MouseEvent> for JsValue

fn from(obj: MouseEvent) -> JsValue

Performs the conversion.

impl From<MouseEvent> for UiEvent

fn from(obj: MouseEvent) -> UiEvent

Performs the conversion.

impl From<MouseEvent> for Event

fn from(obj: MouseEvent) -> Event

Performs the conversion.

impl From<MouseEvent> for Object

fn from(obj: MouseEvent) -> Object

Performs the conversion.

impl From<MouseScrollEvent> for MouseEvent

fn from(obj: MouseScrollEvent) -> MouseEvent

Performs the conversion.

impl From<PointerEvent> for MouseEvent

fn from(obj: PointerEvent) -> MouseEvent

Performs the conversion.

impl From<WheelEvent> for MouseEvent

fn from(obj: WheelEvent) -> MouseEvent

Performs the conversion.

impl Clone for MouseEvent

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

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Deref for MouseEvent

type Target = UiEvent

The resulting type after dereferencing.

fn deref(&self) -> &UiEvent

Dereferences the value.

impl JsCast for MouseEvent

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.

impl FromWasmAbi for MouseEvent

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

fn describe()

impl IntoWasmAbi for MouseEvent

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 MouseEvent

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

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

fn none() -> Self::Abi

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

impl OptionFromWasmAbi for MouseEvent

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

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, extra: &mut dyn Stack) -> Self::Anchor

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