.TH "wayland::server::zwp_confined_pointer_v1_t" 3 "Wed May 1 2024 17:27:19" "Version 1.0.0" "Wayland++" \" -*- nroff -*- .ad l .nh .SH NAME wayland::server::zwp_confined_pointer_v1_t \- confined pointer object .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 confined pointer object " .ti -1c .RI "std::function< void(\fBregion_t\fP)> & \fBon_set_region\fP ()" .br .RI "set a new confine region " .ti -1c .RI "void \fBconfined\fP (bool post=true)" .br .RI "pointer confined " .ti -1c .RI "void \fBunconfined\fP (bool post=true)" .br .RI "pointer unconfined " .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 \fBconfined_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBconfined\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBunconfined_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBunconfined\fP function\&. " .in -1c .SH "Detailed Description" .PP confined pointer object The wp_confined_pointer interface represents a confined pointer state\&. .PP This object will send the event 'confined' when the confinement is activated\&. Whenever the confinement is activated, it is guaranteed that the surface the pointer is confined to will already have received pointer focus and that the pointer will be within the region passed to the request creating this object\&. It is up to the compositor to decide whether this requires some user interaction and if the pointer will warp to within the passed region if outside\&. .PP To unconfine the pointer, send the destroy request\&. This will also destroy the wp_confined_pointer object\&. .PP If the compositor decides to unconfine the pointer the unconfined event is sent\&. The wp_confined_pointer object is at this point defunct and should be destroyed\&. .PP Definition at line \fB3001\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Member Function Documentation" .PP .SS "void zwp_confined_pointer_v1_t::confined (bool post = \fCtrue\fP)" .PP pointer confined Notification that the pointer confinement of the seat's pointer is activated\&. .PP Definition at line \fB5509\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 "std::function< void()> & zwp_confined_pointer_v1_t::on_destroy ()" .PP destroy the confined pointer object Destroy the confined pointer object\&. If applicable, the compositor will unconfine the pointer\&. .PP Definition at line \fB5497\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void(\fBregion_t\fP)> & zwp_confined_pointer_v1_t::on_set_region ()" .PP set a new confine region .PP \fBParameters\fP .RS 4 \fIregion\fP region of surface .RE .PP Set a new region used to confine the pointer\&. .PP The new confine region is double-buffered\&. The new confine region will only take effect when the associated surface gets its pending state applied\&. See wl_surface\&.commit for details\&. .PP If the confinement is active when the new confinement region is applied and the pointer ends up outside of newly applied region, the pointer may warped to a position within the new confinement region\&. If warped, a wl_pointer\&.motion event will be emitted, but no wp_relative_pointer\&.relative_motion event\&. .PP The compositor may also, instead of using the new region, unconfine the pointer\&. .PP For details about the confine region, see wp_confined_pointer\&. .PP Definition at line \fB5503\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_confined_pointer_v1_t::unconfined (bool post = \fCtrue\fP)" .PP pointer unconfined Notification that the pointer confinement of the seat's pointer is no longer active\&. If this is a oneshot pointer confinement (see wp_pointer_constraints\&.lifetime) this object is now defunct and should be destroyed\&. If this is a persistent pointer confinement (see wp_pointer_constraints\&.lifetime) this pointer confinement may again reactivate in the future\&. .PP Definition at line \fB5514\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SH "Member Data Documentation" .PP .SS "constexpr std::uint32_t wayland::server::zwp_confined_pointer_v1_t::confined_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBconfined\fP function\&. .PP Definition at line \fB3069\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_confined_pointer_v1_t::unconfined_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBunconfined\fP function\&. .PP Definition at line \fB3085\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Wayland++ from the source code\&.