Provided by: waylandpp-dev_1.0.0-5ubuntu2_amd64 
NAME
wayland::zwp_tablet_seat_v2_t - controller object for graphic tablet devices of a seat
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
std::function< void(zwp_tablet_v2_t)> & on_tablet_added ()
new device notification
std::function< void(zwp_tablet_tool_v2_t)> & on_tool_added ()
a new tool has been used with a tablet
std::function< void(zwp_tablet_pad_v2_t)> & on_pad_added ()
new pad notification
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.
Detailed Description
controller object for graphic tablet devices of a seat
An object that provides access to the graphics tablets available on this seat. After binding to this
interface, the compositor sends a set of wp_tablet_seat.tablet_added and wp_tablet_seat.tool_added
events.
Definition at line 4277 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(zwp_tablet_pad_v2_t)> & zwp_tablet_seat_v2_t::on_pad_added ()
new pad notification
Parameters
id the newly added pad
This event is sent whenever a new pad is known to the system. Typically, pads are physically attached to
tablets and a pad_added event is sent immediately after the wp_tablet_seat.tablet_added. However, some
standalone pad devices logically attach to tablets at runtime, and the client must wait for
wp_tablet_pad.enter to know the tablet a pad is attached to.
This event only provides the object id of the pad. All further features (buttons, strips, rings) are sent
through the wp_tablet_pad interface.
Definition at line 7305 of file wayland-client-protocol-unstable.cpp.
std::function< void(zwp_tablet_v2_t)> & zwp_tablet_seat_v2_t::on_tablet_added ()
new device notification
Parameters
id the newly added graphics tablet
This event is sent whenever a new tablet becomes available on this seat. This event only provides the
object id of the tablet, any static information about the tablet (device name, vid/pid, etc.) is sent
through the wp_tablet interface.
Definition at line 7295 of file wayland-client-protocol-unstable.cpp.
std::function< void(zwp_tablet_tool_v2_t)> & zwp_tablet_seat_v2_t::on_tool_added ()
a new tool has been used with a tablet
Parameters
id the newly added tablet tool
This event is sent whenever a tool that has not previously been used with a tablet comes into use. This
event only provides the object id of the tool; any static information about the tool (capabilities, type,
etc.) is sent through the wp_tablet_tool interface.
Definition at line 7300 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 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.
Author
Generated automatically by Doxygen for Wayland++ from the source code.
Version 1.0.0 Mon Apr 22 2024 09:52:15 wayland::zwp_tablet_seat_v2_t(3)