Struct PressSource 

pub struct PressSource(/* private fields */);

Source of a Press event

This identifies the source of a click, touch or similar event, including which mouse button is pressed and whether this is a double-click (see Self::repetitions).

This may be used to track a click/touch, but note that identifiers may be re-used after the event completes, thus an Event::PressStart with PressSource equal to a prior instance does not indicate that the same finger / mouse was used. Further note: identifying multiple mice is not currently supported.

Implementations

impl PressSource

pub fn is_mouse(self) -> bool

Returns true if this represents a mouse event

pub fn is_touch(self) -> bool

Returns true if this represents a touch event

pub fn mouse_button(self) -> Option<MouseButton>

Identify the mouse button used

This always returns Some(_) for mouse events and None for touch events.

pub fn is_primary(self) -> bool

Returns true if this represents the left mouse button or a touch event

pub fn is_secondary(self) -> bool

Returns true if this represents the right mouse button

pub fn is_tertiary(self) -> bool

Returns true if this represents the middle mouse button

pub fn repetitions(self) -> u32

The repetitions value

This is 1 for a single-click and all touch events, 2 for a double-click, 3 for a triple-click, etc. For CursorMove without a grab this is 0.

Trait Implementations

impl Clone for PressSource

fn clone(&self) -> PressSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PressSource

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

Formats the value using the given formatter.

impl Hash for PressSource

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PressSource

fn eq(&self, other: &PressSource) -> 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 Copy for PressSource

impl Eq for PressSource

impl StructuralPartialEq for PressSource