Struct web_sys::PointerEvent
source · [−]#[repr(transparent)]pub struct PointerEvent { /* private fields */ }
Expand description
The PointerEvent
class.
This API requires the following crate features to be activated: PointerEvent
Implementations
Getter for the pointerId
field of this object.
This API requires the following crate features to be activated: PointerEvent
Getter for the width
field of this object.
This API requires the following crate features to be activated: PointerEvent
Getter for the height
field of this object.
This API requires the following crate features to be activated: PointerEvent
Getter for the pressure
field of this object.
This API requires the following crate features to be activated: PointerEvent
Getter for the tangentialPressure
field of this object.
This API requires the following crate features to be activated: PointerEvent
Getter for the tiltX
field of this object.
This API requires the following crate features to be activated: PointerEvent
Getter for the tiltY
field of this object.
This API requires the following crate features to be activated: PointerEvent
Getter for the twist
field of this object.
This API requires the following crate features to be activated: PointerEvent
Getter for the pointerType
field of this object.
This API requires the following crate features to be activated: PointerEvent
Getter for the isPrimary
field of this object.
This API requires the following crate features to be activated: PointerEvent
The new PointerEvent(..)
constructor, creating a new instance of PointerEvent
.
This API requires the following crate features to be activated: PointerEvent
pub fn new_with_event_init_dict(
type_: &str,
event_init_dict: &PointerEventInit
) -> Result<PointerEvent, JsValue>
pub fn new_with_event_init_dict(
type_: &str,
event_init_dict: &PointerEventInit
) -> Result<PointerEvent, JsValue>
The new PointerEvent(..)
constructor, creating a new instance of PointerEvent
.
This API requires the following crate features to be activated: PointerEvent
, PointerEventInit
The getCoalescedEvents()
method.
This API requires the following crate features to be activated: PointerEvent
Methods from Deref<Target = MouseEvent>
Getter for the screenX
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the screenY
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the clientX
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the clientY
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the x
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the y
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the offsetX
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the offsetY
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the ctrlKey
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the shiftKey
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the altKey
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the metaKey
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the button
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the buttons
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the relatedTarget
field of this object.
This API requires the following crate features to be activated: EventTarget
, MouseEvent
Getter for the region
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the movementX
field of this object.
This API requires the following crate features to be activated: MouseEvent
Getter for the movementY
field of this object.
This API requires the following crate features to be activated: MouseEvent
The getModifierState()
method.
This API requires the following crate features to be activated: MouseEvent
The initMouseEvent()
method.
This API requires the following crate features to be activated: MouseEvent
The initMouseEvent()
method.
This API requires the following crate features to be activated: MouseEvent
pub fn init_mouse_event_with_can_bubble_arg_and_cancelable_arg(
&self,
type_arg: &str,
can_bubble_arg: bool,
cancelable_arg: bool
)
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.
This API requires the following crate features to be activated: MouseEvent
The initMouseEvent()
method.
This API requires the following crate features to be activated: MouseEvent
, Window
The initMouseEvent()
method.
This API requires the following crate features to be activated: MouseEvent
, Window
The initMouseEvent()
method.
This API requires the following crate features to be activated: MouseEvent
, Window
The initMouseEvent()
method.
This API requires the following crate features to be activated: MouseEvent
, Window
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
)
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.
This API requires the following crate features to be activated: MouseEvent
, Window
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
)
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.
This API requires the following crate features to be activated: MouseEvent
, Window
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
)
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.
This API requires the following crate features to be activated: MouseEvent
, Window
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
)
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.
This API requires the following crate features to be activated: MouseEvent
, Window
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
)
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.
This API requires the following crate features to be activated: MouseEvent
, Window
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
)
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.
This API requires the following crate features to be activated: MouseEvent
, Window
The initMouseEvent()
method.
This API requires the following crate features to be activated: MouseEvent
, Window
The initMouseEvent()
method.
This API requires the following crate features to be activated: EventTarget
, MouseEvent
, Window
Methods from Deref<Target = UiEvent>
Getter for the view
field of this object.
This API requires the following crate features to be activated: UiEvent
, Window
Getter for the detail
field of this object.
This API requires the following crate features to be activated: UiEvent
Getter for the layerX
field of this object.
This API requires the following crate features to be activated: UiEvent
Getter for the layerY
field of this object.
This API requires the following crate features to be activated: UiEvent
Getter for the pageX
field of this object.
This API requires the following crate features to be activated: UiEvent
Getter for the pageY
field of this object.
This API requires the following crate features to be activated: UiEvent
Getter for the which
field of this object.
This API requires the following crate features to be activated: UiEvent
Getter for the rangeParent
field of this object.
This API requires the following crate features to be activated: Node
, UiEvent
Getter for the rangeOffset
field of this object.
This API requires the following crate features to be activated: UiEvent
The initUIEvent()
method.
This API requires the following crate features to be activated: UiEvent
The initUIEvent()
method.
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
)
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.
This API requires the following crate features to be activated: UiEvent
The initUIEvent()
method.
This API requires the following crate features to be activated: UiEvent
, Window
The initUIEvent()
method.
This API requires the following crate features to be activated: UiEvent
, Window
Methods from Deref<Target = Event>
Getter for the type
field of this object.
This API requires the following crate features to be activated: Event
Getter for the target
field of this object.
This API requires the following crate features to be activated: Event
, EventTarget
Getter for the currentTarget
field of this object.
This API requires the following crate features to be activated: Event
, EventTarget
Getter for the eventPhase
field of this object.
This API requires the following crate features to be activated: Event
Getter for the bubbles
field of this object.
This API requires the following crate features to be activated: Event
Getter for the cancelable
field of this object.
This API requires the following crate features to be activated: Event
Getter for the defaultPrevented
field of this object.
This API requires the following crate features to be activated: Event
Getter for the composed
field of this object.
This API requires the following crate features to be activated: Event
Getter for the isTrusted
field of this object.
This API requires the following crate features to be activated: Event
Getter for the timeStamp
field of this object.
This API requires the following crate features to be activated: Event
Getter for the cancelBubble
field of this object.
This API requires the following crate features to be activated: Event
Setter for the cancelBubble
field of this object.
This API requires the following crate features to be activated: Event
The composedPath()
method.
This API requires the following crate features to be activated: Event
The initEvent()
method.
This API requires the following crate features to be activated: Event
The initEvent()
method.
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
)
pub fn init_event_with_bubbles_and_cancelable(
&self,
type_: &str,
bubbles: bool,
cancelable: bool
)
The initEvent()
method.
This API requires the following crate features to be activated: Event
The preventDefault()
method.
This API requires the following crate features to be activated: Event
The stopImmediatePropagation()
method.
This API requires the following crate features to be activated: Event
The stopPropagation()
method.
This API requires the following crate features to be activated: Event
Methods from Deref<Target = Object>
The constructor property returns a reference to the Object
constructor
function that created the instance object.
The hasOwnProperty()
method returns a boolean indicating whether the
object has the specified property as its own property (as opposed to
inheriting it).
The isPrototypeOf()
method checks if an object exists in another
object’s prototype chain.
The propertyIsEnumerable()
method returns a Boolean indicating
whether the specified property is enumerable.
The toLocaleString()
method returns a string representing the object.
This method is meant to be overridden by derived objects for
locale-specific purposes.
The toString()
method returns a string representing the object.
The valueOf()
method returns the primitive value of the
specified object.
Methods from Deref<Target = JsValue>
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
.
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.
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
.
Tests whether this JS value is undefined
Tests whether the type of this JS value is function
.
Applies the unary typeof
JS operator on a JsValue
.
Applies the binary in
JS operator on the two JsValue
s.
Compare two JsValue
s for equality, using the ==
operator in JS.
Applies the unary ~
JS operator on a JsValue
.
Applies the binary >>>
JS operator on the two JsValue
s.
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
Applies the binary **
JS operator on the two JsValue
s.
Applies the binary <
JS operator on the two JsValue
s.
Applies the binary <=
JS operator on the two JsValue
s.
Applies the binary >=
JS operator on the two JsValue
s.
Applies the binary >
JS operator on the two JsValue
s.
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations
Performs the conversion.
Performs the conversion.
type Target = MouseEvent
type Target = MouseEvent
The resulting type after dereferencing.
Dereferences the value.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs a dynamic instanceof
check to see whether the JsValue
provided is an instance of this type. Read more
Performs a zero-cost unchecked conversion from a JsValue
into an
instance of Self
Read more
Performs a zero-cost unchecked conversion from a &JsValue
into an
instance of &Self
. Read more
Test whether this JS value has a type T
. Read more
Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
Performs a zero-cost unchecked cast into the specified type. Read more
Performs a zero-cost unchecked cast into a reference to the specified type. Read more
Test whether this JS value is an instance of the type T
. Read more
Performs a dynamic check to see whether the JsValue
provided
is a value of this type. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
The wasm ABI type references to Self
are recovered from.
type Anchor = ManuallyDrop<PointerEvent>
type Anchor = ManuallyDrop<PointerEvent>
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. Read more
Recover a Self::Anchor
from Self::Abi
. Read more
Auto Trait Implementations
impl RefUnwindSafe for PointerEvent
impl !Send for PointerEvent
impl !Sync for PointerEvent
impl Unpin for PointerEvent
impl UnwindSafe for PointerEvent
Blanket Implementations
Mutably borrows from an owned value. Read more
type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
Same as IntoWasmAbi::Abi
Same as IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
. Read more