Struct libhandy::SwipeTracker

pub struct SwipeTracker { /* private fields */ }

Swipe tracker used in Carousel and Leaflet.

The SwipeTracker object can be used for implementing widgets with swipe gestures. It supports touch-based swipes, pointer dragging, and touchpad scrolling.

The widgets will probably want to expose enabled property. If they expect to use horizontal orientation, reversed property can be used for supporting RTL text direction.

Properties

allow-long-swipes

Whether to allow swiping for more than one snap point at a time.

If the value is FALSE, each swipe can only move to the adjacent snap points.

Readable | Writeable

allow-mouse-drag

Whether to allow dragging with mouse pointer.

This should usually be FALSE.

Readable | Writeable

enabled

Whether the swipe tracker is enabled.

When it’s not enabled, no events will be processed. Usually widgets will want to expose this via a property.

Readable | Writeable

reversed

Whether to reverse the swipe direction.

If the swipe tracker is horizontal, it can be used for supporting RTL text direction.

Readable | Writeable

swipeable

The widget the swipe tracker is attached to. Must not be NULL.

Readable | Writeable | Construct Only

Orientable

orientation

The orientation of the orientable.

Readable | Writeable

Signals

begin-swipe

This signal is emitted when a possible swipe is detected.

The @direction value can be used to restrict the swipe to a certain direction.

end-swipe

This signal is emitted as soon as the gesture has stopped.

update-swipe

This signal is emitted every time the progress value changes.

Implements

[trait@glib::ObjectExt], [trait@gtk::prelude::OrientableExt]

Implementations

impl SwipeTracker

pub fn new(swipeable: &impl IsA<Swipeable>) -> SwipeTracker

Creates a new SwipeTracker object on @widget.

swipeable

a swipeable to add the tracker on

Returns

the newly created SwipeTracker

pub fn builder() -> SwipeTrackerBuilder

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

This method returns an instance of SwipeTrackerBuilder which can be used to create SwipeTracker objects.

pub fn allows_long_swipes(&self) -> bool

Available on crate feature v1_2 only.

Whether to allow swiping for more than one snap point at a time.

If the value is FALSE, each swipe can only move to the adjacent snap points.

Returns

whether long swipes are allowed

pub fn allows_mouse_drag(&self) -> bool

Get whether @self can be dragged with mouse pointer.

Returns

TRUE is mouse dragging is allowed

pub fn is_enabled(&self) -> bool

Get whether @self is enabled.

Returns

TRUE if @self is enabled

pub fn is_reversed(&self) -> bool

Get whether @self is reversing the swipe direction.

Returns

TRUE is the direction is reversed

pub fn swipeable(&self) -> Option<Swipeable>

Get @self’s swipeable widget.

Returns

the swipeable widget

pub fn set_allow_long_swipes(&self, allow_long_swipes: bool)

Available on crate feature v1_2 only.

Sets whether to allow swiping for more than one snap point at a time.

If the value is FALSE, each swipe can only move to the adjacent snap points.

allow_long_swipes

whether to allow long swipes

pub fn set_allow_mouse_drag(&self, allow_mouse_drag: bool)

Set whether @self can be dragged with mouse pointer.

This should usually be FALSE.

allow_mouse_drag

whether to allow mouse dragging

pub fn set_enabled(&self, enabled: bool)

Set whether @self is enabled.

enabled

whether to enable to swipe tracker

pub fn set_reversed(&self, reversed: bool)

Set whether to reverse the swipe direction.

If @self is horizontal, can be used for supporting RTL text direction.

reversed

whether to reverse the swipe direction

pub fn shift_position(&self, delta: f64)

Move the current progress value by @delta.

This can be used to adjust the current position if snap points move during the gesture.

delta

the position delta

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

This signal is emitted when a possible swipe is detected.

The @direction value can be used to restrict the swipe to a certain direction.

direction

the direction of the swipe

direct

TRUE if the swipe is directly triggered by a gesture, FALSE if it’s triggered via a SwipeGroup

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

This signal is emitted as soon as the gesture has stopped.

duration

snap-back animation duration, in milliseconds

to

the progress value to animate to

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

This signal is emitted every time the progress value changes.

progress

the current animation progress value

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

Available on crate feature v1_2 only.

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

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

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

Trait Implementations

impl Clone for SwipeTracker

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 SwipeTracker

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

Formats the value using the given formatter.

impl Default for SwipeTracker

fn default() -> Self

Returns the “default value” for a type.

impl Display for SwipeTracker

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

Formats the value using the given formatter.

impl HasParamSpec for SwipeTracker

type ParamSpec = ParamSpecObject

type SetValue = SwipeTracker

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SwipeTracker

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 SwipeTracker

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 SwipeTracker

type Parent = Object

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

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 SwipeTracker

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 SwipeTracker

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SwipeTracker

impl IsA<Orientable> for SwipeTracker