Struct gdk4::TouchpadEvent

pub struct TouchpadEvent(_);

An event related to a gesture on a touchpad device.

Unlike touchscreens, where the windowing system sends basic sequences of begin, update, end events, and leaves gesture recognition to the clients, touchpad gestures are typically processed by the system, resulting in these events.

Implementations

impl TouchpadEvent

pub fn upcast(self) -> Event

pub fn upcast_ref(&self) -> &Event

impl TouchpadEvent

pub fn deltas(&self) -> (f64, f64)

Extracts delta information from a touchpad event.

Returns

dx

return location for x

dy

return location for y

pub fn gesture_phase(&self) -> TouchpadGesturePhase

Extracts the touchpad gesture phase from a touchpad event.

Returns

the gesture phase of self

pub fn n_fingers(&self) -> u32

Extracts the number of fingers from a touchpad event.

Returns

the number of fingers for self

pub fn pinch_angle_delta(&self) -> f64

Extracts the angle delta from a touchpad pinch event.

Returns

the angle delta of self

pub fn pinch_scale(&self) -> f64

Extracts the scale from a touchpad pinch event.

Returns

the scale of self

Methods from Deref<Target = Event>

pub fn downcast_ref<T: EventKind>(&self) -> Option<&T>

pub fn angle<P: AsRef<Event>>(&self, event: P) -> Option<f64>

pub fn center<P: AsRef<Event>>(&self, event: P) -> Option<(f64, f64)>

pub fn distance<P: AsRef<Event>>(&self, event: P) -> Option<f64>

pub fn axis(&self, axis_use: AxisUse) -> Option<f64>

Extract the axis value for a particular axis use from an event structure.

axis_use

the axis use to look for

Returns

true if the specified axis was found, otherwise false

value

location to store the value found

pub fn device(&self) -> Option<Device>

Returns the device of an event.

Returns

a Device

pub fn display(&self) -> Option<Display>

Retrieves the display associated to the self.

Returns

a Display

pub fn event_type(&self) -> EventType

Retrieves the type of the event.

Returns

a EventType

pub fn history(&self) -> Vec<TimeCoord>

Retrieves the history of the device that self is for, as a list of time and coordinates.

The history includes positions that are not delivered as separate events to the application because they occurred in the same frame as self.

Note that only motion and scroll events record history, and motion events do it only if one of the mouse buttons is down.

Returns

an array of time and coordinates

pub fn modifier_state(&self) -> ModifierType

Returns the modifier state field of an event.

Returns

the modifier state of self

pub fn is_pointer_emulated(&self) -> bool

Returns whether this event is an ‘emulated’ pointer event.

Emulated pointer events typically originate from a touch events.

Returns

true if this event is emulated

pub fn position(&self) -> Option<(f64, f64)>

Extract the event surface relative x/y coordinates from an event.

Returns

x

location to put event surface x coordinate

y

location to put event surface y coordinate

pub fn seat(&self) -> Option<Seat>

Returns the seat that originated the event.

Returns

a Seat.

pub fn surface(&self) -> Option<Surface>

Extracts the surface associated with an event.

Returns

The Surface associated with the event

pub fn time(&self) -> u32

Returns the timestamp of self.

Not all events have timestamps. In that case, this function returns GDK_CURRENT_TIME.

Returns

timestamp field from self

pub fn triggers_context_menu(&self) -> bool

Returns whether a Event should trigger a context menu, according to platform conventions.

The right mouse button typically triggers context menus.

This function should always be used instead of simply checking for event->button == GDK_BUTTON_SECONDARY.

Returns

true if the event should trigger a context menu.

Trait Implementations

impl AsRef<Event> for TouchpadEvent

fn as_ref(&self) -> &Event

Performs the conversion.

impl Clone for TouchpadEvent

fn clone(&self) -> TouchpadEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TouchpadEvent

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

Formats the value using the given formatter.

impl Deref for TouchpadEvent

type Target = Event

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for TouchpadEvent

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

Formats the value using the given formatter.

impl StaticType for TouchpadEvent

fn static_type() -> Type

Returns the type identifier of Self.