--- name: "wayland_server_zwp_tablet_v1_t" section: "3" platform: "linux" package: "waylandpp-dev" version: "1.0.0-6+b2" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/wayland_server_zwp_tablet_v1_t" --- # wayland\_server\_zwp\_tablet\_v1\_t(3) graphics tablet device ## NAME wayland::server::zwp\_tablet\_v1\_t - graphics tablet device ## SYNOPSIS `#include ` Inherits wayland::server::resource\_t. ### Public Member Functions std::function\< void()\> & **on\_destroy** ()\ destroy the tablet object void **name** (std::string const &name, bool post=true)\ tablet device name void **id** (uint32\_t vid, uint32\_t pid, bool post=true)\ tablet device USB vendor/product id void **path** (std::string const &path, bool post=true)\ path to the device void **done** (bool post=true)\ tablet description events sequence complete void **removed** (bool post=true)\ tablet removed event bool **proxy\_has\_object** () const\ Check whether this wrapper actually wraps an object. void **post\_no\_memory** () const\ uint32\_t **get\_id** () const\ client\_t **get\_client** () const\ unsigned int **get\_version** () const\ std::string **get\_class** ()\ ### Static Public Attributes static constexpr std::uint32\_t **name\_since\_version** = 1\ Minimum protocol version required for the **name** function. static constexpr std::uint32\_t **id\_since\_version** = 1\ Minimum protocol version required for the **id** function. static constexpr std::uint32\_t **path\_since\_version** = 1\ Minimum protocol version required for the **path** function. static constexpr std::uint32\_t **done\_since\_version** = 1\ Minimum protocol version required for the **done** function. static constexpr std::uint32\_t **removed\_since\_version** = 1\ Minimum protocol version required for the **removed** function. ## Detailed Description 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. Definition at line **4672** of file **wayland-server-protocol-unstable.hpp**. ## Member Function Documentation ### void zwp\_tablet\_v1\_t::done (bool post = `true`) 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. Definition at line **6348** of file **wayland-server-protocol-unstable.cpp**. ### std::string wayland::server::resource\_t::get\_class ()` [inherited]` Retrieve the interface name (class) of a resource object. **Returns** Interface name of the resource object. ### client\_t wayland::server::resource\_t::get\_client () const` [inherited]` Get the associated client **Returns** the client that owns the resource. ### uint32\_t wayland::server::resource\_t::get\_id () const` [inherited]` Get the internal ID of the resource **Returns** the internal ID of the resource ### unsigned int wayland::server::resource\_t::get\_version () const` [inherited]` Get interface version **Returns** Interface version this resource has been constructed with. ### void zwp\_tablet\_v1\_t::id (uint32\_t vid, uint32\_t pid, bool post = `true`) tablet device USB vendor/product id **Parameters** *vid* USB vendor id \ *pid* USB product id This event is sent in the initial burst of events before the wp\_tablet.done event. Definition at line **6338** of file **wayland-server-protocol-unstable.cpp**. ### void zwp\_tablet\_v1\_t::name (std::string const & name, bool post = `true`) tablet device name **Parameters** *name* the device name This event is sent in the initial burst of events before the wp\_tablet.done event. Definition at line **6333** of file **wayland-server-protocol-unstable.cpp**. ### std::function\< void()\> & zwp\_tablet\_v1\_t::on\_destroy () destroy the tablet object This destroys the client's resource for this tablet object. Definition at line **6327** of file **wayland-server-protocol-unstable.cpp**. ### void zwp\_tablet\_v1\_t::path (std::string const & path, bool post = `true`) path to the device **Parameters** *path* path to local 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. Definition at line **6343** of file **wayland-server-protocol-unstable.cpp**. ### void wayland::server::resource\_t::post\_no\_memory () const` [inherited]` Post 'not enough memory' error to the client If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance. ### bool wayland::server::resource\_t::proxy\_has\_object () const` [inherited]` Check whether this wrapper actually wraps an object. **Returns** true if there is an underlying object, false if this wrapper is empty ### void zwp\_tablet\_v1\_t::removed (bool post = `true`) 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. Definition at line **6353** of file **wayland-server-protocol-unstable.cpp**. ## Member Data Documentation ### constexpr std::uint32\_t wayland::server::zwp\_tablet\_v1\_t::done\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **done** function. Definition at line **4769** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zwp\_tablet\_v1\_t::id\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **id** function. Definition at line **4730** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zwp\_tablet\_v1\_t::name\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **name** function. Definition at line **4716** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zwp\_tablet\_v1\_t::path\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **path** function. Definition at line **4755** of file **wayland-server-protocol-unstable.hpp**. ### constexpr std::uint32\_t wayland::server::zwp\_tablet\_v1\_t::removed\_since\_version = 1` [static]`, ` [constexpr]` Minimum protocol version required for the **removed** function. Definition at line **4784** of file **wayland-server-protocol-unstable.hpp**. ## Author Generated automatically by Doxygen for Wayland++ from the source code.