Struct gdk4::TouchpadEvent

source ·

pub struct TouchpadEvent { /* private fields */ }

Expand description

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§

source §

impl TouchpadEvent

source

pub fn as_ptr(&self) -> *mut GdkTouchpadEvent

Return the inner pointer to the underlying C value.

source

pub unsafe fn from_glib_ptr_borrow<'a>( ptr: const const GdkTouchpadEvent ) -> &'a Self

Borrows the underlying C value.

source §

impl TouchpadEvent

source

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

Extracts delta information from a touchpad event.

§Returns

§`dx`

return location for x

§`dy`

return location for y

source

pub fn gesture_phase(&self) -> TouchpadGesturePhase

Extracts the touchpad gesture phase from a touchpad event.

§Returns

the gesture phase of @self

source

pub fn n_fingers(&self) -> u32

Extracts the number of fingers from a touchpad event.

§Returns

the number of fingers for @self

source

pub fn pinch_angle_delta(&self) -> f64

Extracts the angle delta from a touchpad pinch event.

§Returns

the angle delta of @self

source

pub fn pinch_scale(&self) -> f64

Extracts the scale from a touchpad pinch event.

§Returns

the scale of @self

source §

impl TouchpadEvent

source

pub fn upcast(self) -> Event

source

pub fn upcast_ref(&self) -> &Event

Methods from Deref<Target = Event>§

source

pub fn as_ptr(&self) -> *mut GdkEvent

Return the inner pointer to the underlying C value.

source

pub const NONE: Option<&'static Event> = None

source

pub fn axes(&self) -> Option<Vec<f64>>

Extracts all axis values from an event.

To find out which axes are used, use DeviceTool::axes() on the device tool returned by device_tool().

§Returns

true on success, otherwise false

§`axes`

the array of values for all axes

source

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

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

To find out which axes are used, use DeviceTool::axes() on the device tool returned by device_tool().

§`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

source

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

Returns the device of an event.

§Returns

a Device

source

pub fn device_tool(&self) -> Option<DeviceTool>

Returns a DeviceTool representing the tool that caused the event.

If the was not generated by a device that supports different tools (such as a tablet), this function will return None.

Note: the DeviceTool will be constant during the application lifetime, if settings must be stored persistently across runs, see DeviceTool::serial().

§Returns

The current device tool

source

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

Retrieves the display associated to the @self.

§Returns

a Display

source

pub fn event_sequence(&self) -> EventSequence

Returns the event sequence to which the event belongs.

Related touch events are connected in a sequence. Other events typically don’t have event sequence information.

§Returns

the event sequence that the event belongs to

source

pub fn event_type(&self) -> EventType

Retrieves the type of the event.

§Returns

a EventType

source

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, or the device has a tool.

§Returns

an array of time and coordinates

source

pub fn modifier_state(&self) -> ModifierType

Returns the modifier state field of an event.

§Returns

the modifier state of @self

source

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

source

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

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

This position is in surface coordinates.

§Returns

§`x`

location to put event surface x coordinate

§`y`

location to put event surface y coordinate

source

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

Returns the seat that originated the event.

§Returns

a Seat.

source

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

Extracts the surface associated with an event.

§Returns

The Surface associated with the event

source

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

source

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.

source

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

Returns the relative angle from @event1 to @event2.

The relative angle is the angle between the X axis and the line through both events’ positions. The rotation direction for positive angles is from the positive X axis towards the positive Y axis.

This assumes that both events have X/Y information. If not, this function returns false.