.TH "wayland::server::seat_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*- .ad l .nh .SH NAME wayland::server::seat_t \- group of input devices .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(\fBpointer_t\fP)> & \fBon_get_pointer\fP ()" .br .RI "return pointer object " .ti -1c .RI "std::function< void(\fBkeyboard_t\fP)> & \fBon_get_keyboard\fP ()" .br .RI "return keyboard object " .ti -1c .RI "std::function< void(\fBtouch_t\fP)> & \fBon_get_touch\fP ()" .br .RI "return touch object " .ti -1c .RI "std::function< void()> & \fBon_release\fP ()" .br .RI "release the seat object " .ti -1c .RI "void \fBcapabilities\fP (\fBseat_capability\fP const &capabilities, bool post=true)" .br .RI "seat capabilities changed " .ti -1c .RI "void \fBname\fP (std::string const &name, bool post=true)" .br .RI "unique identifier for this seat " .ti -1c .RI "bool \fBcan_name\fP () const" .br .RI "Check whether the \fBname\fP function is available with the currently bound version of the protocol\&. " .ti -1c .RI "void \fBpost_missing_capability\fP (std::string const &msg)" .br .RI "Post error: get_pointer, get_keyboard or get_touch called on seat without the matching capability\&. " .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 \fBcapabilities_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBcapabilities\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBname_since_version\fP = 2" .br .RI "Minimum protocol version required for the \fBname\fP function\&. " .in -1c .SH "Detailed Description" .PP group of input devices A seat is a group of keyboards, pointer and touch devices\&. This object is published as a global during start up, or when such a device is hot plugged\&. A seat typically has a pointer and maintains a keyboard focus and a pointer focus\&. .PP Definition at line \fB2608\fP of file \fBwayland\-server\-protocol\&.hpp\fP\&. .SH "Member Function Documentation" .PP .SS "bool seat_t::can_name () const" .PP Check whether the \fBname\fP function is available with the currently bound version of the protocol\&. .PP Definition at line \fB2601\fP of file \fBwayland\-server\-protocol\&.cpp\fP\&. .SS "void seat_t::capabilities (\fBseat_capability\fP const & capabilities, bool post = \fCtrue\fP)" .PP seat capabilities changed .PP \fBParameters\fP .RS 4 \fIcapabilities\fP capabilities of the seat .RE .PP This is emitted whenever a seat gains or loses the pointer, keyboard or touch capabilities\&. The argument is a capability enum containing the complete set of capabilities this seat has\&. .PP When the pointer capability is added, a client may create a wl_pointer object using the wl_seat\&.get_pointer request\&. This object will receive pointer events until the capability is removed in the future\&. .PP When the pointer capability is removed, a client should destroy the wl_pointer objects associated with the seat where the capability was removed, using the wl_pointer\&.release request\&. No further pointer events will be received on these objects\&. .PP In some compositors, if a seat regains the pointer capability and a client has a previously obtained wl_pointer object of version 4 or less, that object may start sending pointer events again\&. This behavior is considered a misinterpretation of the intended behavior and must not be relied upon by the client\&. wl_pointer objects of version 5 or later must not send events if created before the most recent event notifying the client of an added pointer capability\&. .PP The above behavior also applies to wl_keyboard and wl_touch with the keyboard and touch capabilities, respectively\&. .PP Definition at line \fB2591\fP of file \fBwayland\-server\-protocol\&.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 seat_t::name (std::string const & name, bool post = \fCtrue\fP)" .PP unique identifier for this seat .PP \fBParameters\fP .RS 4 \fIname\fP seat identifier .RE .PP In a multi-seat configuration the seat name can be used by clients to help identify which physical devices the seat represents\&. .PP The seat name is a UTF-8 string with no convention defined for its contents\&. Each name is unique among all wl_seat globals\&. The name is only guaranteed to be unique for the current compositor instance\&. .PP The same seat names are used for all clients\&. Thus, the name can be shared across processes to refer to a specific wl_seat global\&. .PP The name event is sent after binding to the seat global\&. This event is only sent once per seat object, and the name does not change over the lifetime of the wl_seat global\&. .PP Compositors may re-use the same seat name if the wl_seat global is destroyed and re-created later\&. .PP Definition at line \fB2596\fP of file \fBwayland\-server\-protocol\&.cpp\fP\&. .SS "std::function< void(\fBkeyboard_t\fP)> & seat_t::on_get_keyboard ()" .PP return keyboard object .PP \fBParameters\fP .RS 4 \fIid\fP seat keyboard .RE .PP The ID provided will be initialized to the wl_keyboard interface for this seat\&. .PP This request only takes effect if the seat has the keyboard capability, or has had the keyboard capability in the past\&. It is a protocol violation to issue this request on a seat that has never had the keyboard capability\&. The missing_capability error will be sent in this case\&. .PP Definition at line \fB2573\fP of file \fBwayland\-server\-protocol\&.cpp\fP\&. .SS "std::function< void(\fBpointer_t\fP)> & seat_t::on_get_pointer ()" .PP return pointer object .PP \fBParameters\fP .RS 4 \fIid\fP seat pointer .RE .PP The ID provided will be initialized to the wl_pointer interface for this seat\&. .PP This request only takes effect if the seat has the pointer capability, or has had the pointer capability in the past\&. It is a protocol violation to issue this request on a seat that has never had the pointer capability\&. The missing_capability error will be sent in this case\&. .PP Definition at line \fB2567\fP of file \fBwayland\-server\-protocol\&.cpp\fP\&. .SS "std::function< void(\fBtouch_t\fP)> & seat_t::on_get_touch ()" .PP return touch object .PP \fBParameters\fP .RS 4 \fIid\fP seat touch interface .RE .PP The ID provided will be initialized to the wl_touch interface for this seat\&. .PP This request only takes effect if the seat has the touch capability, or has had the touch capability in the past\&. It is a protocol violation to issue this request on a seat that has never had the touch capability\&. The missing_capability error will be sent in this case\&. .PP Definition at line \fB2579\fP of file \fBwayland\-server\-protocol\&.cpp\fP\&. .SS "std::function< void()> & seat_t::on_release ()" .PP release the seat object Using this request a client can tell the server that it is not going to use the seat object anymore\&. .PP Definition at line \fB2585\fP of file \fBwayland\-server\-protocol\&.cpp\fP\&. .SS "void seat_t::post_missing_capability (std::string const & msg)" .PP Post error: get_pointer, get_keyboard or get_touch called on seat without the matching capability\&. .PP Definition at line \fB2606\fP of file \fBwayland\-server\-protocol\&.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 .SH "Member Data Documentation" .PP .SS "constexpr std::uint32_t wayland::server::seat_t::capabilities_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBcapabilities\fP function\&. .PP Definition at line \fB2723\fP of file \fBwayland\-server\-protocol\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::seat_t::name_since_version = 2\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBname\fP function\&. .PP Definition at line \fB2750\fP of file \fBwayland\-server\-protocol\&.hpp\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Wayland++ from the source code\&.