Class GestureClick

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

All Implemented Interfaces:

Proxy

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

Recognizes click gestures.

It is able to recognize multiple clicks on a nearby zone, which can be listened for through the Gtk.GestureClick::pressed signal. Whenever time or distance between clicks exceed the GTK defaults, Gtk.GestureClick::stopped is emitted, and the click counter is reset.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GestureClick.Builder<B extends GestureClick.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	GestureClick.GestureClickClass
static interface	GestureClick.PressedCallback	Functional interface declaration of the PressedCallback callback.
static interface	GestureClick.ReleasedCallback	Functional interface declaration of the ReleasedCallback callback.
static interface	GestureClick.StoppedCallback	Functional interface declaration of the StoppedCallback callback.
static interface	GestureClick.UnpairedReleaseCallback	Functional interface declaration of the UnpairedReleaseCallback 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
GestureClick()	Create a new GestureClick.
GestureClick(MemorySegment address)	Create a GestureClick instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected GestureClick	asParent()	Return this instance as if it were its parent type.
static GestureClick.Builder<? extends GestureClick.Builder>	builder()	A GestureClick.Builder object constructs a GestureClick with the specified properties.
void	emitPressed(int nPress, double x, double y)	Emits the "pressed" signal.
void	emitReleased(int nPress, double x, double y)	Emits the "released" signal.
void	emitStopped()	Emits the "stopped" signal.
void	emitUnpairedRelease(double x, double y, int button, @Nullable EventSequence sequence)	Emits the "unpaired-release" signal.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the GestureClick class.
SignalConnection<GestureClick.PressedCallback>	onPressed(GestureClick.PressedCallback handler)	Emitted whenever a button or touch press happens.
SignalConnection<GestureClick.ReleasedCallback>	onReleased(GestureClick.ReleasedCallback handler)	Emitted when a button or touch is released.
SignalConnection<GestureClick.StoppedCallback>	onStopped(GestureClick.StoppedCallback handler)	Emitted whenever any time/distance threshold has been exceeded.
SignalConnection<GestureClick.UnpairedReleaseCallback>	onUnpairedRelease(GestureClick.UnpairedReleaseCallback handler)	Emitted whenever the gesture receives a release event that had no previous corresponding press.

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

GestureClick

public GestureClick(MemorySegment address)

Create a GestureClick instance for the provided memory address.

Parameters:

address - the memory address of the native object

GestureClick

public GestureClick()

Create a new GestureClick.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the GestureClick class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

onPressed

public SignalConnection<GestureClick.PressedCallback> onPressed(GestureClick.PressedCallback handler)

Emitted whenever a button or touch press happens.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureClick.PressedCallback.run(int, double, double)

emitPressed

public void emitPressed(int nPress,
 double x,
 double y)

Emits the "pressed" signal. See onPressed(GestureClick.PressedCallback).

onReleased

public SignalConnection<GestureClick.ReleasedCallback> onReleased(GestureClick.ReleasedCallback handler)

Emitted when a button or touch is released.

nPress will report the number of press that is paired to this event, note that Gtk.GestureClick::stopped may have been emitted between the press and its release, nPress will only start over at the next press.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureClick.ReleasedCallback.run(int, double, double)

emitReleased

public void emitReleased(int nPress,
 double x,
 double y)

Emits the "released" signal. See onReleased(GestureClick.ReleasedCallback).

onStopped

public SignalConnection<GestureClick.StoppedCallback> onStopped(GestureClick.StoppedCallback handler)

Emitted whenever any time/distance threshold has been exceeded.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureClick.StoppedCallback.run()

emitStopped

public void emitStopped()

Emits the "stopped" signal. See onStopped(GestureClick.StoppedCallback).

onUnpairedRelease

public SignalConnection<GestureClick.UnpairedReleaseCallback> onUnpairedRelease(GestureClick.UnpairedReleaseCallback handler)

Emitted whenever the gesture receives a release event that had no previous corresponding press.

Due to implicit grabs, this can only happen on situations where input is grabbed elsewhere mid-press or the pressed widget voluntarily relinquishes its implicit grab.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureClick.UnpairedReleaseCallback.run(double, double, int, EventSequence)

emitUnpairedRelease

public void emitUnpairedRelease(double x,
 double y,
 int button,
 @Nullable EventSequence sequence)

Emits the "unpaired-release" signal. See onUnpairedRelease(GestureClick.UnpairedReleaseCallback).

builder

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

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

Returns:

the builder object