.TH "wayland::zwp_tablet_pad_group_v2_t" 3 "Wed May 1 2024 17:27:19" "Version 1.0.0" "Wayland++" \" -*- nroff -*- .ad l .nh .SH NAME wayland::zwp_tablet_pad_group_v2_t \- a set of buttons, rings and strips .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBwayland::proxy_t\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "enum class \fBwrapper_type\fP { \fBstandard\fP, \fBdisplay\fP, \fBforeign\fP, \fBproxy_wrapper\fP }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "std::function< void(array_t)> & \fBon_buttons\fP ()" .br .RI "buttons announced " .ti -1c .RI "std::function< void(\fBzwp_tablet_pad_ring_v2_t\fP)> & \fBon_ring\fP ()" .br .RI "ring announced " .ti -1c .RI "std::function< void(\fBzwp_tablet_pad_strip_v2_t\fP)> & \fBon_strip\fP ()" .br .RI "strip announced " .ti -1c .RI "std::function< void(uint32_t)> & \fBon_modes\fP ()" .br .RI "mode-switch ability announced " .ti -1c .RI "std::function< void()> & \fBon_done\fP ()" .br .RI "tablet group description events sequence complete " .ti -1c .RI "std::function< void(uint32_t, uint32_t, uint32_t)> & \fBon_mode_switch\fP ()" .br .RI "mode switch event " .ti -1c .RI "uint32_t \fBget_id\fP () const" .br .RI "Get the id of a proxy object\&. " .ti -1c .RI "std::string \fBget_class\fP () const" .br .RI "Get the interface name (class) of a proxy object\&. " .ti -1c .RI "uint32_t \fBget_version\fP () const" .br .RI "Get the protocol object version of a proxy object\&. " .ti -1c .RI "\fBwrapper_type\fP \fBget_wrapper_type\fP () const" .br .RI "Get the type of a proxy object\&. " .ti -1c .RI "void \fBset_queue\fP (\fBevent_queue_t\fP queue)" .br .RI "Assign a proxy to an event queue\&. " .ti -1c .RI "wl_proxy * \fBc_ptr\fP () const" .br .RI "Get a pointer to the underlying C struct\&. " .ti -1c .RI "bool \fBproxy_has_object\fP () const" .br .RI "Check whether this wrapper actually wraps an object\&. " .ti -1c .RI "\fBoperator bool\fP () const" .br .RI "Check whether this wrapper actually wraps an object\&. " .ti -1c .RI "bool \fBoperator==\fP (const \fBproxy_t\fP &right) const" .br .RI "Check whether two wrappers refer to the same object\&. " .ti -1c .RI "bool \fBoperator!=\fP (const \fBproxy_t\fP &right) const" .br .RI "Check whether two wrappers refer to different objects\&. " .ti -1c .RI "void \fBproxy_release\fP ()" .br .RI "Release the wrapped object (if any), making this an empty wrapper\&. " .in -1c .SH "Detailed Description" .PP a set of buttons, rings and strips A pad group describes a distinct (sub)set of buttons, rings and strips present in the tablet\&. The criteria of this grouping is usually positional, eg\&. if a tablet has buttons on the left and right side, 2 groups will be presented\&. The physical arrangement of groups is undisclosed and may change on the fly\&. .PP Pad groups will announce their features during pad initialization\&. Between the corresponding wp_tablet_pad\&.group event and wp_tablet_pad_group\&.done, the pad group will announce the buttons, rings and strips contained in it, plus the number of supported modes\&. .PP Modes are a mechanism to allow multiple groups of actions for every element in the pad group\&. The number of groups and available modes in each is persistent across device plugs\&. The current mode is user-switchable, it will be announced through the wp_tablet_pad_group\&.mode_switch event both whenever it is switched, and after wp_tablet_pad\&.enter\&. .PP The current mode logically applies to all elements in the pad group, although it is at clients' discretion whether to actually perform different actions, and/or issue the respective \&.set_feedback requests to notify the compositor\&. See the wp_tablet_pad_group\&.mode_switch event for more details\&. .PP Definition at line \fB5249\fP of file \fBwayland\-client\-protocol\-unstable\&.hpp\fP\&. .SH "Member Enumeration Documentation" .PP .SS "enum class \fBwayland::proxy_t::wrapper_type\fP\fC [strong]\fP, \fC [inherited]\fP" Underlying wl_proxy type and properties of a \fBproxy_t\fP that affect construction, destruction, and event handling .PP \fBEnumerator\fP .in +1c .TP \fB\fIstandard \fP\fP C pointer is a standard type compatible with wl_proxy*\&. Events are dispatched and it is destructed when the \fBproxy_t\fP is destructed\&. User data is set\&. .TP \fB\fIdisplay \fP\fP C pointer is a wl_display*\&. No events are dispatched, wl_display_disconnect is called when the \fBproxy_t\fP is destructed\&. User data is set\&. .TP \fB\fIforeign \fP\fP 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 \fBproxy_t\fP is destructed, user data is not touched\&. Consequently, there is no reference counting for the \fBproxy_t\fP\&. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl_proxy\&. .TP \fB\fIproxy_wrapper \fP\fP 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 \fBproxy_t\fP is destroyed\&. Reference counting is active\&. A reference to the \fBproxy_t\fP creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed\&. .PP Definition at line \fB116\fP of file \fBwayland\-client\&.hpp\fP\&. .SH "Member Function Documentation" .PP .SS "wl_proxy * wayland::proxy_t::c_ptr () const\fC [inherited]\fP" .PP Get a pointer to the underlying C struct\&. .PP \fBReturns\fP .RS 4 The underlying wl_proxy wrapped by this \fBproxy_t\fP if it exists, otherwise an exception is thrown .RE .PP .SS "std::string wayland::proxy_t::get_class () const\fC [inherited]\fP" .PP Get the interface name (class) of a proxy object\&. .PP \fBReturns\fP .RS 4 The interface name of the object associated with the proxy .RE .PP .SS "uint32_t wayland::proxy_t::get_id () const\fC [inherited]\fP" .PP Get the id of a proxy object\&. .PP \fBReturns\fP .RS 4 The id the object associated with the proxy .RE .PP .SS "uint32_t wayland::proxy_t::get_version () const\fC [inherited]\fP" .PP 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\&. .PP 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\&. .PP \fBdisplay_t\fP will always return version 0\&. .PP \fBReturns\fP .RS 4 The protocol object version of the proxy or 0 .RE .PP .SS "\fBwrapper_type\fP wayland::proxy_t::get_wrapper_type () const\fC [inline]\fP, \fC [inherited]\fP" .PP Get the type of a proxy object\&. .PP Definition at line \fB302\fP of file \fBwayland\-client\&.hpp\fP\&. .SS "std::function< void(array_t)> & zwp_tablet_pad_group_v2_t::on_buttons ()" .PP buttons announced .PP \fBParameters\fP .RS 4 \fIbuttons\fP buttons in this group .RE .PP Sent on wp_tablet_pad_group initialization to announce the available buttons in the group\&. Button indices start at 0, a button may only be in one group at a time\&. .PP This event is first sent in the initial burst of events before the wp_tablet_pad_group\&.done event\&. .PP Some buttons are reserved by the compositor\&. These buttons may not be assigned to any wp_tablet_pad_group\&. Compositors may broadcast this event in the case of changes to the mapping of these reserved buttons\&. If the compositor happens to reserve all buttons in a group, this event will be sent with an empty array\&. .PP Definition at line \fB7899\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void()> & zwp_tablet_pad_group_v2_t::on_done ()" .PP tablet group 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 group\&. .PP Definition at line \fB7919\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void(uint32_t, uint32_t, uint32_t)> & zwp_tablet_pad_group_v2_t::on_mode_switch ()" .PP mode switch event .PP \fBParameters\fP .RS 4 \fItime\fP the time of the event with millisecond granularity .br \fIserial\fP .br \fImode\fP the new mode of the pad .RE .PP Notification that the mode was switched\&. .PP A mode applies to all buttons, rings and strips in a group simultaneously, but a client is not required to assign different actions for each mode\&. For example, a client may have mode-specific button mappings but map the ring to vertical scrolling in all modes\&. Mode indices start at 0\&. .PP Switching modes is compositor-dependent\&. The compositor may provide visual cues to the client about the mode, e\&.g\&. by toggling LEDs on the tablet device\&. Mode-switching may be software-controlled or controlled by one or more physical buttons\&. For example, on a Wacom Intuos Pro, the button inside the ring may be assigned to switch between modes\&. .PP The compositor will also send this event after wp_tablet_pad\&.enter on each group in order to notify of the current mode\&. Groups that only feature one mode will use mode=0 when emitting this event\&. .PP If a button action in the new mode differs from the action in the previous mode, the client should immediately issue a wp_tablet_pad\&.set_feedback request for each changed button\&. .PP If a ring or strip action in the new mode differs from the action in the previous mode, the client should immediately issue a wp_tablet_ring\&.set_feedback or wp_tablet_strip\&.set_feedback request for each changed ring or strip\&. .PP Definition at line \fB7924\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void(uint32_t)> & zwp_tablet_pad_group_v2_t::on_modes ()" .PP mode-switch ability announced .PP \fBParameters\fP .RS 4 \fImodes\fP the number of modes .RE .PP Sent on wp_tablet_pad_group initialization to announce that the pad group may switch between modes\&. A client may use a mode to store a specific configuration for buttons, rings and strips and use the wl_tablet_pad_group\&.mode_switch event to toggle between these configurations\&. Mode indices start at 0\&. .PP Switching modes is compositor-dependent\&. See the wp_tablet_pad_group\&.mode_switch event for more details\&. .PP This event is sent in the initial burst of events before the wp_tablet_pad_group\&.done event\&. This event is only sent when more than more than one mode is available\&. .PP Definition at line \fB7914\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void(\fBzwp_tablet_pad_ring_v2_t\fP)> & zwp_tablet_pad_group_v2_t::on_ring ()" .PP ring announced .PP \fBParameters\fP .RS 4 \fIring\fP .RE .PP Sent on wp_tablet_pad_group initialization to announce available rings\&. One event is sent for each ring available on this pad group\&. .PP This event is sent in the initial burst of events before the wp_tablet_pad_group\&.done event\&. .PP Definition at line \fB7904\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void(\fBzwp_tablet_pad_strip_v2_t\fP)> & zwp_tablet_pad_group_v2_t::on_strip ()" .PP strip announced .PP \fBParameters\fP .RS 4 \fIstrip\fP .RE .PP Sent on wp_tablet_pad initialization to announce available strips\&. One event is sent for each strip available on this pad group\&. .PP This event is sent in the initial burst of events before the wp_tablet_pad_group\&.done event\&. .PP Definition at line \fB7909\fP of file \fBwayland\-client\-protocol\-unstable\&.cpp\fP\&. .SS "wayland::proxy_t::operator bool () 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 "bool wayland::proxy_t::operator!= (const \fBproxy_t\fP & right) const\fC [inherited]\fP" .PP Check whether two wrappers refer to different objects\&. .SS "bool wayland::proxy_t::operator== (const \fBproxy_t\fP & right) const\fC [inherited]\fP" .PP Check whether two wrappers refer to the same object\&. .SS "bool wayland::proxy_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 wayland::proxy_t::proxy_release ()\fC [inherited]\fP" .PP Release the wrapped object (if any), making this an empty wrapper\&. Note that \fBdisplay_t\fP instances cannot be released this way\&. Attempts to do so are ignored\&. .PP \fBExamples\fP .in +1c \fBforeign_display\&.cpp\fP\&. .SS "void wayland::proxy_t::set_queue (\fBevent_queue_t\fP queue)\fC [inherited]\fP" .PP Assign a proxy to an event queue\&. .PP \fBParameters\fP .RS 4 \fIqueue\fP The event queue that will handle this proxy .RE .PP Assign proxy to event queue\&. Events coming from proxy will be queued in queue instead of the display's main queue\&. .PP See also: \fBdisplay_t::dispatch_queue()\fP\&. .PP \fBExamples\fP .in +1c \fBproxy_wrapper\&.cpp\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Wayland++ from the source code\&.