Class GestureSwipe

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.EventController

org.gnome.gtk.Gesture

org.gnome.gtk.GestureSingle

org.gnome.gtk.GestureSwipe

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class GestureSwipe
extends GestureSingle

Recognizes swipe gestures.

After a press/move/.../move/release sequence happens, the Gtk.GestureSwipe::swipe signal will be emitted, providing the velocity and directionality of the sequence at the time it was lifted.

If the velocity is desired in intermediate points, getVelocity(Out, Out) can be called in a Gtk.Gesture::update handler.

All velocities are reported in pixels/sec units.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GestureSwipe.Builder<B extends GestureSwipe.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	GestureSwipe.GestureSwipeClass
static interface	GestureSwipe.SwipeCallback	Functional interface declaration of the SwipeCallback callback.

Nested classes/interfaces inherited from class GestureSingle

GestureSingle.GestureSingleClass

Nested classes/interfaces inherited from class Gesture

Gesture.BeginCallback, Gesture.CancelCallback, Gesture.EndCallback, Gesture.Gesture$Impl, Gesture.GestureClass, Gesture.SequenceStateChangedCallback, Gesture.UpdateCallback

Nested classes/interfaces inherited from class EventController

EventController.EventController$Impl, EventController.EventControllerClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
GestureSwipe()	Create a new GestureSwipe.
GestureSwipe(MemorySegment address)	Create a GestureSwipe instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected GestureSwipe	asParent()	Return this instance as if it were its parent type.
static GestureSwipe.Builder<? extends GestureSwipe.Builder>	builder()	A GestureSwipe.Builder object constructs a GestureSwipe with the specified properties.
void	emitSwipe(double velocityX, double velocityY)	Emits the "swipe" signal.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the GestureSwipe class.
boolean	getVelocity(Out<Double> velocityX, Out<Double> velocityY)	Gets the current velocity.
SignalConnection<GestureSwipe.SwipeCallback>	onSwipe(GestureSwipe.SwipeCallback handler)	Emitted when the recognized gesture is finished.

Methods inherited from class GestureSingle

getButton, getCurrentButton, getCurrentSequence, getExclusive, getTouchOnly, setButton, setExclusive, setTouchOnly

Methods inherited from class Gesture

emitBegin, emitCancel, emitEnd, emitSequenceStateChanged, emitUpdate, getBoundingBox, getBoundingBoxCenter, getDevice, getGroup, getLastEvent, getLastUpdatedSequence, getPoint, getSequences, getSequenceState, group, handlesSequence, isActive, isGroupedWith, isRecognized, onBegin, onCancel, onEnd, onSequenceStateChanged, onUpdate, setSequenceState, setState, ungroup

Methods inherited from class EventController

getCurrentEvent, getCurrentEventDevice, getCurrentEventState, getCurrentEventTime, getName, getPropagationLimit, getPropagationPhase, getWidget, reset, setName, setPropagationLimit, setPropagationPhase, setStaticName

Methods inherited from class 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, 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 TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

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

Constructor Details

GestureSwipe

public GestureSwipe(MemorySegment address)

Create a GestureSwipe instance for the provided memory address.

Parameters:

address - the memory address of the native object

GestureSwipe

public GestureSwipe()

Create a new GestureSwipe.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the GestureSwipe class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected GestureSwipe asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class GestureSingle

Returns:

the instance as if it were its parent type

getVelocity

public boolean getVelocity(Out<Double> velocityX,
 Out<Double> velocityY)

Gets the current velocity.

If the gesture is recognized, this function returns true and fills in velocityX and velocityY with the recorded velocity, as per the last events processed.

Parameters:

velocityX - return value for the velocity in the X axis, in pixels/sec

velocityY - return value for the velocity in the Y axis, in pixels/sec

Returns:

whether velocity could be calculated

onSwipe

public SignalConnection<GestureSwipe.SwipeCallback> onSwipe(GestureSwipe.SwipeCallback handler)

Emitted when the recognized gesture is finished.

Velocity and direction are a product of previously recorded events.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureSwipe.SwipeCallback.run(double, double)

emitSwipe

public void emitSwipe(double velocityX,
 double velocityY)

Emits the "swipe" signal. See onSwipe(GestureSwipe.SwipeCallback).

builder

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

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

Returns:

the builder object