Struct MouseEvent

#[repr(C)]
pub(crate) struct MouseEvent {
    uievent: UIEvent,
    screen_point: Cell<Point2D<i32, CSSPixel>>,
    client_point: Cell<Point2D<i32, CSSPixel>>,
    page_point: Cell<Point2D<i32, CSSPixel>>,
    modifiers: Cell<Modifiers>,
    button: Cell<i16>,
    buttons: Cell<u16>,
    related_target: MutNullableDom<EventTarget>,
    point_in_target: Cell<Option<Point2D<f32, CSSPixel>>>,
}

https://w3c.github.io/uievents/#interface-mouseevent

Fields

uievent: UIEvent

screen_point: Cell<Point2D<i32, CSSPixel>>

The point on the screen of where this MouseEvent was originally triggered, to use during the dispatch phase.

See: https://w3c.github.io/uievents/#dom-mouseevent-screenx https://w3c.github.io/uievents/#dom-mouseevent-screeny

client_point: Cell<Point2D<i32, CSSPixel>>

The point in the viewport of where this MouseEvent was originally triggered, to use during the dispatch phase.

See: https://w3c.github.io/uievents/#dom-mouseevent-clientx https://w3c.github.io/uievents/#dom-mouseevent-clienty

page_point: Cell<Point2D<i32, CSSPixel>>

The point in the initial containing block of where this MouseEvent was originally triggered to use during the dispatch phase.

See: https://w3c.github.io/uievents/#dom-mouseevent-pagex https://w3c.github.io/uievents/#dom-mouseevent-pagey

modifiers: Cell<Modifiers>

The keyboard modifiers that were active when this mouse event was triggered.

button: Cell<i16>

https://w3c.github.io/uievents/#dom-mouseevent-button

buttons: Cell<u16>

https://w3c.github.io/uievents/#dom-mouseevent-buttons

related_target: MutNullableDom<EventTarget>

https://w3c.github.io/uievents/#dom-mouseevent-relatedtarget

point_in_target: Cell<Option<Point2D<f32, CSSPixel>>>

Implementations

impl MouseEvent

fn __assert_parent_type(&self)

impl MouseEvent

pub(crate) fn new_inherited() -> MouseEvent

pub(crate) fn new_uninitialized( window: &Window, can_gc: CanGc, ) -> DomRoot<MouseEvent>

fn new_uninitialized_with_proto( window: &Window, proto: Option<HandleObject<'_>>, can_gc: CanGc, ) -> DomRoot<MouseEvent>

pub(crate) fn new( window: &Window, type_: DOMString, can_bubble: EventBubbles, cancelable: EventCancelable, view: Option<&Window>, detail: i32, screen_point: Point2D<i32, CSSPixel>, client_point: Point2D<i32, CSSPixel>, page_point: Point2D<i32, CSSPixel>, modifiers: Modifiers, button: i16, buttons: u16, related_target: Option<&EventTarget>, point_in_target: Option<Point2D<f32, CSSPixel>>, can_gc: CanGc, ) -> DomRoot<MouseEvent>

fn new_with_proto( window: &Window, proto: Option<HandleObject<'_>>, type_: DOMString, can_bubble: EventBubbles, cancelable: EventCancelable, view: Option<&Window>, detail: i32, screen_point: Point2D<i32, CSSPixel>, client_point: Point2D<i32, CSSPixel>, page_point: Point2D<i32, CSSPixel>, modifiers: Modifiers, button: i16, buttons: u16, related_target: Option<&EventTarget>, point_in_target: Option<Point2D<f32, CSSPixel>>, can_gc: CanGc, ) -> DomRoot<MouseEvent>

pub(crate) fn new_simple( window: &Window, event_name: FireMouseEventType, can_bubble: EventBubbles, cancelable: EventCancelable, hit_test_result: &HitTestResult, input_event: &ConstellationInputEvent, can_gc: CanGc, ) -> DomRoot<Self>

pub(crate) fn initialize_mouse_event( &self, type_: DOMString, can_bubble: EventBubbles, cancelable: EventCancelable, view: Option<&Window>, detail: i32, screen_point: Point2D<i32, CSSPixel>, client_point: Point2D<i32, CSSPixel>, page_point: Point2D<i32, CSSPixel>, modifiers: Modifiers, button: i16, buttons: u16, related_target: Option<&EventTarget>, point_in_target: Option<Point2D<f32, CSSPixel>>, )

https://w3c.github.io/uievents/#initialize-a-mouseevent

pub(crate) fn point_in_target(&self) -> Option<Point2D<f32, CSSPixel>>

pub(crate) fn for_platform_mouse_event( event: MouseButtonEvent, pressed_mouse_buttons: u16, window: &Window, hit_test_result: &HitTestResult, modifiers: Modifiers, can_gc: CanGc, ) -> DomRoot<Self>

Create a MouseEvent triggered by the embedder https://w3c.github.io/uievents/#create-a-cancelable-mouseevent-id

Trait Implementations

impl Castable for MouseEvent

fn is<T>(&self) -> bool

where T: DerivedFrom<Self>,

Check whether a DOM object implements one of its deriving interfaces.

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

where T: Castable, Self: DerivedFrom<T>,

Cast a DOM object upwards to one of the interfaces it derives from.

fn downcast<T>(&self) -> Option<&T>

where T: DerivedFrom<Self>,

Cast a DOM object downwards to one of the interfaces it might implement.

impl DomObject for MouseEvent

fn reflector(&self) -> &Reflector

Returns the receiver’s reflector.

impl DomObjectWrap<DomTypeHolder> for MouseEvent

const WRAP: unsafe fn(SafeJSContext, &GlobalScope, Option<HandleObject<'_>>, Box<Self>, CanGc) -> Root<Dom<Self>> = {script_bindings::codegen::GenericBindings::MouseEventBinding::Wrap::<dom::bindings::codegen::DomTypeHolder::DomTypeHolder> as for<'a, 'b> unsafe fn(script_bindings::script_runtime::JSContext, &'a dom::globalscope::GlobalScope, std::option::Option<js::rust::Handle<'b, *mut js::jsapi::JSObject>>, std::boxed::Box<dom::mouseevent::MouseEvent>, script_bindings::script_runtime::CanGc) -> script_bindings::root::Root<script_bindings::root::Dom<dom::mouseevent::MouseEvent>>}

Function pointer to the general wrap function type

impl HasParent for MouseEvent

fn as_parent(&self) -> &UIEvent

This is used in a type assertion to ensure that the source and webidls agree as to what the parent type is

type Parent = UIEvent

impl IDLInterface for MouseEvent

fn derives(class: &'static DOMClass) -> bool

Returns whether the given DOM class derives that interface.

impl MallocSizeOf for MouseEvent

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MouseEventMethods<DomTypeHolder> for MouseEvent

fn Constructor( window: &Window, proto: Option<HandleObject<'_>>, can_gc: CanGc, type_: DOMString, init: &MouseEventInit<DomTypeHolder>, ) -> Fallible<DomRoot<MouseEvent>>

https://w3c.github.io/uievents/#dom-mouseevent-mouseevent

fn ScreenX(&self) -> i32

https://w3c.github.io/uievents/#widl-MouseEvent-screenX

fn ScreenY(&self) -> i32

https://w3c.github.io/uievents/#widl-MouseEvent-screenY

fn ClientX(&self) -> i32

https://w3c.github.io/uievents/#widl-MouseEvent-clientX

fn ClientY(&self) -> i32

https://w3c.github.io/uievents/#widl-MouseEvent-clientY

fn PageX(&self) -> i32

https://drafts.csswg.org/cssom-view/#dom-mouseevent-pagex

fn PageY(&self) -> i32

https://drafts.csswg.org/cssom-view/#dom-mouseevent-pagey

fn X(&self) -> i32

https://drafts.csswg.org/cssom-view/#dom-mouseevent-x

fn Y(&self) -> i32

https://drafts.csswg.org/cssom-view/#dom-mouseevent-y

fn OffsetX(&self) -> i32

https://drafts.csswg.org/cssom-view/#dom-mouseevent-offsetx

fn OffsetY(&self) -> i32

https://drafts.csswg.org/cssom-view/#dom-mouseevent-offsety

fn CtrlKey(&self) -> bool

https://w3c.github.io/uievents/#dom-mouseevent-ctrlkey

fn ShiftKey(&self) -> bool

https://w3c.github.io/uievents/#dom-mouseevent-shiftkey

fn AltKey(&self) -> bool

https://w3c.github.io/uievents/#dom-mouseevent-altkey

fn MetaKey(&self) -> bool

https://w3c.github.io/uievents/#dom-mouseevent-metakey

fn Button(&self) -> i16

https://w3c.github.io/uievents/#dom-mouseevent-button

fn Buttons(&self) -> u16

https://w3c.github.io/uievents/#dom-mouseevent-buttons

fn GetRelatedTarget(&self) -> Option<DomRoot<EventTarget>>

https://w3c.github.io/uievents/#widl-MouseEvent-relatedTarget

fn InitMouseEvent( &self, type_arg: DOMString, 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>, )

https://w3c.github.io/uievents/#widl-MouseEvent-initMouseEvent

fn IsTrusted(&self) -> bool

https://dom.spec.whatwg.org/#dom-event-istrusted

fn GetModifierState(&self, key_arg: DOMString) -> bool

https://w3c.github.io/uievents/#dom-mouseevent-getmodifierstate

fn Which(&self) -> i32

impl MutDomObject for MouseEvent

unsafe fn init_reflector(&self, obj: *mut JSObject)

Initializes the Reflector

impl PartialEq for MouseEvent

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToJSValConvertible for MouseEvent

unsafe fn to_jsval(&self, cx: *mut JSContext, rval: MutableHandleValue<'_>)

Convert self to a JSVal. JSAPI failure causes a panic.

impl Traceable for MouseEvent

unsafe fn trace(&self, tracer: *mut JSTracer)

Trace self.

impl DerivedFrom<Event> for MouseEvent

impl DerivedFrom<MouseEvent> for MouseEvent

impl DerivedFrom<MouseEvent> for PointerEvent

impl DerivedFrom<MouseEvent> for WheelEvent

impl DerivedFrom<UIEvent> for MouseEvent

impl Eq for MouseEvent