Provided by: waylandpp-dev_1.0.0-3_amd64 
NAME
wayland::zwp_tablet_v1_t - graphics tablet device
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(std::string)> & on_name ()
tablet device name
std::function< void(uint32_t, uint32_t)> & on_id ()
tablet device USB vendor/product id
std::function< void(std::string)> & on_path ()
path to the device
std::function< void()> & on_done ()
tablet description events sequence complete
std::function< void()> & on_removed ()
tablet 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.
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 4134 of file wayland-client-protocol-unstable.hpp.
Member Enumeration Documentation
enum 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 115 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 301 of file wayland-client.hpp.
std::function< void()> & zwp_tablet_v1_t::on_done ()
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 7147 of file wayland-client-protocol-unstable.cpp.
std::function< void(uint32_t, uint32_t)> & zwp_tablet_v1_t::on_id ()
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 7137 of file wayland-client-protocol-unstable.cpp.
std::function< void(std::string)> & zwp_tablet_v1_t::on_name ()
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 7132 of file wayland-client-protocol-unstable.cpp.
std::function< void(std::string)> & zwp_tablet_v1_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. 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 7142 of file wayland-client-protocol-unstable.cpp.
std::function< void()> & zwp_tablet_v1_t::on_removed ()
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 7152 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.
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().
Author
Generated automatically by Doxygen for Wayland++ from the source code.