Class

AdwSwipeTracker

Description [src]

final class Adw.SwipeTracker : GObject.Object
  implements Gtk.Orientable {
  /* No available fields */
}

A swipe tracker used in AdwCarousel, AdwNavigationView and AdwOverlaySplitView.

The AdwSwipeTracker 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 the AdwSwipeTracker:enabled property. If they expect to use horizontal orientation, AdwSwipeTracker:reversed can be used for supporting RTL text direction.

Hierarchy

hierarchy this AdwSwipeTracker implements_0 GtkOrientable this--implements_0 ancestor_0 GObject ancestor_0--this

Ancestors

Implements

Constructors

adw_swipe_tracker_new

Creates a new AdwSwipeTracker for widget.

Instance methods

adw_swipe_tracker_get_allow_long_swipes

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

adw_swipe_tracker_get_allow_mouse_drag

Gets whether self can be dragged with mouse pointer.

adw_swipe_tracker_get_enabled

Gets whether self is enabled.

adw_swipe_tracker_get_lower_overshoot

Gets whether to allow swiping past the first available snap point.

since: 1.4

adw_swipe_tracker_get_reversed

Gets whether self is reversing the swipe direction.

adw_swipe_tracker_get_swipeable

Get the widget self is attached to.

adw_swipe_tracker_get_upper_overshoot

Gets whether to allow swiping past the last available snap point.

since: 1.4

adw_swipe_tracker_set_allow_long_swipes

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

adw_swipe_tracker_set_allow_mouse_drag

Sets whether self can be dragged with mouse pointer.

adw_swipe_tracker_set_enabled

Sets whether self is enabled.

adw_swipe_tracker_set_lower_overshoot

Sets whether to allow swiping past the first available snap point.

since: 1.4

adw_swipe_tracker_set_reversed

Sets whether to reverse the swipe direction.

adw_swipe_tracker_set_upper_overshoot

Sets whether to allow swiping past the last available snap point.

since: 1.4

adw_swipe_tracker_shift_position

Moves the current progress value by delta.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkOrientable (2)
gtk_orientable_get_orientation

Retrieves the orientation of the orientable.

gtk_orientable_set_orientation

Sets the orientation of the orientable.

Properties

Adw.SwipeTracker:allow-long-swipes

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

Adw.SwipeTracker:allow-mouse-drag

Whether to allow dragging with mouse pointer.

Adw.SwipeTracker:enabled

Whether the swipe tracker is enabled.

Adw.SwipeTracker:lower-overshoot

Whether to allow swiping past the first available snap point.

since: 1.4

Adw.SwipeTracker:reversed

Whether to reverse the swipe direction.

Adw.SwipeTracker:swipeable

The widget the swipe tracker is attached to.

Adw.SwipeTracker:upper-overshoot

Whether to allow swiping past the last available snap point.

since: 1.4

Properties inherited from GtkOrientable (1)
Gtk.Orientable:orientation

The orientation of the orientable.

Signals

Adw.SwipeTracker::begin-swipe

This signal is emitted right before a swipe will be started, after the drag threshold has been passed.

Adw.SwipeTracker::end-swipe

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

Adw.SwipeTracker::prepare

This signal is emitted when a possible swipe is detected.

Adw.SwipeTracker::update-swipe

This signal is emitted every time the progress value changes.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct AdwSwipeTrackerClass {
  GObjectClass parent_class;
  
}

No description available.

Class members
parent_class: GObjectClass

No description available.