adwaita/org.gtkkn.bindings.adw/SwipeTracker

SwipeTracker

class SwipeTracker(val adwSwipeTrackerPointer: <Error class: unknown class><<Error class: unknown class>>)(source)

A swipe tracker used in class@Carousel, class@NavigationView and class@OverlaySplitView.

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

Constructors

SwipeTracker

constructor(swipeable: Swipeable)

Creates a new AdwSwipeTracker for @widget.

constructor(adwSwipeTrackerPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

adwSwipeTrackerPointer

val adwSwipeTrackerPointer: <Error class: unknown class><<Error class: unknown class>>

allowLongSwipes

var allowLongSwipes: Boolean

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

allowMouseDrag

var allowMouseDrag: Boolean

Whether to allow dragging with mouse pointer.

allowWindowHandle

var allowWindowHandle: Boolean

Whether to allow touchscreen swiping from GtkWindowHandle.

enabled

var enabled: Boolean

Whether the swipe tracker is enabled.

gtkOrientablePointer

open val gtkOrientablePointer: <Error class: unknown class><<Error class: unknown class>>

lowerOvershoot

var lowerOvershoot: Boolean

Whether to allow swiping past the first available snap point.

reversed

var reversed: Boolean

Whether to reverse the swipe direction.

swipeable

val swipeable: Swipeable

The widget the swipe tracker is attached to.

upperOvershoot

var upperOvershoot: Boolean

Whether to allow swiping past the last available snap point.

Functions

emitBeginSwipe

fun emitBeginSwipe()

Emits the "begin-swipe" signal. See onBeginSwipe.

emitEndSwipe

fun emitEndSwipe(velocity: <Error class: unknown class>, to: <Error class: unknown class>)

Emits the "end-swipe" signal. See onEndSwipe.

emitPrepare

fun emitPrepare(direction: NavigationDirection)

Emits the "prepare" signal. See onPrepare.

emitUpdateSwipe

fun emitUpdateSwipe(progress: <Error class: unknown class>)

Emits the "update-swipe" signal. See onUpdateSwipe.

onBeginSwipe

fun onBeginSwipe(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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

onEndSwipe

fun onEndSwipe(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>) -> Unit): <Error class: unknown class>

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

onPrepare

fun onPrepare(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (direction: NavigationDirection) -> Unit): <Error class: unknown class>

This signal is emitted when a possible swipe is detected.

onUpdateSwipe

fun onUpdateSwipe(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>) -> Unit): <Error class: unknown class>

This signal is emitted every time the progress value changes.

shiftPosition

fun shiftPosition(delta: <Error class: unknown class>)

Moves the current progress value by @delta.