Package org.gnome.gtk

Class GestureSingle

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

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

DragSource, GestureClick, GestureDrag, GestureLongPress, GestureStylus, GestureSwipe

@Generated("io.github.jwharm.JavaGI")
public class GestureSingle
extends Gesture

A GtkGesture subclass optimized for singe-touch and mouse gestures.

Under interaction, these gestures stick to the first interacting sequence, which is accessible through getCurrentSequence() while the gesture is being interacted with.

By default gestures react to both GDK_BUTTON_PRIMARY and touch events. setTouchOnly(boolean) can be used to change the touch behavior. Callers may also specify a different mouse button number to interact with through setButton(int), or react to any mouse button by setting it to 0. While the gesture is active, the button being currently pressed can be known through getCurrentButton().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GestureSingle.Builder<B extends GestureSingle.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	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
GestureSingle()	Creates a new GestureSingle.
GestureSingle(MemorySegment address)	Create a GestureSingle proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected GestureSingle	asParent()	Returns this instance as if it were its parent type.
static GestureSingle.Builder<? extends GestureSingle.Builder>	builder()	A GestureSingle.Builder object constructs a GestureSingle with the specified properties.
int	getButton()	Returns the button number this GestureSingle listens for.
int	getCurrentButton()	Returns the button number currently interacting with gesture, or 0 if there is none.
@Nullable EventSequence	getCurrentSequence()	Returns the event sequence currently interacting with gesture.
boolean	getExclusive()	Gets whether a gesture is exclusive.
boolean	getTouchOnly()	Returns true if the gesture is only triggered by touch events.
static @Nullable Type	getType()	Get the GType of the GestureSingle class
void	setButton(int button)	Sets the button number this GestureSingle listens to.
void	setExclusive(boolean exclusive)	Sets whether this GestureSingle is exclusive.
void	setTouchOnly(boolean touchOnly)	Sets whether to handle only touch events.

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

GestureSingle

public GestureSingle(MemorySegment address)

Create a GestureSingle proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

GestureSingle

public GestureSingle()

Creates a new GestureSingle.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the GestureSingle class

Returns:

the GType

asParent

protected GestureSingle 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 Gesture

getButton

public int getButton()

Returns the button number this GestureSingle listens for.

If this is 0, the gesture reacts to any button press.

Returns:

The button number, or 0 for any button

getCurrentButton

public int getCurrentButton()

Returns the button number currently interacting with gesture, or 0 if there is none.

Returns:

The current button number

getCurrentSequence

public @Nullable EventSequence getCurrentSequence()

Returns the event sequence currently interacting with gesture.

This is only meaningful if Gesture.isActive() returns true.

Returns:

the current sequence

getExclusive

public boolean getExclusive()

Gets whether a gesture is exclusive.

For more information, see setExclusive(boolean).

Returns:

Whether the gesture is exclusive

getTouchOnly

public boolean getTouchOnly()

Returns true if the gesture is only triggered by touch events.

Returns:

true if the gesture only handles touch events

setButton

public void setButton(int button)

Sets the button number this GestureSingle listens to.

If non-0, every button press from a different button number will be ignored. Touch events implicitly match with button 1.

Parameters:

button - button number to listen to, or 0 for any button

setExclusive

public void setExclusive(boolean exclusive)

Sets whether this GestureSingle is exclusive.

An exclusive gesture will only handle pointer and "pointer emulated" touch events, so at any given time, there is only one sequence able to interact with those.

Parameters:

exclusive - true to make this GestureSingle exclusive

setTouchOnly

public void setTouchOnly(boolean touchOnly)

Sets whether to handle only touch events.

If touchOnly is true, this GestureSingle will only handle events of type EventType.TOUCH_BEGIN, EventType.TOUCH_UPDATE or EventType.TOUCH_END. If false, mouse events will be handled too.

Parameters:

touchOnly - whether this GestureSingle handles only touch events

builder

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

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

Returns:

the builder object