Class GestureStylus

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

All Implemented Interfaces:

Proxy

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

Recognizes tablet stylus input.

The provided signals just relay the basic information of the stylus events.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GestureStylus.Builder<B extends GestureStylus.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	GestureStylus.DownCallback	Functional interface declaration of the DownCallback callback.
static class	GestureStylus.GestureStylusClass
static interface	GestureStylus.MotionCallback	Functional interface declaration of the MotionCallback callback.
static interface	GestureStylus.ProximityCallback	Functional interface declaration of the ProximityCallback callback.
static interface	GestureStylus.UpCallback	Functional interface declaration of the UpCallback 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
GestureStylus()	Create a new GestureStylus.
GestureStylus(MemorySegment address)	Create a GestureStylus instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected GestureStylus	asParent()	Return this instance as if it were its parent type.
static GestureStylus.Builder<? extends GestureStylus.Builder>	builder()	A GestureStylus.Builder object constructs a GestureStylus with the specified properties.
void	emitDown(double x, double y)	Emits the "down" signal.
void	emitMotion(double x, double y)	Emits the "motion" signal.
void	emitProximity(double x, double y)	Emits the "proximity" signal.
void	emitUp(double x, double y)	Emits the "up" signal.
boolean	getAxes(@Nullable AxisUse @Nullable [] axes, @Nullable double @Nullable [] values)	Returns the current values for the requested axes.
boolean	getAxis(AxisUse axis, Out<Double> value)	Returns the current value for the requested axis.
boolean	getBacklog(@Nullable Out<TimeCoord[]> backlog)	Returns the accumulated backlog of tracking information.
@Nullable DeviceTool	getDeviceTool()	Returns the GdkDeviceTool currently driving input through this gesture.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
boolean	getStylusOnly()	Checks whether the gesture is for styluses only.
static @Nullable Type	getType()	Get the GType of the GestureStylus class.
SignalConnection<GestureStylus.DownCallback>	onDown(GestureStylus.DownCallback handler)	Emitted when the stylus touches the device.
SignalConnection<GestureStylus.MotionCallback>	onMotion(GestureStylus.MotionCallback handler)	Emitted when the stylus moves while touching the device.
SignalConnection<GestureStylus.ProximityCallback>	onProximity(GestureStylus.ProximityCallback handler)	Emitted when the stylus is in proximity of the device.
SignalConnection<GestureStylus.UpCallback>	onUp(GestureStylus.UpCallback handler)	Emitted when the stylus no longer touches the device.
void	setStylusOnly(boolean stylusOnly)	Sets the state of stylus-only

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

GestureStylus

public GestureStylus(MemorySegment address)

Create a GestureStylus instance for the provided memory address.

Parameters:

address - the memory address of the native object

GestureStylus

public GestureStylus()

Create a new GestureStylus.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the GestureStylus class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

getAxes

public boolean getAxes(@Nullable AxisUse @Nullable [] axes,
 @Nullable double @Nullable [] values)

Returns the current values for the requested axes.

This function must be called from the handler of one of the Gtk.GestureStylus::down, Gtk.GestureStylus::motion, Gtk.GestureStylus::up or Gtk.GestureStylus::proximity signals.

Parameters:

axes - array of requested axes, terminated with AxisUse.IGNORE

values - return location for the axis values

Returns:

true if there is a current value for the axes

getAxis

public boolean getAxis(AxisUse axis,
 Out<Double> value)

Returns the current value for the requested axis.

This function must be called from the handler of one of the Gtk.GestureStylus::down, Gtk.GestureStylus::motion, Gtk.GestureStylus::up or Gtk.GestureStylus::proximity signals.

Parameters:

axis - requested device axis

value - return location for the axis value

Returns:

true if there is a current value for the axis

getBacklog

public boolean getBacklog(@Nullable Out<TimeCoord[]> backlog)

Returns the accumulated backlog of tracking information.

By default, GTK will limit rate of input events. On stylus input where accuracy of strokes is paramount, this function returns the accumulated coordinate/timing state before the emission of the current Gtk.GestureStylus::motion signal handler, the state given in this signal and obtainable through getAxis(AxisUse, Out) express the latest (most up-to-date) state in motion history.

The backlog is provided in chronological order.

Parameters:

backlog - coordinates and times for the backlog events

Returns:

true if there is a backlog to unfold in the current state.

getDeviceTool

public @Nullable DeviceTool getDeviceTool()

Returns the GdkDeviceTool currently driving input through this gesture.

This function must be called from the handler of one of the Gtk.GestureStylus::down, Gtk.GestureStylus::motion, Gtk.GestureStylus::up or Gtk.GestureStylus::proximity signals.

Returns:

The current stylus tool

getStylusOnly

public boolean getStylusOnly()

Checks whether the gesture is for styluses only.

Stylus-only gestures will signal events exclusively from stylus input devices.

Returns:

true if the gesture is only for stylus events

Since:

4.10

setStylusOnly

public void setStylusOnly(boolean stylusOnly)

Sets the state of stylus-only

If true, the gesture will exclusively handle events from stylus input devices, otherwise it'll handle events from any pointing device.

Parameters:

stylusOnly - whether the gesture is used exclusively for stylus events

Since:

4.10

onDown

public SignalConnection<GestureStylus.DownCallback> onDown(GestureStylus.DownCallback handler)

Emitted when the stylus touches the device.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureStylus.DownCallback.run(double, double)

emitDown

public void emitDown(double x,
 double y)

Emits the "down" signal. See onDown(GestureStylus.DownCallback).

onMotion

public SignalConnection<GestureStylus.MotionCallback> onMotion(GestureStylus.MotionCallback handler)

Emitted when the stylus moves while touching the device.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureStylus.MotionCallback.run(double, double)

emitMotion

public void emitMotion(double x,
 double y)

Emits the "motion" signal. See onMotion(GestureStylus.MotionCallback).

onProximity

public SignalConnection<GestureStylus.ProximityCallback> onProximity(GestureStylus.ProximityCallback handler)

Emitted when the stylus is in proximity of the device.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureStylus.ProximityCallback.run(double, double)

emitProximity

public void emitProximity(double x,
 double y)

Emits the "proximity" signal. See onProximity(GestureStylus.ProximityCallback).

onUp

public SignalConnection<GestureStylus.UpCallback> onUp(GestureStylus.UpCallback handler)

Emitted when the stylus no longer touches the device.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• GestureStylus.UpCallback.run(double, double)

emitUp

public void emitUp(double x,
 double y)

Emits the "up" signal. See onUp(GestureStylus.UpCallback).

builder

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

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

Returns:

the builder object