.TH "wayland::server::zwp_tablet_v1_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*- .ad l .nh .SH NAME wayland::server::zwp_tablet_v1_t \- graphics tablet device .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits wayland::server::resource_t\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "std::function< void()> & \fBon_destroy\fP ()" .br .RI "destroy the tablet object " .ti -1c .RI "void \fBname\fP (std::string const &name, bool post=true)" .br .RI "tablet device name " .ti -1c .RI "void \fBid\fP (uint32_t vid, uint32_t pid, bool post=true)" .br .RI "tablet device USB vendor/product id " .ti -1c .RI "void \fBpath\fP (std::string const &path, bool post=true)" .br .RI "path to the device " .ti -1c .RI "void \fBdone\fP (bool post=true)" .br .RI "tablet description events sequence complete " .ti -1c .RI "void \fBremoved\fP (bool post=true)" .br .RI "tablet 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 \fBname_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBname\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBid_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBid\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 \fBdone_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBdone\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 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\&. .PP 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\&. .PP Definition at line \fB4672\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Member Function Documentation" .PP .SS "void zwp_tablet_v1_t::done (bool post = \fCtrue\fP)" .PP 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\&. .PP Definition at line \fB6348\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_v1_t::id (uint32_t vid, uint32_t pid, bool post = \fCtrue\fP)" .PP tablet device USB vendor/product id .PP \fBParameters\fP .RS 4 \fIvid\fP USB vendor id .br \fIpid\fP USB product id .RE .PP This event is sent in the initial burst of events before the wp_tablet\&.done event\&. .PP Definition at line \fB6338\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_tablet_v1_t::name (std::string const & name, bool post = \fCtrue\fP)" .PP tablet device name .PP \fBParameters\fP .RS 4 \fIname\fP the device name .RE .PP This event is sent in the initial burst of events before the wp_tablet\&.done event\&. .PP Definition at line \fB6333\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void()> & zwp_tablet_v1_t::on_destroy ()" .PP destroy the tablet object This destroys the client's resource for this tablet object\&. .PP Definition at line \fB6327\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_tablet_v1_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\&. This information may be used to gather additional information about the device, e\&.g\&. through libwacom\&. .PP 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\&. .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\&.done event\&. .PP Definition at line \fB6343\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_v1_t::removed (bool post = \fCtrue\fP)" .PP tablet removed event Sent when the tablet has been removed from the system\&. When a tablet is removed, some tools may be removed\&. .PP When this event is received, the client must wp_tablet\&.destroy the object\&. .PP Definition at line \fB6353\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SH "Member Data Documentation" .PP .SS "constexpr std::uint32_t wayland::server::zwp_tablet_v1_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 \fB4769\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_tablet_v1_t::id_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBid\fP function\&. .PP Definition at line \fB4730\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_tablet_v1_t::name_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBname\fP function\&. .PP Definition at line \fB4716\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_tablet_v1_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 \fB4755\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_tablet_v1_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 \fB4784\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Wayland++ from the source code\&.