Skip to content

zwp_tablet_v1¤

wayland.zwp_tablet_v1 ¤

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.

Methods:

  • destroy –

    Destroy the tablet object

  • on_name –

    Tablet device name.

  • on_id –

    Tablet device usb vendor/product id.

  • on_path –

    Path to the device.

  • on_done –

    Tablet description events sequence complete.

  • on_removed –

    Tablet removed event.

events

name ¤

name(name: str) -> None

Tablet device name

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

Parameters:

  • name ¤

    (str) –

    The device name

id ¤

id(vid: int, pid: int) -> None

Tablet device usb vendor/product id

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

Parameters:

  • vid ¤

    (int) –

    Usb vendor id

  • pid ¤

    (int) –

    Usb product id

path ¤

path(path: str) -> None

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 ¤

    (str) –

    Path to local device

done ¤

done() -> None

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 ¤

removed() -> None

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.

destroy ¤

destroy() -> None

Destroy the tablet object

This destroys the client's resource for this tablet object.

on_name ¤

on_name(name: str) -> None

Tablet device name.

Override to handle wayland.zwp_tablet_v1.events.name.

on_id ¤

on_id(vid: int, pid: int) -> None

Tablet device usb vendor/product id.

Override to handle wayland.zwp_tablet_v1.events.id.

on_path ¤

on_path(path: str) -> None

Path to the device.

Override to handle wayland.zwp_tablet_v1.events.path.

on_done ¤

on_done() -> None

Tablet description events sequence complete.

Override to handle wayland.zwp_tablet_v1.events.done.

on_removed ¤

on_removed() -> None

Tablet removed event.

Override to handle wayland.zwp_tablet_v1.events.removed.