Package org.gnome.gdk

Class DeviceTool

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gdk.DeviceTool

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class DeviceTool
extends GObject

A physical tool associated to a GdkDevice.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeviceTool.Builder<B extends DeviceTool.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
DeviceTool()	Creates a new DeviceTool.
DeviceTool(MemorySegment address)	Create a DeviceTool proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected DeviceTool	asParent()	Returns this instance as if it were its parent type.
static DeviceTool.Builder<? extends DeviceTool.Builder>	builder()	A DeviceTool.Builder object constructs a DeviceTool with the specified properties.
Set<AxisFlags>	getAxes()	Gets the axes of the tool.
long	getHardwareId()	Gets the hardware ID of this tool, or 0 if it's not known.
long	getSerial()	Gets the serial number of this tool.
DeviceToolType	getToolType()	Gets the GdkDeviceToolType of the tool.
static @Nullable Type	getType()	Get the GType of the DeviceTool class

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

DeviceTool

public DeviceTool(MemorySegment address)

Create a DeviceTool proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

DeviceTool

public DeviceTool()

Creates a new DeviceTool.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the DeviceTool class

Returns:

the GType

asParent

protected DeviceTool 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 GObject

getAxes

public Set<AxisFlags> getAxes()

Gets the axes of the tool.

Returns:

the axes of this DeviceTool

getHardwareId

public long getHardwareId()

Gets the hardware ID of this tool, or 0 if it's not known.

When non-zero, the identifier is unique for the given tool model, meaning that two identical tools will share the same hardwareId, but will have different serial numbers (see getSerial()).

This is a more concrete (and device specific) method to identify a GdkDeviceTool than getToolType(), as a tablet may support multiple devices with the same GdkDeviceToolType, but different hardware identifiers.

Returns:

The hardware identifier of this tool.

getSerial

public long getSerial()

Gets the serial number of this tool.

This value can be used to identify a physical tool (eg. a tablet pen) across program executions.

Returns:

The serial ID for this tool

getToolType

public DeviceToolType getToolType()

Gets the GdkDeviceToolType of the tool.

Returns:

The physical type for this tool. This can be used to figure out what sort of pen is being used, such as an airbrush or a pencil.

builder

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

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

Returns:

the builder object