Package org.freedesktop.wayland.client

Interface ZwpTabletV2Events

public interface ZwpTabletV2Events

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 int	VERSION

Method Summary

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

Field Details

VERSION

static final int VERSION

See Also:

• Constant Field Values

Method Details

name

void name(ZwpTabletV2Proxy emitter,
 @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:

emitter - The protocol object that emitted the event.

name - the device name

id

void id(ZwpTabletV2Proxy emitter,
 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:

emitter - The protocol object that emitted the event.

vid - USB vendor id

pid - USB product id

path

void path(ZwpTabletV2Proxy emitter,
 @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:

emitter - The protocol object that emitted the event.

path - path to local device

done

void done(ZwpTabletV2Proxy emitter)

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.

Parameters:

emitter - The protocol object that emitted the event.

removed

void removed(ZwpTabletV2Proxy emitter)

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.

Parameters:

emitter - The protocol object that emitted the event.