Class Seat

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gdk.Seat

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

Seat.Seat$Impl

@Generated("org.javagi.JavaGI")
public abstract class Seat
extends GObject

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.Seat$Impl	The Seat$Impl 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 GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected Seat	asParent()	Return this instance as if it were its parent type.
void	emitDeviceAdded(@Nullable Device device)	Emits the "device-added" signal.
void	emitDeviceRemoved(@Nullable Device device)	Emits the "device-removed" signal.
void	emitToolAdded(@Nullable DeviceTool tool)	Emits the "tool-added" signal.
void	emitToolRemoved(@Nullable 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.
@Nullable Device	getKeyboard()	Returns the device that routes keyboard events.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
@Nullable Device	getPointer()	Returns the device that routes pointer events.
List<DeviceTool>	getTools()	Returns all GdkDeviceTools that are known to the application.
static @Nullable 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. unplugged).
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 GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, builder, 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

Seat

public Seat(MemorySegment address)

Create a Seat instance for the provided memory address.

Parameters:

address - the memory address of the native object

Seat

public Seat()

Create a new Seat.

Method Details

getType

public static @Nullable 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()

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 GObject

Returns:

the instance as if it were its parent type

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 @Nullable 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 @Nullable 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(Device)

emitDeviceAdded

public void emitDeviceAdded(@Nullable Device device)

Emits the "device-added" signal. See onDeviceAdded(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(Device)

emitDeviceRemoved

public void emitDeviceRemoved(@Nullable Device device)

Emits the "device-removed" signal. See onDeviceRemoved(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(DeviceTool)

emitToolAdded

public void emitToolAdded(@Nullable DeviceTool tool)

Emits the "tool-added" signal. See onToolAdded(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(DeviceTool)

emitToolRemoved

public void emitToolRemoved(@Nullable DeviceTool tool)

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