adw.swipe_tracker

Module for [SwipeTracker] class

class SwipeTracker SwipeTrackerGidBuilder SwipeTrackerGidBuilderImpl

Types 3

classSwipeTracker : gobject.object.ObjectWrap, gtk.orientable.Orientable

A swipe tracker used in adw.carousel.Carousel, adw.navigation_view.NavigationView and adw.overlay_split_view.OverlaySplitView.

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

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

SwipeTracker self() nothrowReturns `this`, for use in `with` statements.

SwipeTrackerGidBuilder builder() static nothrowGet builder for [adw.swipe_tracker.SwipeTracker] Returns: New builder object

bool allowLongSwipes() @property nothrowGet `allowLongSwipes` property. Returns: Whether to allow swiping for more than one snap point at a time.

void allowLongSwipes(bool propval) @property nothrowSet `allowLongSwipes` property. Params: propval = Whether to allow swiping for more than one snap point at a time.

bool allowMouseDrag() @property nothrowGet `allowMouseDrag` property. Returns: Whether to allow dragging with mouse pointer.

void allowMouseDrag(bool propval) @property nothrowSet `allowMouseDrag` property. Params: propval = Whether to allow dragging with mouse pointer.

bool allowWindowHandle() @property nothrowGet `allowWindowHandle` property. Returns: Whether to allow touchscreen swiping from [gtk.window_handle.WindowHandle].

void allowWindowHandle(bool propval) @property nothrowSet `allowWindowHandle` property. Params: propval = Whether to allow touchscreen swiping from [gtk.window_handle.WindowHandle].

bool enabled() @property nothrowGet `enabled` property. Returns: Whether the swipe tracker is enabled.

void enabled(bool propval) @property nothrowSet `enabled` property. Params: propval = Whether the swipe tracker is enabled.

bool lowerOvershoot() @property nothrowGet `lowerOvershoot` property. Returns: Whether to allow swiping past the first available snap point.

void lowerOvershoot(bool propval) @property nothrowSet `lowerOvershoot` property. Params: propval = Whether to allow swiping past the first available snap point.

bool reversed() @property nothrowGet `reversed` property. Returns: Whether to reverse the swipe direction.

void reversed(bool propval) @property nothrowSet `reversed` property. Params: propval = Whether to reverse the swipe direction.

adw.swipeable.Swipeable swipeable() @property nothrowGet `swipeable` property. Returns: The widget the swipe tracker is attached to.

bool upperOvershoot() @property nothrowGet `upperOvershoot` property. Returns: Whether to allow swiping past the last available snap point.

void upperOvershoot(bool propval) @property nothrowSet `upperOvershoot` property. Params: propval = Whether to allow swiping past the last available snap point.

bool getAllowLongSwipes() nothrowGets whether to allow swiping for more than one snap point at a time. Returns: whether long swipes are allowed

bool getAllowMouseDrag() nothrowGets whether self can be dragged with mouse pointer. Returns: whether mouse dragging is allowed

bool getAllowWindowHandle() nothrowGets whether to allow touchscreen swiping from [gtk.window_handle.WindowHandle]. Returns: whether swiping from window handles is allowed

bool getEnabled() nothrowGets whether self is enabled. Returns: whether self is enabled

bool getLowerOvershoot() nothrowGets whether to allow swiping past the first available snap point. Returns: whether to allow swiping past the first available snap point

bool getReversed() nothrowGets whether self is reversing the swipe direction. Returns: whether the direction is reversed

adw.swipeable.Swipeable getSwipeable() nothrowGet the widget self is attached to. Returns: the swipeable widget

bool getUpperOvershoot() nothrowGets whether to allow swiping past the last available snap point. Returns: whether to allow swiping past the last available snap point

void setAllowLongSwipes(bool allowLongSwipes) nothrowSets whether to allow swiping for more than one snap point at a time.

void setAllowMouseDrag(bool allowMouseDrag) nothrowSets whether self can be dragged with mouse pointer.

void setAllowWindowHandle(bool allowWindowHandle) nothrowSets whether to allow touchscreen swiping from [gtk.window_handle.WindowHandle].

void setEnabled(bool enabled) nothrowSets whether self is enabled.

void setLowerOvershoot(bool overshoot) nothrowSets whether to allow swiping past the first available snap point.

void setReversed(bool reversed) nothrowSets whether to reverse the swipe direction.

void setUpperOvershoot(bool overshoot) nothrowSets whether to allow swiping past the last available snap point.

void shiftPosition(double delta) nothrowMoves the current progress value by delta.

gulong connectBeginSwipe(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  adw.swipe_tracker.SwipeTracker)))
   &&  Parameters!T.length <  2)

nothrowConnect to `BeginSwipe` signal.

gulong connectEndSwipe(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  double)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  double)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2] :  adw.swipe_tracker.SwipeTracker)))
   &&  Parameters!T.length <  4)

nothrowConnect to `EndSwipe` signal.

gulong connectPrepare(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  adw.types.NavigationDirection)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  adw.swipe_tracker.SwipeTracker)))
   &&  Parameters!T.length <  3)

nothrowConnect to `Prepare` signal.

gulong connectUpdateSwipe(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  double)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1] :  adw.swipe_tracker.SwipeTracker)))
   &&  Parameters!T.length <  3)

nothrowConnect to `UpdateSwipe` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this(adw.swipeable.Swipeable swipeable)Creates a new [adw.swipe_tracker.SwipeTracker] for widget.

classSwipeTrackerGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T, gtk.orientable.OrientableGidBuilderImpl!T

Fluent builder implementation template for adw.swipe_tracker.SwipeTracker

Methods

T allowLongSwipes(bool propval) nothrowSet `allowLongSwipes` property. Params: propval = Whether to allow swiping for more than one snap point at a time.

T allowMouseDrag(bool propval) nothrowSet `allowMouseDrag` property. Params: propval = Whether to allow dragging with mouse pointer. Returns: Builder instance for fluent chaining

T allowWindowHandle(bool propval) nothrowSet `allowWindowHandle` property. Params: propval = Whether to allow touchscreen swiping from [gtk.window_handle.WindowHandle].

T enabled(bool propval) nothrowSet `enabled` property. Params: propval = Whether the swipe tracker is enabled.

T lowerOvershoot(bool propval) nothrowSet `lowerOvershoot` property. Params: propval = Whether to allow swiping past the first available snap point. Returns: Builder instance for fluent chaining

T reversed(bool propval) nothrowSet `reversed` property. Params: propval = Whether to reverse the swipe direction.

T swipeable(adw.swipeable.Swipeable propval) nothrowSet `swipeable` property. Params: propval = The widget the swipe tracker is attached to. Returns: Builder instance for fluent chaining

T upperOvershoot(bool propval) nothrowSet `upperOvershoot` property. Params: propval = Whether to allow swiping past the last available snap point. Returns: Builder instance for fluent chaining

classSwipeTrackerGidBuilder : SwipeTrackerGidBuilderImpl!SwipeTrackerGidBuilder

Fluent builder for adw.swipe_tracker.SwipeTracker

Methods

SwipeTracker build() nothrowCreate object from builder. Returns: New object