Struct gtk4::GesturePan

pub struct GesturePan { /* private fields */ }

GesturePan is a Gesture for pan gestures.

These are drags that are locked to happen along one axis. The axis that a GesturePan handles is defined at construct time, and can be changed through set_orientation().

When the gesture starts to be recognized, GesturePan will attempt to determine as early as possible whether the sequence is moving in the expected direction, and denying the sequence if this does not happen.

Once a panning gesture along the expected axis is recognized, the pan signal will be emitted as input events are received, containing the offset in the given axis.

Properties

orientation

The expected orientation of pan gestures.

Readable | Writeable

GestureSingle

button

Mouse button number to listen to, or 0 to listen for any button.

Readable | Writeable

exclusive

Whether the gesture is exclusive.

Exclusive gestures only listen to pointer and pointer emulated events.

Readable | Writeable

touch-only

Whether the gesture handles only touch events.

Readable | Writeable

Gesture

n-points

The number of touch points that trigger recognition on this gesture.

Readable | Writeable | Construct Only

EventController

name

The name for this controller, typically used for debugging purposes.

Readable | Writeable

propagation-limit

The limit for which events this controller will handle.

Readable | Writeable

propagation-phase

The propagation phase at which this controller will handle events.

Readable | Writeable

widget

The widget receiving the GdkEvents that the controller will handle.

Readable

Signals

pan

Emitted once a panning gesture along the expected axis is detected.

GestureDrag

drag-begin

Emitted whenever dragging starts.

drag-end

Emitted whenever the dragging is finished.

drag-update

Emitted whenever the dragging point moves.

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

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

Implementations

impl GesturePan

pub fn new(orientation: Orientation) -> GesturePan

Returns a newly created Gesture that recognizes pan gestures.

orientation

expected orientation

Returns

a newly created GesturePan

pub fn builder() -> GesturePanBuilder

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

This method returns an instance of GesturePanBuilder which can be used to create GesturePan objects.

pub fn orientation(&self) -> Orientation

Returns the orientation of the pan gestures that this @self expects.

Returns

the expected orientation for pan gestures

pub fn set_orientation(&self, orientation: Orientation)

Sets the orientation to be expected on pan gestures.

orientation

expected orientation

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

Emitted once a panning gesture along the expected axis is detected.

direction

current direction of the pan gesture

offset

Offset along the gesture orientation

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

Trait Implementations

impl Clone for GesturePan

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 GesturePan

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

Formats the value using the given formatter.

impl Default for GesturePan

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for GesturePan

type ParamSpec = ParamSpecObject

type SetValue = GesturePan

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GesturePan

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 GesturePan

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 GesturePan

type Parent = GestureDrag

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

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 GesturePan

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 GesturePan

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GesturePan

impl IsA<EventController> for GesturePan

impl IsA<Gesture> for GesturePan

impl IsA<GestureDrag> for GesturePan

impl IsA<GestureSingle> for GesturePan