context object for keyboard shortcuts inhibitor More...
#include <wayland-client-protocol-unstable.hpp>
Public Types | |
| enum | wrapper_type { wrapper_type::standard, wrapper_type::display, wrapper_type::foreign, wrapper_type::proxy_wrapper } |
Public Member Functions | |
| std::function< void()> & | on_active () |
| shortcuts are inhibited More... | |
| std::function< void()> & | on_inactive () |
| shortcuts are restored More... | |
| uint32_t | get_id () const |
| Get the id of a proxy object. More... | |
| std::string | get_class () const |
| Get the interface name (class) of a proxy object. More... | |
| uint32_t | get_version () const |
| Get the protocol object version of a proxy object. More... | |
| wrapper_type | get_wrapper_type () const |
| Get the type of a proxy object. More... | |
| void | set_queue (event_queue_t queue) |
| Assign a proxy to an event queue. More... | |
| wl_proxy * | c_ptr () const |
| Get a pointer to the underlying C struct. More... | |
| bool | proxy_has_object () const |
| Check whether this wrapper actually wraps an object. More... | |
| operator bool () const | |
| Check whether this wrapper actually wraps an object. More... | |
| bool | operator== (const proxy_t &right) const |
| Check whether two wrappers refer to the same object. More... | |
| bool | operator!= (const proxy_t &right) const |
| Check whether two wrappers refer to different objects. More... | |
| void | proxy_release () |
| Release the wrapped object (if any), making this an empty wrapper. More... | |
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 1369 of file wayland-client-protocol-unstable.hpp.
Member Enumeration Documentation
◆ wrapper_type
|
stronginherited |
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 105 of file wayland-client.hpp.
Member Function Documentation
◆ c_ptr()
|
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
◆ get_class()
|
inherited |
Get the interface name (class) of a proxy object.
- Returns
- The interface name of the object associated with the proxy
◆ get_id()
|
inherited |
◆ get_version()
|
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
◆ get_wrapper_type()
|
inlineinherited |
Get the type of a proxy object.
Definition at line 288 of file wayland-client.hpp.
◆ on_active()
| 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 4843 of file wayland-client-protocol-unstable.cpp.
◆ on_inactive()
| 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 4848 of file wayland-client-protocol-unstable.cpp.
◆ operator bool()
|
inherited |
Check whether this wrapper actually wraps an object.
- Returns
- true if there is an underlying object, false if this wrapper is empty
◆ operator!=()
|
inherited |
Check whether two wrappers refer to different objects.
◆ operator==()
|
inherited |
Check whether two wrappers refer to the same object.
◆ proxy_has_object()
|
inherited |
Check whether this wrapper actually wraps an object.
- Returns
- true if there is an underlying object, false if this wrapper is empty
◆ 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.
◆ set_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.
The documentation for this class was generated from the following files:
