Struct dioxus::prelude::SerializedPointInteraction

pub struct SerializedPointInteraction {

    pub alt_key: bool,
    pub button: i16,
    pub buttons: u16,
    pub client_x: i32,
    pub client_y: i32,
    pub ctrl_key: bool,
    pub meta_key: bool,
    pub offset_x: i32,
    pub offset_y: i32,
    pub page_x: i32,
    pub page_y: i32,
    pub screen_x: i32,
    pub screen_y: i32,
    pub shift_key: bool,
}

Available on crate feature html only.

Fields

alt_key: bool

button: i16

The button number that was pressed (if applicable) when the mouse event was fired.

buttons: u16

Indicates which buttons are pressed on the mouse (or other input device) when a mouse event is triggered.

Each button that can be pressed is represented by a given number (see below). If more than one button is pressed, the button values are added together to produce a new number. For example, if the secondary (2) and auxiliary (4) buttons are pressed simultaneously, the value is 6 (i.e., 2 + 4).

• 1: Primary button (usually the left button)
• 2: Secondary button (usually the right button)
• 4: Auxiliary button (usually the mouse wheel button or middle button)
• 8: 4th button (typically the “Browser Back” button)
• 16 : 5th button (typically the “Browser Forward” button)

client_x: i32

The horizontal coordinate within the application’s viewport at which the event occurred (as opposed to the coordinate within the page).

For example, clicking on the left edge of the viewport will always result in a mouse event with a clientX value of 0, regardless of whether the page is scrolled horizontally.

client_y: i32

The vertical coordinate within the application’s viewport at which the event occurred (as opposed to the coordinate within the page).

For example, clicking on the top edge of the viewport will always result in a mouse event with a clientY value of 0, regardless of whether the page is scrolled vertically.

ctrl_key: bool

True if the control key was down when the mouse event was fired.

meta_key: bool

True if the meta key was down when the mouse event was fired.

offset_x: i32

The offset in the X coordinate of the mouse pointer between that event and the padding edge of the target node.

offset_y: i32

The offset in the Y coordinate of the mouse pointer between that event and the padding edge of the target node.

page_x: i32

The X (horizontal) coordinate (in pixels) of the mouse, relative to the left edge of the entire document. This includes any portion of the document not currently visible.

Being based on the edge of the document as it is, this property takes into account any horizontal scrolling of the page. For example, if the page is scrolled such that 200 pixels of the left side of the document are scrolled out of view, and the mouse is clicked 100 pixels inward from the left edge of the view, the value returned by pageX will be 300.

page_y: i32

The Y (vertical) coordinate in pixels of the event relative to the whole document.

See page_x.

screen_x: i32

The X coordinate of the mouse pointer in global (screen) coordinates.

screen_y: i32

The Y coordinate of the mouse pointer in global (screen) coordinates.

shift_key: bool

True if the shift key was down when the mouse event was fired.

Implementations

impl SerializedPointInteraction

pub fn new( trigger_button: Option<MouseButton>, held_buttons: EnumSet<MouseButton>, coordinates: Coordinates, modifiers: Modifiers ) -> SerializedPointInteraction

Trait Implementations

impl Clone for SerializedPointInteraction

fn clone(&self) -> SerializedPointInteraction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SerializedPointInteraction

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

Formats the value using the given formatter.

impl Default for SerializedPointInteraction

fn default() -> SerializedPointInteraction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SerializedPointInteraction

fn deserialize<__D>( __deserializer: __D ) -> Result<SerializedPointInteraction, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E> From<&E> for SerializedPointInteraction

where E: PointerInteraction,

fn from(data: &E) -> SerializedPointInteraction

Converts to this type from the input type.

impl InteractionElementOffset for SerializedPointInteraction

fn element_coordinates(&self) -> Point2D<f64, ElementSpace>

Gets the coordinates of the event relative to the target element.

fn coordinates(&self) -> Coordinates

Gets the coordinates of the event.

impl InteractionLocation for SerializedPointInteraction

fn client_coordinates(&self) -> Point2D<f64, ClientSpace>

Gets the coordinates of the event relative to the browser viewport.

fn screen_coordinates(&self) -> Point2D<f64, ScreenSpace>

Gets the coordinates of the event relative to the screen.

fn page_coordinates(&self) -> Point2D<f64, PageSpace>

Gets the coordinates of the event relative to the page.

impl ModifiersInteraction for SerializedPointInteraction

fn modifiers(&self) -> Modifiers

Gets the modifiers of the pointer event.

impl PartialEq for SerializedPointInteraction

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

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

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

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

impl PointerInteraction for SerializedPointInteraction

fn held_buttons(&self) -> EnumSet<MouseButton>

Gets the buttons that are currently held down.

fn trigger_button(&self) -> Option<MouseButton>

Gets the button that triggered the event.

impl Serialize for SerializedPointInteraction

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SerializedPointInteraction