Package org.freedesktop.wayland.server

Class ZwpTabletV2Resource

java.lang.Object

org.freedesktop.wayland.server.Resource<ZwpTabletV2Requests>

org.freedesktop.wayland.server.ZwpTabletV2Resource

All Implemented Interfaces:

WaylandObject

public class ZwpTabletV2Resource
extends Resource<ZwpTabletV2Requests>

graphics tablet device

The wp_tablet interface represents one graphics tablet device. The tablet interface itself does not generate events; all events are generated by wp_tablet_tool objects when in proximity above a tablet.

A tablet has a number of static characteristics, e.g. device name and pid/vid. These capabilities are sent in an event sequence after the wp_tablet_seat.tablet_added event. This initial event sequence is terminated by a wp_tablet.done event.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.server.Resource

wlResourcePtr

Constructor Summary

Constructors

Constructor	Description
ZwpTabletV2Resource(MemorySegment pointer)
ZwpTabletV2Resource(Client client, int version, int id, ZwpTabletV2Requests implementation)

Method Summary

Modifier and Type	Method	Description
void	done()	tablet description events sequence complete
void	id(int vid, int pid)	tablet device USB vendor/product id
void	name(String name)	tablet device name
void	path(String path)	path to the device
void	removed()	tablet removed event

Methods inherited from class org.freedesktop.wayland.server.Resource

addDestroyListener, destroy, equals, getClient, getId, getImplementation, getPointer, getVersion, hashCode, postError, postEvent, postEvent, register, unregister

Methods inherited from class java.lang.Object

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

Field Details

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

• Constant Field Values

Constructor Details

ZwpTabletV2Resource

public ZwpTabletV2Resource(Client client,
 int version,
 int id,
 ZwpTabletV2Requests implementation)

ZwpTabletV2Resource

public ZwpTabletV2Resource(MemorySegment pointer)

Method Details

name

public void name(@Nonnull
 String name)

tablet device name

A descriptive name for the tablet device.

If the device has no descriptive name, this event is not sent.

This event is sent in the initial burst of events before the wp_tablet.done event.

Parameters:

name - the device name

id

public void id(int vid,
 int pid)

tablet device USB vendor/product id

The USB vendor and product IDs for the tablet device.

If the device has no USB vendor/product ID, this event is not sent. This can happen for virtual devices or non-USB devices, for instance.

This event is sent in the initial burst of events before the wp_tablet.done event.

Parameters:

vid - USB vendor id

pid - USB product id

path

public void path(@Nonnull
 String path)

path to the device

A system-specific device path that indicates which device is behind this wp_tablet. This information may be used to gather additional information about the device, e.g. through libwacom.

A device may have more than one device path. If so, multiple wp_tablet.path events are sent. A device may be emulated and not have a device path, and in that case this event will not be sent.

The format of the path is unspecified, it may be a device node, a sysfs path, or some other identifier. It is up to the client to identify the string provided.

This event is sent in the initial burst of events before the wp_tablet.done event.

Parameters:

path - path to local device

done

public void done()

tablet description events sequence complete

This event is sent immediately to signal the end of the initial burst of descriptive events. A client may consider the static description of the tablet to be complete and finalize initialization of the tablet.

removed

public void removed()

tablet removed event

Sent when the tablet has been removed from the system. When a tablet is removed, some tools may be removed.

When this event is received, the client must wp_tablet.destroy the object.