---
name: "wayland_zwp_tablet_pad_v2_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_zwp_tablet_pad_v2_t"
---

# wayland\_zwp\_tablet\_pad\_v2\_t(3)

a set of buttons, rings and strips

## NAME

wayland::zwp\_tablet\_pad\_v2\_t - a set of buttons, rings and strips

## SYNOPSIS

`#include <wayland-client-protocol-unstable.hpp>`

Inherits **wayland::proxy\_t**.

### Public Types

enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\

### Public Member Functions

void **set\_feedback** (uint32\_t button, std::string const &description, uint32\_t serial)\
 set compositor feedback  std::function\< void(**zwp\_tablet\_pad\_group\_v2\_t**)\> & **on\_group** ()\
 group announced  std::function\< void(std::string)\> & **on\_path** ()\
 path to the device  std::function\< void(uint32\_t)\> & **on\_buttons** ()\
 buttons announced  std::function\< void()\> & **on\_done** ()\
 pad description event sequence complete  std::function\< void(uint32\_t, uint32\_t, zwp\_tablet\_pad\_v2\_button\_state)\> & **on\_button** ()\
 physical button state  std::function\< void(uint32\_t, **zwp\_tablet\_v2\_t**, **surface\_t**)\> & **on\_enter** ()\
 enter event  std::function\< void(uint32\_t, **surface\_t**)\> & **on\_leave** ()\
 enter event  std::function\< void()\> & **on\_removed** ()\
 pad removed event  uint32\_t **get\_id** () const\
 Get the id of a proxy object.  std::string **get\_class** () const\
 Get the interface name (class) of a proxy object.  uint32\_t **get\_version** () const\
 Get the protocol object version of a proxy object.  **wrapper\_type** **get\_wrapper\_type** () const\
 Get the type of a proxy object.  void **set\_queue** (**event\_queue\_t** queue)\
 Assign a proxy to an event queue.  wl\_proxy \* **c\_ptr** () const\
 Get a pointer to the underlying C struct.  bool **proxy\_has\_object** () const\
 Check whether this wrapper actually wraps an object.  **operator bool** () const\
 Check whether this wrapper actually wraps an object.  bool **operator==** (const **proxy\_t** &right) const\
 Check whether two wrappers refer to the same object.  bool **operator!=** (const **proxy\_t** &right) const\
 Check whether two wrappers refer to different objects.  void **proxy\_release** ()\
 Release the wrapped object (if any), making this an empty wrapper.

### Static Public Attributes

static constexpr std::uint32\_t **set\_feedback\_since\_version** = 1\
 Minimum protocol version required for the **set\_feedback** function.

## Detailed Description

a set of buttons, rings and strips

A pad device is a set of buttons, rings and strips usually physically present on the tablet device itself. Some exceptions exist where the pad device is physically detached, e.g. the Wacom ExpressKey Remote.

Pad devices have no axes that control the cursor and are generally auxiliary devices to the tool devices used on the tablet surface.

A pad device has a number of static characteristics, e.g. the number of rings. These capabilities are sent in an event sequence after the wp\_tablet\_seat.pad\_added event before any actual events from this pad. This initial event sequence is terminated by a wp\_tablet\_pad.done event.

All pad features (buttons, rings and strips) are logically divided into groups and all pads have at least one group. The available groups are notified through the wp\_tablet\_pad.group event; the compositor will emit one event per group before emitting wp\_tablet\_pad.done.

Groups may have multiple modes. Modes allow clients to map multiple actions to a single pad feature. Only one mode can be active per group, although different groups may have different active modes.

Definition at line **5414** of file **wayland-client-protocol-unstable.hpp**.

## Member Enumeration Documentation

### enum class wayland::proxy\_t::wrapper\_type` [strong]`, ` [inherited]`

Underlying wl\_proxy type and properties of a **proxy\_t** that affect construction, destruction, and event handling

**Enumerator**

- *standard*

  *C pointer is a standard type compatible with wl\_proxy\*. Events are dispatched and it is destructed when the* **proxy\_t** *is destructed. User data is set.*

- *display*

  *C pointer is a wl\_display\*. No events are dispatched, wl\_display\_disconnect is called when the* **proxy\_t** *is destructed. User data is set.*

- *foreign*

  *C pointer is a standard type compatible with wl\_proxy\*, but another library owns it and it should not be touched in a way that could affect the operation of the other library. No events are dispatched, wl\_proxy\_destroy is not called when the* **proxy\_t** *is destructed, user data is not touched. Consequently, there is no reference counting for the* **proxy\_t***. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl\_proxy.*

- *proxy\_wrapper*

  *C pointer is a wl\_proxy\* that was constructed with wl\_proxy\_create\_wrapper. No events are dispatched, wl\_proxy\_wrapper\_destroy is called when the* **proxy\_t** *is destroyed. Reference counting is active. A reference to the* **proxy\_t** *creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.*

*Definition at line* **116** *of file* **wayland-client.hpp***.*

## Member Function Documentation

### wl\_proxy \* wayland::proxy\_t::c\_ptr () const` [inherited]`

*Get a pointer to the underlying C struct.*

**Returns**

*The underlying wl\_proxy wrapped by this* **proxy\_t** *if it exists, otherwise an exception is thrown*

### std::string wayland::proxy\_t::get\_class () const` [inherited]`

*Get the interface name (class) of a proxy object.*

**Returns**

*The interface name of the object associated with the proxy*

### uint32\_t wayland::proxy\_t::get\_id () const` [inherited]`

*Get the id of a proxy object.*

**Returns**

*The id the object associated with the proxy*

### uint32\_t wayland::proxy\_t::get\_version () const` [inherited]`

*Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API.*

*A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version.*

**display\_t** *will always return version 0.*

**Returns**

*The protocol object version of the proxy or 0*

### wrapper\_type wayland::proxy\_t::get\_wrapper\_type () const` [inline]`, ` [inherited]`

*Get the type of a proxy object.*

*Definition at line* **302** *of file* **wayland-client.hpp***.*

### std::function\< void(uint32\_t, uint32\_t, zwp\_tablet\_pad\_v2\_button\_state)\> & zwp\_tablet\_pad\_v2\_t::on\_button ()

*physical button state*

**Parameters**

*time the time of the event with millisecond granularity* \
 *button the index of the button that changed state* \
 *state*

*Sent whenever the physical state of a button changes.*

*Definition at line* **8033** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t)\> & zwp\_tablet\_pad\_v2\_t::on\_buttons ()

*buttons announced*

**Parameters**

*buttons the number of buttons*

*Sent on wp\_tablet\_pad initialization to announce the available buttons.*

*This event is sent in the initial burst of events before the wp\_tablet\_pad.done event. This event is only sent when at least one button is available.*

*Definition at line* **8023** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void()\> & zwp\_tablet\_pad\_v2\_t::on\_done ()

*pad description event sequence complete This event signals the end of the initial burst of descriptive events. A client may consider the static description of the pad to be complete and finalize initialization of the pad.*

*Definition at line* **8028** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t, zwp\_tablet\_v2\_t, surface\_t)\> & zwp\_tablet\_pad\_v2\_t::on\_enter ()

*enter event*

**Parameters**

*serial serial number of the enter event* \
 *tablet the tablet the pad is attached to* \
 *surface surface the pad is focused on*

*Notification that this pad is focused on the specified surface.*

*Definition at line* **8038** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(zwp\_tablet\_pad\_group\_v2\_t)\> & zwp\_tablet\_pad\_v2\_t::on\_group ()

*group announced*

**Parameters**

*pad\_group*

*Sent on wp\_tablet\_pad initialization to announce available groups. One event is sent for each pad group available.*

*This event is sent in the initial burst of events before the wp\_tablet\_pad.done event. At least one group will be announced.*

*Definition at line* **8013** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(uint32\_t, surface\_t)\> & zwp\_tablet\_pad\_v2\_t::on\_leave ()

*enter event*

**Parameters**

*serial serial number of the leave event* \
 *surface surface the pad is no longer focused on*

*Notification that this pad is no longer focused on the specified surface.*

*Definition at line* **8043** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void(std::string)\> & zwp\_tablet\_pad\_v2\_t::on\_path ()

*path to the device*

**Parameters**

*path path to local device*

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

*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\_pad.done event.*

*Definition at line* **8018** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::function\< void()\> & zwp\_tablet\_pad\_v2\_t::on\_removed ()

*pad removed event Sent when the pad has been removed from the system. When a tablet is removed its pad(s) will be removed too.*

*When this event is received, the client must destroy all rings, strips and groups that were offered by this pad, and issue wp\_tablet\_pad.destroy the pad itself.*

*Definition at line* **8048** *of file* **wayland-client-protocol-unstable.cpp***.*

### wayland::proxy\_t::operator bool () const` [inherited]`

*Check whether this wrapper actually wraps an object.*

**Returns**

*true if there is an underlying object, false if this wrapper is empty*

### bool wayland::proxy\_t::operator!= (const proxy\_t & right) const` [inherited]`

*Check whether two wrappers refer to different objects.*

### bool wayland::proxy\_t::operator== (const proxy\_t & right) const` [inherited]`

*Check whether two wrappers refer to the same object.*

### bool wayland::proxy\_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 wayland::proxy\_t::proxy\_release ()` [inherited]`

*Release the wrapped object (if any), making this an empty wrapper. Note that* **display\_t** *instances cannot be released this way. Attempts to do so are ignored.*

**Examples** **foreign\_display.cpp***.*

### void zwp\_tablet\_pad\_v2\_t::set\_feedback (uint32\_t button, std::string const & description, uint32\_t serial)

*set compositor feedback*

**Parameters**

*button button index* \
 *description button description* \
 *serial serial of the mode switch event*

*Requests the compositor to use the provided feedback string associated with this button. This request should be issued immediately after a wp\_tablet\_pad\_group.mode\_switch event from the corresponding group is received, or whenever a button is mapped to a different action. See wp\_tablet\_pad\_group.mode\_switch for more details.*

*Clients are encouraged to provide context-aware descriptions for the actions associated with each button, and compositors may use this information to offer visual feedback on the button layout (e.g. on-screen displays).*

*Button indices start at 0. Setting the feedback string on a button that is reserved by the compositor (i.e. not belonging to any wp\_tablet\_pad\_group) does not generate an error but the compositor is free to ignore the request.*

*The provided string 'description' is a UTF-8 encoded string to be associated with this ring, and is considered user-visible; general internationalization rules apply.*

*The serial argument will be that of the last wp\_tablet\_pad\_group.mode\_switch event received for the group of this button. Requests providing other serials than the most recent one will be ignored.*

*Definition at line* **8007** *of file* **wayland-client-protocol-unstable.cpp***.*

### void wayland::proxy\_t::set\_queue (event\_queue\_t queue)` [inherited]`

*Assign a proxy to an event queue.*

**Parameters**

*queue The event queue that will handle this proxy*

*Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.*

*See also:* **display\_t::dispatch\_queue()***.*

**Examples** **proxy\_wrapper.cpp***.*

## Member Data Documentation

### constexpr std::uint32\_t wayland::zwp\_tablet\_pad\_v2\_t::set\_feedback\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_feedback** *function.*

*Definition at line* **5479** *of file* **wayland-client-protocol-unstable.hpp***.*

## Author

*Generated automatically by Doxygen for Wayland++ from the source code.*