wayland::zwp_k...t_manager_v1_t(3)
💅 wayland::zwp_keyboard_shortcuts_inhibit_manager_v1_t — no cap, the whole page
okay bestie, welcome to the Wayland++ manual page for wayland::zwp_keyboard_shortcuts_inhibit_manager_v1_t. Yes that name is a mouthful, yes we're gonna say it, and yes it's lowkey iconic. This is wayland::zwp_k...t_manager_v1_t(3) in the Wayland++ section, and I'm obsessed that you're here. 💖
✨ NAME ✨
wayland::zwp_keyboard_shortcuts_inhibit_manager_v1_t — a context object for the keyboard grab_manager. That's literally the whole vibe: it's the manager-y object that handles the keyboard shortcut inhibiting situation. 🎀
🌸 SYNOPSIS 🌸
#include <wayland-client-protocol-unstable.hpp>It inherits from wayland::proxy_t, so it gets all the proxy bestie behaviour for free. 💅
🦋 Public Types 🦋
enum class wrapper_type { standard, display, foreign, proxy_wrapper }— the enum that tells you what kind of underlyingwl_proxyyou're dealing with, and how construction, destruction and event handling should go. (Details down in the enum section, don't worry 🫶)
🌈 Public Member Functions 🌈
zwp_keyboard_shortcuts_inhibitor_v1_t inhibit_shortcuts(surface_t const &surface, seat_t const &seat)— create a fresh new keyboard shortcuts inhibitor object, slay.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— also check whether this wrapper actually wraps an object (yes, twice, it's giving 🫶).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 inhibit_shortcuts_since_version = 1— the minimum protocol version required for theinhibit_shortcutsfunction. So if your composer/compositor isn't at version 1... bestie. 😭
🎀 Detailed Description 🎀
Context object for keyboard grab_manager. Periodt.
It's a global interface used for inhibiting the compositor keyboard shortcuts. Definition at line 1308 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. Here are the enums, and every single one matters:
standard— C pointer is a standard type compatible withwl_proxy*. Events are dispatched and it is destructed when theproxy_tis destructed. User data is set.display— C pointer is awl_display*. No events are dispatched,wl_display_disconnectis called when theproxy_tis destructed. User data is set.foreign— C pointer is a standard type compatible withwl_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_destroyis not called when theproxy_tis destructed, user data is not touched. Consequently, there is no reference counting for theproxy_t. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy thewl_proxy. 🙈proxy_wrapper— C pointer is awl_proxy*that was constructed withwl_proxy_create_wrapper. No events are dispatched,wl_proxy_wrapper_destroyis called when theproxy_tis destroyed. Reference counting is active. A reference to theproxy_tcreating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.
Definition at line 117 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. So like... handle that, bestie. 😭
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. No vibes-based guessing, fr fr.
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 303 of file wayland-client.hpp.
zwp_keyboard_shortcuts_inhibitor_v1_t zwp_keyboard_shortcuts_inhibit_manager_v1_t::inhibit_shortcuts(surface_t const &surface, seat_t const &seat)
Create a new keyboard shortcuts inhibitor object. This is the main character function of the whole page, ngl. 👑
Parameters
- surface — the surface that inhibits the keyboard shortcuts behavior
- seat — the
wl_seatfor which keyboard shortcuts should be disabled
Create a new keyboard shortcuts inhibitor object associated with the given surface for the given seat.
⚠️ Heads up babes: if shortcuts are already inhibited for the specified seat and surface, a protocol error "already_inhibited" is raised by the compositor. So like, don't double-inhibit. 💀
Definition at line 5077 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. Literally ignored. Rude but valid.
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.
🍓 Member Data Documentation 🍓
std::uint32_t wayland::zwp_keyboard_shortcuts_inhibit_manager_v1_t::inhibit_shortcuts_since_version = 1 [static], [constexpr]
Minimum protocol version required for the inhibit_shortcuts function. It's 1, bestie. Version 1 or bust. ✨
Definition at line 1345 of file wayland-client-protocol-unstable.hpp.
👑 Author 👑
Generated automatically by Doxygen for Wayland++ from the source code. Like, it wrote itself, and honestly? Ate. 💅
🌈 And that's the whole thing! This icon of a page is Version 1.0.1, dated Fri Mar 27 2026, brought to you by Wayland++ and generated by Doxygen. Go inhibit some shortcuts responsibly, mwah! 💖🎀🦋🌸🫶
📦 where this page comes from
- ubuntu stonking: waylandpp-dev 1.0.1-2 · BSD-2-Clause
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms