Struct gtk4::GestureSwipe

pub struct GestureSwipe { /* private fields */ }

GestureSwipe is a Gesture for swipe gestures.

After a press/move/…/move/release sequence happens, the swipe signal will be emitted, providing the velocity and directionality of the sequence at the time it was lifted.

If the velocity is desired in intermediate points, velocity() can be called in a update handler.

All velocities are reported in pixels/sec units.

Signals

swipe

Emitted when the recognized gesture is finished.

Velocity and direction are a product of previously recorded events.

Gesture

begin

Emitted when the gesture is recognized.

This means the number of touch sequences matches n-points.

Note: These conditions may also happen when an extra touch (eg. a third touch on a 2-touches gesture) is lifted, in that situation @sequence won’t pertain to the current set of active touches, so don’t rely on this being true.

cancel

Emitted whenever a sequence is cancelled.

This usually happens on active touches when EventControllerExt::reset() is called on @gesture (manually, due to grabs…), or the individual @sequence was claimed by parent widgets’ controllers (see GestureExt::set_sequence_state()).

@gesture must forget everything about @sequence as in response to this signal.

end

Emitted when @gesture either stopped recognizing the event sequences as something to be handled, or the number of touch sequences became higher or lower than n-points.

Note: @sequence might not pertain to the group of sequences that were previously triggering recognition on @gesture (ie. a just pressed touch sequence that exceeds n-points). This situation may be detected by checking through GestureExt::handles_sequence().

sequence-state-changed

Emitted whenever a sequence state changes.

See GestureExt::set_sequence_state() to know more about the expectable sequence lifetimes.

update

Emitted whenever an event is handled while the gesture is recognized.

@sequence is guaranteed to pertain to the set of active touches.

Implements

GestureSingleExt, GestureExt, EventControllerExt, [trait@glib::ObjectExt]

Implementations

impl GestureSwipe

pub fn new() -> GestureSwipe

Returns a newly created Gesture that recognizes swipes.

Returns

a newly created GestureSwipe

pub fn builder() -> GestureSwipeBuilder

Creates a new builder-pattern struct instance to construct GestureSwipe objects.

This method returns an instance of GestureSwipeBuilder which can be used to create GestureSwipe objects.

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

Gets the current velocity.

If the gesture is recognized, this function returns true and fills in @velocity_x and @velocity_y with the recorded velocity, as per the last events processed.

Returns

whether velocity could be calculated

velocity_x

return value for the velocity in the X axis, in pixels/sec

velocity_y

return value for the velocity in the Y axis, in pixels/sec

pub fn connect_swipe<F: Fn(&Self, f64, f64) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the recognized gesture is finished.

Velocity and direction are a product of previously recorded events.

velocity_x

velocity in the X axis, in pixels/sec

velocity_y

velocity in the Y axis, in pixels/sec

Trait Implementations

impl Clone for GestureSwipe

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GestureSwipe

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

Formats the value using the given formatter.

impl Default for GestureSwipe

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for GestureSwipe

type ParamSpec = ParamSpecObject

type SetValue = GestureSwipe

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, GestureSwipe>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GestureSwipe

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

where H: Hasher,

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 Ord for GestureSwipe

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for GestureSwipe

type Parent = GestureSingle

impl<OT: ObjectType> PartialEq<OT> for GestureSwipe

fn eq(&self, other: &OT) -> 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<OT: ObjectType> PartialOrd<OT> for GestureSwipe

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for GestureSwipe

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GestureSwipe

impl IsA<EventController> for GestureSwipe

impl IsA<Gesture> for GestureSwipe

impl IsA<GestureSingle> for GestureSwipe