Package org.gnome.adw

Class SwipeTracker

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.adw.SwipeTracker

All Implemented Interfaces:

Orientable, Proxy

@Generated("io.github.jwharm.JavaGI")
public final class SwipeTracker
extends GObject
implements Orientable

A swipe tracker used in Carousel, NavigationView and 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 SwipeTracker:enabled property. If they expect to use horizontal orientation, SwipeTracker:reversed can be used for supporting RTL text direction.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SwipeTracker.BeginSwipeCallback	Functional interface declaration of the BeginSwipeCallback callback.
static class	SwipeTracker.Builder<B extends SwipeTracker.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	SwipeTracker.EndSwipeCallback	Functional interface declaration of the EndSwipeCallback callback.
static interface	SwipeTracker.PrepareCallback	Functional interface declaration of the PrepareCallback callback.
static class	SwipeTracker.SwipeTrackerClass
static interface	SwipeTracker.UpdateSwipeCallback	Functional interface declaration of the UpdateSwipeCallback callback.

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Orientable

Orientable.Orientable$Impl, Orientable.OrientableIface

Constructor Summary

Constructors

Constructor	Description
SwipeTracker()	Creates a new SwipeTracker.
SwipeTracker(MemorySegment address)	Create a SwipeTracker proxy instance for the provided memory address.
SwipeTracker(Swipeable swipeable)	Creates a new AdwSwipeTracker for widget.

Method Summary

Modifier and Type	Method	Description
protected SwipeTracker	asParent()	Returns this instance as if it were its parent type.
static SwipeTracker.Builder<? extends SwipeTracker.Builder>	builder()	A SwipeTracker.Builder object constructs a SwipeTracker with the specified properties.
void	emitBeginSwipe()	Emits the "begin-swipe" signal.
void	emitEndSwipe(double velocity, double to)	Emits the "end-swipe" signal.
void	emitPrepare(NavigationDirection direction)	Emits the "prepare" signal.
void	emitUpdateSwipe(double progress)	Emits the "update-swipe" signal.
boolean	getAllowLongSwipes()	Gets whether to allow swiping for more than one snap point at a time.
boolean	getAllowMouseDrag()	Gets whether this SwipeTracker can be dragged with mouse pointer.
boolean	getAllowWindowHandle()	Gets whether to allow touchscreen swiping from GtkWindowHandle.
boolean	getEnabled()	Gets whether this SwipeTracker is enabled.
boolean	getLowerOvershoot()	Gets whether to allow swiping past the first available snap point.
boolean	getReversed()	Gets whether this SwipeTracker is reversing the swipe direction.
Swipeable	getSwipeable()	Get the widget this SwipeTracker is attached to.
static @Nullable Type	getType()	Get the GType of the SwipeTracker class
boolean	getUpperOvershoot()	Gets whether to allow swiping past the last available snap point.
SignalConnection<SwipeTracker.BeginSwipeCallback>	onBeginSwipe(SwipeTracker.BeginSwipeCallback handler)	This signal is emitted right before a swipe will be started, after the drag threshold has been passed.
SignalConnection<SwipeTracker.EndSwipeCallback>	onEndSwipe(SwipeTracker.EndSwipeCallback handler)	This signal is emitted as soon as the gesture has stopped.
SignalConnection<SwipeTracker.PrepareCallback>	onPrepare(SwipeTracker.PrepareCallback handler)	This signal is emitted when a possible swipe is detected.
SignalConnection<SwipeTracker.UpdateSwipeCallback>	onUpdateSwipe(SwipeTracker.UpdateSwipeCallback handler)	This signal is emitted every time the progress value changes.
void	setAllowLongSwipes(boolean allowLongSwipes)	Sets whether to allow swiping for more than one snap point at a time.
void	setAllowMouseDrag(boolean allowMouseDrag)	Sets whether this SwipeTracker can be dragged with mouse pointer.
void	setAllowWindowHandle(boolean allowWindowHandle)	Sets whether to allow touchscreen swiping from GtkWindowHandle.
void	setEnabled(boolean enabled)	Sets whether this SwipeTracker is enabled.
void	setLowerOvershoot(boolean overshoot)	Sets whether to allow swiping past the first available snap point.
void	setReversed(boolean reversed)	Sets whether to reverse the swipe direction.
void	setUpperOvershoot(boolean overshoot)	Sets whether to allow swiping past the last available snap point.
void	shiftPosition(double delta)	Moves the current progress value by delta.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Orientable

getOrientation, setOrientation

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

SwipeTracker

public SwipeTracker(MemorySegment address)

Create a SwipeTracker proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SwipeTracker

public SwipeTracker(Swipeable swipeable)

Creates a new AdwSwipeTracker for widget.

Parameters:

swipeable - a widget to add the tracker on

SwipeTracker

public SwipeTracker()

Creates a new SwipeTracker.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the SwipeTracker class

Returns:

the GType

asParent

protected SwipeTracker asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getAllowLongSwipes

public boolean getAllowLongSwipes()

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

Returns:

whether long swipes are allowed

getAllowMouseDrag

public boolean getAllowMouseDrag()

Gets whether this SwipeTracker can be dragged with mouse pointer.

Returns:

whether mouse dragging is allowed

getAllowWindowHandle

public boolean getAllowWindowHandle()

Gets whether to allow touchscreen swiping from GtkWindowHandle.

Returns:

whether swiping from window handles is allowed

Since:

1.5

getEnabled

public boolean getEnabled()

Gets whether this SwipeTracker is enabled.

Returns:

whether this SwipeTracker is enabled

getLowerOvershoot

public boolean getLowerOvershoot()

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

Returns:

whether to allow swiping past the first available snap point

Since:

1.4

getReversed

public boolean getReversed()

Gets whether this SwipeTracker is reversing the swipe direction.

Returns:

whether the direction is reversed

getSwipeable

public Swipeable getSwipeable()

Get the widget this SwipeTracker is attached to.

Returns:

the swipeable widget

getUpperOvershoot

public boolean getUpperOvershoot()

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

Returns:

whether to allow swiping past the last available snap point

Since:

1.4

setAllowLongSwipes

public void setAllowLongSwipes(boolean allowLongSwipes)

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.

Parameters:

allowLongSwipes - whether to allow long swipes

setAllowMouseDrag

public void setAllowMouseDrag(boolean allowMouseDrag)

Sets whether this SwipeTracker can be dragged with mouse pointer.

Parameters:

allowMouseDrag - whether to allow mouse dragging

setAllowWindowHandle

public void setAllowWindowHandle(boolean allowWindowHandle)

Sets whether to allow touchscreen swiping from GtkWindowHandle.

Setting it to TRUE will make dragging the window impossible.

Parameters:

allowWindowHandle - whether to allow swiping from window handles

Since:

1.5

setEnabled

public void setEnabled(boolean enabled)

Sets whether this SwipeTracker is enabled.

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

Parameters:

enabled - whether this SwipeTracker is enabled

setLowerOvershoot

public void setLowerOvershoot(boolean overshoot)

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

Parameters:

overshoot - whether to allow swiping past the first available snap point

Since:

1.4

setReversed

public void setReversed(boolean reversed)

Sets whether to reverse the swipe direction.

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

Parameters:

reversed - whether to reverse the swipe direction

setUpperOvershoot

public void setUpperOvershoot(boolean overshoot)

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

Parameters:

overshoot - whether to allow swiping past the last available snap point

Since:

1.4

shiftPosition

public void shiftPosition(double delta)

Moves the current progress value by delta.

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

Parameters:

delta - the position delta

onBeginSwipe

public SignalConnection<SwipeTracker.BeginSwipeCallback> onBeginSwipe(SwipeTracker.BeginSwipeCallback handler)

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

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SwipeTracker.BeginSwipeCallback.run()

emitBeginSwipe

public void emitBeginSwipe()

Emits the "begin-swipe" signal. See onBeginSwipe(org.gnome.adw.SwipeTracker.BeginSwipeCallback).

onEndSwipe

public SignalConnection<SwipeTracker.EndSwipeCallback> onEndSwipe(SwipeTracker.EndSwipeCallback handler)

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

The user is expected to animate the deceleration from the current progress value to to with an animation using velocity as the initial velocity, provided in pixels per second. SpringAnimation is usually a good fit for this.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SwipeTracker.EndSwipeCallback.run(double, double)

emitEndSwipe

public void emitEndSwipe(double velocity,
 double to)

Emits the "end-swipe" signal. See onEndSwipe(org.gnome.adw.SwipeTracker.EndSwipeCallback).

onPrepare

public SignalConnection<SwipeTracker.PrepareCallback> onPrepare(SwipeTracker.PrepareCallback handler)

This signal is emitted when a possible swipe is detected.

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

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SwipeTracker.PrepareCallback.run(org.gnome.adw.NavigationDirection)

emitPrepare

public void emitPrepare(NavigationDirection direction)

Emits the "prepare" signal. See onPrepare(org.gnome.adw.SwipeTracker.PrepareCallback).

onUpdateSwipe

public SignalConnection<SwipeTracker.UpdateSwipeCallback> onUpdateSwipe(SwipeTracker.UpdateSwipeCallback handler)

This signal is emitted every time the progress value changes.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• SwipeTracker.UpdateSwipeCallback.run(double)

emitUpdateSwipe

public void emitUpdateSwipe(double progress)

Emits the "update-swipe" signal. See onUpdateSwipe(org.gnome.adw.SwipeTracker.UpdateSwipeCallback).

builder

public static SwipeTracker.Builder<? extends SwipeTracker.Builder> builder()

A SwipeTracker.Builder object constructs a SwipeTracker with the specified properties. Use the various set...() methods to set properties, and finish construction with SwipeTracker.Builder.build().

Returns:

the builder object