Package org.gnome.gtk

Class GesturePan

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.GestureDrag

org.gnome.gtk.GesturePan

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class GesturePan
extends GestureDrag

Recognizes pan gestures.

These are drags that are locked to happen along one axis. The axis that a GtkGesturePan handles is defined at construct time, and can be changed through setOrientation(org.gnome.gtk.Orientation).

When the gesture starts to be recognized, GtkGesturePan will attempt to determine as early as possible whether the sequence is moving in the expected direction, and denying the sequence if this does not happen.

Once a panning gesture along the expected axis is recognized, the Gtk.GesturePan::pan signal will be emitted as input events are received, containing the offset in the given axis.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.gnome.gtk.GestureDrag

GestureDrag.DragBeginCallback, GestureDrag.DragEndCallback, GestureDrag.DragUpdateCallback, GestureDrag.GestureDragClass

Nested classes/interfaces inherited from class org.gnome.gtk.GestureSingle

GestureSingle.GestureSingleClass

Nested classes/interfaces inherited from class org.gnome.gtk.Gesture

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

Nested classes/interfaces inherited from class org.gnome.gtk.EventController

EventController.EventController$Impl, EventController.EventControllerClass

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
GesturePan()	Creates a new GesturePan.
GesturePan(MemorySegment address)	Create a GesturePan proxy instance for the provided memory address.
GesturePan(Orientation orientation)	Returns a newly created GtkGesture that recognizes pan gestures.

Method Summary

Modifier and Type	Method	Description
protected GesturePan	asParent()	Returns this instance as if it were its parent type.
static GesturePan.Builder<? extends GesturePan.Builder>	builder()	A GesturePan.Builder object constructs a GesturePan with the specified properties.
void	emitPan(PanDirection direction, double offset)	Emits the "pan" signal.
Orientation	getOrientation()	Returns the orientation of the pan gestures that this this GesturePan expects.
static @Nullable Type	getType()	Get the GType of the GesturePan class
SignalConnection<GesturePan.PanCallback>	onPan(GesturePan.PanCallback handler)	Emitted once a panning gesture along the expected axis is detected.
void	setOrientation(Orientation orientation)	Sets the orientation to be expected on pan gestures.

Methods inherited from class org.gnome.gtk.GestureDrag

emitDragBegin, emitDragEnd, emitDragUpdate, getOffset, getStartPoint, onDragBegin, onDragEnd, onDragUpdate

Methods inherited from class org.gnome.gtk.GestureSingle

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

Methods inherited from class org.gnome.gtk.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 org.gnome.gtk.EventController

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

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

Constructor Details

GesturePan

public GesturePan(MemorySegment address)

Create a GesturePan proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

GesturePan

public GesturePan(Orientation orientation)

Returns a newly created GtkGesture that recognizes pan gestures.

Parameters:

orientation - expected orientation

GesturePan

public GesturePan()

Creates a new GesturePan.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the GesturePan class

Returns:

the GType

asParent

protected GesturePan 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 GestureDrag

getOrientation

public Orientation getOrientation()

Returns the orientation of the pan gestures that this this GesturePan expects.

Returns:

the expected orientation for pan gestures

setOrientation

public void setOrientation(Orientation orientation)

Sets the orientation to be expected on pan gestures.

Parameters:

orientation - expected orientation

onPan

public SignalConnection<GesturePan.PanCallback> onPan(GesturePan.PanCallback handler)

Emitted once a panning gesture along the expected axis is detected.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GesturePan.PanCallback.run(org.gnome.gtk.PanDirection, double)

emitPan

public void emitPan(PanDirection direction,
 double offset)

Emits the "pan" signal. See onPan(org.gnome.gtk.GesturePan.PanCallback).

builder

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

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

Returns:

the builder object