Provided by: waylandpp-dev_1.0.0-6_amd64 
NAME
wayland::zwp_keyboard_shortcuts_inhibitor_v1_t - context object for keyboard shortcuts inhibitor
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()> & on_active ()
shortcuts are inhibited
std::function< void()> & on_inactive ()
shortcuts are restored
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
context object for keyboard shortcuts inhibitor
A keyboard shortcuts inhibitor instructs the compositor to ignore its own keyboard shortcuts when the
associated surface has keyboard focus. As a result, when the surface has keyboard focus on the given
seat, it will receive all key events originating from the specified seat, even those which would normally
be caught by the compositor for its own shortcuts.
The Wayland compositor is however under no obligation to disable all of its shortcuts, and may keep some
special key combo for its own use, including but not limited to one allowing the user to forcibly restore
normal keyboard events routing in the case of an unwilling client. The compositor may also use the same
key combo to reactivate an existing shortcut inhibitor that was previously deactivated on user request.
When the compositor restores its own keyboard shortcuts, an 'inactive' event is emitted to notify the
client that the keyboard shortcuts inhibitor is not effectively active for the surface and seat any more,
and the client should not expect to receive all keyboard events.
When the keyboard shortcuts inhibitor is inactive, the client has no way to forcibly reactivate the
keyboard shortcuts inhibitor.
The user can chose to re-enable a previously deactivated keyboard shortcuts inhibitor using any mechanism
the compositor may offer, in which case the compositor will send an 'active' event to notify the client.
If the surface is destroyed, unmapped, or loses the seat's keyboard focus, the keyboard shortcuts
inhibitor becomes irrelevant and the compositor will restore its own keyboard shortcuts but no 'inactive'
event is emitted in this case.
Definition at line 1395 of file wayland-client-protocol-unstable.hpp.
Member Enumeration Documentation
enum class 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 116 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 302 of file wayland-client.hpp.
std::function< void()> & zwp_keyboard_shortcuts_inhibitor_v1_t::on_active ()
shortcuts are inhibited This event indicates that the shortcut inhibitor is active.
The compositor sends this event every time compositor shortcuts are inhibited on behalf of the surface.
When active, the client may receive input events normally reserved by the compositor (see
zwp_keyboard_shortcuts_inhibitor_v1).
This occurs typically when the initial request 'inhibit_shortcuts' first becomes active or when the user
instructs the compositor to re-enable and existing shortcuts inhibitor using any mechanism offered by the
compositor.
Definition at line 5141 of file wayland-client-protocol-unstable.cpp.
std::function< void()> & zwp_keyboard_shortcuts_inhibitor_v1_t::on_inactive ()
shortcuts are restored This event indicates that the shortcuts inhibitor is inactive, normal shortcuts
processing is restored by the compositor.
Definition at line 5146 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.
Examples
foreign_display.cpp.
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().
Examples
proxy_wrapper.cpp.
Author
Generated automatically by Doxygen for Wayland++ from the source code.
Version 1.0.0 Wed May 1 2024 17:wayland::zwp_keyboard_shortcuts_inhibitor_v1_t(3)