Package org.gnome.gdk

Class Seat

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gdk.Seat

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

Seat.SeatImpl

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

The GdkSeat object represents a collection of input devices that belong to a user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Seat.Builder<B extends Seat.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Seat.DeviceAddedCallback	Functional interface declaration of the DeviceAddedCallback callback.
static interface	Seat.DeviceRemovedCallback	Functional interface declaration of the DeviceRemovedCallback callback.
static class	Seat.SeatImpl	The SeatImpl type represents a native instance of the abstract Seat class.
static interface	Seat.ToolAddedCallback	Functional interface declaration of the ToolAddedCallback callback.
static interface	Seat.ToolRemovedCallback	Functional interface declaration of the ToolRemovedCallback callback.

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Seat(MemorySegment address)	Create a Seat proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Seat	asParent()	Returns this instance as if it were its parent type.
static Seat.Builder<? extends Seat.Builder>	builder()	A Seat.Builder object constructs a Seat with the specified properties.
void	emitDeviceAdded(Device device)	Emits the "device-added" signal.
void	emitDeviceRemoved(Device device)	Emits the "device-removed" signal.
void	emitToolAdded(DeviceTool tool)	Emits the "tool-added" signal.
void	emitToolRemoved(DeviceTool tool)	Emits the "tool-removed" signal.
Set<SeatCapabilities>	getCapabilities()	Returns the capabilities this GdkSeat currently has.
List<Device>	getDevices(Set<SeatCapabilities> capabilities)	Returns the devices that match the given capabilities.
List<Device>	getDevices(SeatCapabilities... capabilities)	Returns the devices that match the given capabilities.
Display	getDisplay()	Returns the GdkDisplay this seat belongs to.
Device	getKeyboard()	Returns the device that routes keyboard events.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
Device	getPointer()	Returns the device that routes pointer events.
List<DeviceTool>	getTools()	Returns all GdkDeviceTools that are known to the application.
static Type	getType()	Get the GType of the Seat class
SignalConnection<Seat.DeviceAddedCallback>	onDeviceAdded(Seat.DeviceAddedCallback handler)	Emitted when a new input device is related to this seat.
SignalConnection<Seat.DeviceRemovedCallback>	onDeviceRemoved(Seat.DeviceRemovedCallback handler)	Emitted when an input device is removed (e.g.
SignalConnection<Seat.ToolAddedCallback>	onToolAdded(Seat.ToolAddedCallback handler)	Emitted whenever a new tool is made known to the seat.
SignalConnection<Seat.ToolRemovedCallback>	onToolRemoved(Seat.ToolRemovedCallback handler)	Emitted whenever a tool is no longer known to this seat.

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, 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, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Seat

public Seat(MemorySegment address)

Create a Seat proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the Seat class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

getCapabilities

public Set<SeatCapabilities> getCapabilities()

Returns the capabilities this GdkSeat currently has.

Returns:

the seat capabilities

getDevices

public List<Device> getDevices(Set<SeatCapabilities> capabilities)

Returns the devices that match the given capabilities.

Parameters:

capabilities - capabilities to get devices for

Returns:

A list of GdkDevices. The list must be freed with g_list_free(), the elements are owned by GTK and must not be freed.

getDevices

public List<Device> getDevices(SeatCapabilities... capabilities)

Returns the devices that match the given capabilities.

Parameters:

capabilities - capabilities to get devices for

Returns:

A list of GdkDevices. The list must be freed with g_list_free(), the elements are owned by GTK and must not be freed.

getDisplay

public Display getDisplay()

Returns the GdkDisplay this seat belongs to.

Returns:

a GdkDisplay. This object is owned by GTK and must not be freed.

getKeyboard

public Device getKeyboard()

Returns the device that routes keyboard events.

Returns:

a GdkDevice with keyboard capabilities. This object is owned by GTK and must not be freed.

getPointer

public Device getPointer()

Returns the device that routes pointer events.

Returns:

a GdkDevice with pointer capabilities. This object is owned by GTK and must not be freed.

getTools

public List<DeviceTool> getTools()

Returns all GdkDeviceTools that are known to the application.

Returns:

A list of tools. Free with g_list_free().

onDeviceAdded

public SignalConnection<Seat.DeviceAddedCallback> onDeviceAdded(Seat.DeviceAddedCallback handler)

Emitted when a new input device is related to this seat.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Seat.DeviceAddedCallback.run(org.gnome.gdk.Device)

emitDeviceAdded

public void emitDeviceAdded(Device device)

Emits the "device-added" signal. See onDeviceAdded(org.gnome.gdk.Seat.DeviceAddedCallback).

onDeviceRemoved

public SignalConnection<Seat.DeviceRemovedCallback> onDeviceRemoved(Seat.DeviceRemovedCallback handler)

Emitted when an input device is removed (e.g. unplugged).

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Seat.DeviceRemovedCallback.run(org.gnome.gdk.Device)

emitDeviceRemoved

public void emitDeviceRemoved(Device device)

Emits the "device-removed" signal. See onDeviceRemoved(org.gnome.gdk.Seat.DeviceRemovedCallback).

onToolAdded

public SignalConnection<Seat.ToolAddedCallback> onToolAdded(Seat.ToolAddedCallback handler)

Emitted whenever a new tool is made known to the seat.

The tool may later be assigned to a device (i.e. on proximity with a tablet). The device will emit the Gdk.Device::tool-changed signal accordingly.

A same tool may be used by several devices.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Seat.ToolAddedCallback.run(org.gnome.gdk.DeviceTool)

emitToolAdded

public void emitToolAdded(DeviceTool tool)

Emits the "tool-added" signal. See onToolAdded(org.gnome.gdk.Seat.ToolAddedCallback).

onToolRemoved

public SignalConnection<Seat.ToolRemovedCallback> onToolRemoved(Seat.ToolRemovedCallback handler)

Emitted whenever a tool is no longer known to this seat.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Seat.ToolRemovedCallback.run(org.gnome.gdk.DeviceTool)

emitToolRemoved

public void emitToolRemoved(DeviceTool tool)

Emits the "tool-removed" signal. See onToolRemoved(org.gnome.gdk.Seat.ToolRemovedCallback).

builder

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

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