Provided by: waylandpp-dev_1.0.0-3_amd64 
NAME
wayland::zwp_confined_pointer_v1_t - confined pointer object
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
void set_region (region_t const ®ion)
set a new confine region
std::function< void()> & on_confined ()
pointer confined
std::function< void()> & on_unconfined ()
pointer unconfined
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.
Static Public Attributes
static constexpr std::uint32_t set_region_since_version = 1
Minimum protocol version required for the set_region function.
Detailed Description
confined pointer object
The wp_confined_pointer interface represents a confined pointer state.
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.
To unconfine the pointer, send the destroy request. This will also destroy the
wp_confined_pointer object.
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.
Definition at line 2715 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_confined_pointer_v1_t::on_confined ()
pointer confined Notification that the pointer confinement of the seat's pointer is
activated.
Definition at line 5921 of file wayland-client-protocol-unstable.cpp.
std::function< void()> & zwp_confined_pointer_v1_t::on_unconfined ()
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.
Definition at line 5926 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().
void zwp_confined_pointer_v1_t::set_region (region_t const & region)
set a new confine region
Parameters
region region of surface
Set a new region used to confine the pointer.
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.
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.
The compositor may also, instead of using the new region, unconfine the pointer.
For details about the confine region, see wp_confined_pointer.
Definition at line 5915 of file wayland-client-protocol-unstable.cpp.
Member Data Documentation
constexpr std::uint32_t wayland::zwp_confined_pointer_v1_t::set_region_since_version = 1
[static], [constexpr]
Minimum protocol version required for the set_region function.
Definition at line 2764 of file wayland-client-protocol-unstable.hpp.
Author
Generated automatically by Doxygen for Wayland++ from the source code.