Skip to content

zwp_tablet_v2¤

wayland.zwp_tablet_v2 ¤

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 vendor/product id.

  • on_path –

    Path to the device.

  • on_done –

    Tablet description events sequence complete.

  • on_removed –

    Tablet removed event.

  • on_bustype –

    Tablet device bus type.

bustype ¤

Bus type

Describes the bus types this tablet is connected to.

events

name ¤

name(name: str) -> None

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 ¤

    (str) –

    The device name

id ¤

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

Tablet device vendor/product id

The vendor and product IDs for the tablet device.

The interpretation of the id depends on the wp_tablet.bustype. Prior to version v2 of this protocol, the id was implied to be a USB vendor and product ID. If no wp_tablet.bustype is sent, the ID is to be interpreted as USB vendor and product ID.

If the device has no 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 ¤

    (int) –

    Vendor id

  • pid ¤

    (int) –

    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.

bustype ¤

bustype(bustype: bustype) -> None

Tablet device bus type

The bustype argument is one of the BUS_ defines in the Linux kernel's linux/input.h

If the device has no known bustype or the bustype cannot be queried, this event is not sent.

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

Parameters:

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_v2.events.name.

on_id ¤

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

Tablet device vendor/product id.

Override to handle wayland.zwp_tablet_v2.events.id.

on_path ¤

on_path(path: str) -> None

Path to the device.

Override to handle wayland.zwp_tablet_v2.events.path.

on_done ¤

on_done() -> None

Tablet description events sequence complete.

Override to handle wayland.zwp_tablet_v2.events.done.

on_removed ¤

on_removed() -> None

Tablet removed event.

Override to handle wayland.zwp_tablet_v2.events.removed.

on_bustype ¤

on_bustype(bustype: bustype) -> None

Tablet device bus type.

Override to handle wayland.zwp_tablet_v2.events.bustype.