Class GestureDrag

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

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

GesturePan

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

Recognizes drag gestures.

The drag operation itself can be tracked throughout the Gtk.GestureDrag::drag-begin, Gtk.GestureDrag::drag-update and Gtk.GestureDrag::drag-end signals, and the relevant coordinates can be extracted through getOffset(Out, Out) and getStartPoint(Out, Out).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GestureDrag.Builder<B extends GestureDrag.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	GestureDrag.DragBeginCallback	Functional interface declaration of the DragBeginCallback callback.
static interface	GestureDrag.DragEndCallback	Functional interface declaration of the DragEndCallback callback.
static interface	GestureDrag.DragUpdateCallback	Functional interface declaration of the DragUpdateCallback callback.
static class	GestureDrag.GestureDragClass

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
GestureDrag()	Create a new GestureDrag.
GestureDrag(MemorySegment address)	Create a GestureDrag instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected GestureDrag	asParent()	Return this instance as if it were its parent type.
static GestureDrag.Builder<? extends GestureDrag.Builder>	builder()	A GestureDrag.Builder object constructs a GestureDrag with the specified properties.
void	emitDragBegin(double startX, double startY)	Emits the "drag-begin" signal.
void	emitDragEnd(double offsetX, double offsetY)	Emits the "drag-end" signal.
void	emitDragUpdate(double offsetX, double offsetY)	Emits the "drag-update" signal.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getOffset(@Nullable Out<Double> x, @Nullable Out<Double> y)	Gets the offset from the start point.
boolean	getStartPoint(@Nullable Out<Double> x, @Nullable Out<Double> y)	Gets the point where the drag started.
static @Nullable Type	getType()	Get the GType of the GestureDrag class.
SignalConnection<GestureDrag.DragBeginCallback>	onDragBegin(GestureDrag.DragBeginCallback handler)	Emitted whenever dragging starts.
SignalConnection<GestureDrag.DragEndCallback>	onDragEnd(GestureDrag.DragEndCallback handler)	Emitted whenever the dragging is finished.
SignalConnection<GestureDrag.DragUpdateCallback>	onDragUpdate(GestureDrag.DragUpdateCallback handler)	Emitted whenever the dragging point moves.

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

GestureDrag

public GestureDrag(MemorySegment address)

Create a GestureDrag instance for the provided memory address.

Parameters:

address - the memory address of the native object

GestureDrag

public GestureDrag()

Create a new GestureDrag.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the GestureDrag class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

getOffset

public boolean getOffset(@Nullable Out<Double> x,
 @Nullable Out<Double> y)

Gets the offset from the start point.

If the this GestureDrag is active, this function returns true and fills in x and y with the coordinates of the current point, as an offset to the starting drag point.

Parameters:

x - X offset for the current point

y - Y offset for the current point

Returns:

true if the gesture is active

getStartPoint

public boolean getStartPoint(@Nullable Out<Double> x,
 @Nullable Out<Double> y)

Gets the point where the drag started.

If the this GestureDrag is active, this function returns true and fills in x and y with the drag start coordinates, in widget-relative coordinates.

Parameters:

x - X coordinate for the drag start point

y - Y coordinate for the drag start point

Returns:

true if the gesture is active

onDragBegin

public SignalConnection<GestureDrag.DragBeginCallback> onDragBegin(GestureDrag.DragBeginCallback handler)

Emitted whenever dragging starts.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureDrag.DragBeginCallback.run(double, double)

emitDragBegin

public void emitDragBegin(double startX,
 double startY)

Emits the "drag-begin" signal. See onDragBegin(GestureDrag.DragBeginCallback).

onDragEnd

public SignalConnection<GestureDrag.DragEndCallback> onDragEnd(GestureDrag.DragEndCallback handler)

Emitted whenever the dragging is finished.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureDrag.DragEndCallback.run(double, double)

emitDragEnd

public void emitDragEnd(double offsetX,
 double offsetY)

Emits the "drag-end" signal. See onDragEnd(GestureDrag.DragEndCallback).

onDragUpdate

public SignalConnection<GestureDrag.DragUpdateCallback> onDragUpdate(GestureDrag.DragUpdateCallback handler)

Emitted whenever the dragging point moves.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureDrag.DragUpdateCallback.run(double, double)

emitDragUpdate

public void emitDragUpdate(double offsetX,
 double offsetY)

Emits the "drag-update" signal. See onDragUpdate(GestureDrag.DragUpdateCallback).

builder

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

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

Returns:

the builder object