Struct gtk4::GesturePan

#[repr(transparent)]
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 signal::GesturePan::pan signal will be emitted as input events are received, containing the offset in the given axis.

Implements

GestureDragExt, GestureSingleExt, GestureExt, EventControllerExt, 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 Display for GesturePan

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

Formats the value using the given formatter.

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) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

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