.TH "wayland::server::zwp_tablet_pad_v2_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
wayland::server::zwp_tablet_pad_v2_t \- a set of buttons, rings and strips  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <wayland\-server\-protocol\-unstable\&.hpp>\fP
.PP
Inherits wayland::server::resource_t\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "std::function< void(uint32_t, std::string, uint32_t)> & \fBon_set_feedback\fP ()"
.br
.RI "set compositor feedback "
.ti -1c
.RI "std::function< void()> & \fBon_destroy\fP ()"
.br
.RI "destroy the pad object "
.ti -1c
.RI "void \fBgroup\fP (bool post=true)"
.br
.RI "group announced "
.ti -1c
.RI "void \fBpath\fP (std::string const &path, bool post=true)"
.br
.RI "path to the device "
.ti -1c
.RI "void \fBbuttons\fP (uint32_t buttons, bool post=true)"
.br
.RI "buttons announced "
.ti -1c
.RI "void \fBdone\fP (bool post=true)"
.br
.RI "pad description event sequence complete "
.ti -1c
.RI "void \fBbutton\fP (uint32_t time, uint32_t button, zwp_tablet_pad_v2_button_state const &state, bool post=true)"
.br
.RI "physical button state "
.ti -1c
.RI "void \fBenter\fP (uint32_t serial, \fBzwp_tablet_v2_t\fP const &tablet, \fBsurface_t\fP const &surface, bool post=true)"
.br
.RI "enter event "
.ti -1c
.RI "void \fBleave\fP (uint32_t serial, \fBsurface_t\fP const &surface, bool post=true)"
.br
.RI "enter event "
.ti -1c
.RI "void \fBremoved\fP (bool post=true)"
.br
.RI "pad removed event "
.ti -1c
.RI "bool \fBproxy_has_object\fP () const"
.br
.RI "Check whether this wrapper actually wraps an object\&. "
.ti -1c
.RI "void \fBpost_no_memory\fP () const"
.br
.ti -1c
.RI "uint32_t \fBget_id\fP () const"
.br
.ti -1c
.RI "client_t \fBget_client\fP () const"
.br
.ti -1c
.RI "unsigned int \fBget_version\fP () const"
.br
.ti -1c
.RI "std::string \fBget_class\fP ()"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr std::uint32_t \fBgroup_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBgroup\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBpath_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBpath\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBbuttons_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBbuttons\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBdone_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBdone\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBbutton_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBbutton\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBenter_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBenter\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBleave_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBleave\fP function\&. "
.ti -1c
.RI "static constexpr std::uint32_t \fBremoved_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBremoved\fP function\&. "
.in -1c
.SH "Detailed Description"
.PP 
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\&.
.PP
Pad devices have no axes that control the cursor and are generally auxiliary devices to the tool devices used on the tablet surface\&.
.PP
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\&.
.PP
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\&.
.PP
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\&. 
.PP
Definition at line \fB6188\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "void zwp_tablet_pad_v2_t::button (uint32_t time, uint32_t button, zwp_tablet_pad_v2_button_state const & state, bool post = \fCtrue\fP)"

.PP
physical button state 
.PP
\fBParameters\fP
.RS 4
\fItime\fP the time of the event with millisecond granularity 
.br
\fIbutton\fP the index of the button that changed state 
.br
\fIstate\fP 
.RE
.PP
Sent whenever the physical state of a button changes\&. 
.PP
Definition at line \fB6932\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_tablet_pad_v2_t::buttons (uint32_t buttons, bool post = \fCtrue\fP)"

.PP
buttons announced 
.PP
\fBParameters\fP
.RS 4
\fIbuttons\fP the number of buttons
.RE
.PP
Sent on wp_tablet_pad initialization to announce the available buttons\&.
.PP
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\&. 
.PP
Definition at line \fB6922\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_tablet_pad_v2_t::done (bool post = \fCtrue\fP)"

.PP
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\&. 
.PP
Definition at line \fB6927\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_tablet_pad_v2_t::enter (uint32_t serial, \fBzwp_tablet_v2_t\fP const & tablet, \fBsurface_t\fP const & surface, bool post = \fCtrue\fP)"

.PP
enter event 
.PP
\fBParameters\fP
.RS 4
\fIserial\fP serial number of the enter event 
.br
\fItablet\fP the tablet the pad is attached to 
.br
\fIsurface\fP surface the pad is focused on
.RE
.PP
Notification that this pad is focused on the specified surface\&. 
.PP
Definition at line \fB6937\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "std::string wayland::server::resource_t::get_class ()\fC [inherited]\fP"
Retrieve the interface name (class) of a resource object\&.
.PP
\fBReturns\fP
.RS 4
Interface name of the resource object\&. 
.RE
.PP

.SS "client_t wayland::server::resource_t::get_client () const\fC [inherited]\fP"
Get the associated client
.PP
\fBReturns\fP
.RS 4
the client that owns the resource\&. 
.RE
.PP

.SS "uint32_t wayland::server::resource_t::get_id () const\fC [inherited]\fP"
Get the internal ID of the resource
.PP
\fBReturns\fP
.RS 4
the internal ID of the resource 
.RE
.PP

.SS "unsigned int wayland::server::resource_t::get_version () const\fC [inherited]\fP"
Get interface version
.PP
\fBReturns\fP
.RS 4
Interface version this resource has been constructed with\&. 
.RE
.PP

.SS "void zwp_tablet_pad_v2_t::group (bool post = \fCtrue\fP)"

.PP
group announced Sent on wp_tablet_pad initialization to announce available groups\&. One event is sent for each pad group available\&.
.PP
This event is sent in the initial burst of events before the wp_tablet_pad\&.done event\&. At least one group will be announced\&. 
.PP
Definition at line \fB6912\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_tablet_pad_v2_t::leave (uint32_t serial, \fBsurface_t\fP const & surface, bool post = \fCtrue\fP)"

.PP
enter event 
.PP
\fBParameters\fP
.RS 4
\fIserial\fP serial number of the leave event 
.br
\fIsurface\fP surface the pad is no longer focused on
.RE
.PP
Notification that this pad is no longer focused on the specified surface\&. 
.PP
Definition at line \fB6942\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void()> & zwp_tablet_pad_v2_t::on_destroy ()"

.PP
destroy the pad object Destroy the wp_tablet_pad object\&. Objects created from this object are unaffected and should be destroyed separately\&. 
.PP
Definition at line \fB6906\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(uint32_t, std::string, uint32_t)> & zwp_tablet_pad_v2_t::on_set_feedback ()"

.PP
set compositor feedback 
.PP
\fBParameters\fP
.RS 4
\fIbutton\fP button index 
.br
\fIdescription\fP button description 
.br
\fIserial\fP serial of the mode switch event
.RE
.PP
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\&.
.PP
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)\&.
.PP
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\&.
.PP
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\&.
.PP
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\&. 
.PP
Definition at line \fB6900\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "void zwp_tablet_pad_v2_t::path (std::string const & path, bool post = \fCtrue\fP)"

.PP
path to the device 
.PP
\fBParameters\fP
.RS 4
\fIpath\fP path to local device
.RE
.PP
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\&.
.PP
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\&.
.PP
This event is sent in the initial burst of events before the wp_tablet_pad\&.done event\&. 
.PP
Definition at line \fB6917\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "void wayland::server::resource_t::post_no_memory () const\fC [inherited]\fP"
Post 'not enough memory' error to the client
.PP
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\&. 
.SS "bool wayland::server::resource_t::proxy_has_object () const\fC [inherited]\fP"

.PP
Check whether this wrapper actually wraps an object\&. 
.PP
\fBReturns\fP
.RS 4
true if there is an underlying object, false if this wrapper is empty 
.RE
.PP

.SS "void zwp_tablet_pad_v2_t::removed (bool post = \fCtrue\fP)"

.PP
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\&.
.PP
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\&. 
.PP
Definition at line \fB6947\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_v2_t::button_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBbutton\fP function\&. 
.PP
Definition at line \fB6334\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_v2_t::buttons_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBbuttons\fP function\&. 
.PP
Definition at line \fB6307\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_v2_t::done_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBdone\fP function\&. 
.PP
Definition at line \fB6320\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_v2_t::enter_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBenter\fP function\&. 
.PP
Definition at line \fB6348\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_v2_t::group_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBgroup\fP function\&. 
.PP
Definition at line \fB6269\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_v2_t::leave_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBleave\fP function\&. 
.PP
Definition at line \fB6362\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_v2_t::path_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBpath\fP function\&. 
.PP
Definition at line \fB6290\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SS "constexpr std::uint32_t wayland::server::zwp_tablet_pad_v2_t::removed_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBremoved\fP function\&. 
.PP
Definition at line \fB6378\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Wayland++ from the source code\&.