wayland::zwp_x...b_manager_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

✨ NAME ✨

okay bestie, you're looking at wayland::zwp_x...b_manager_v1_t from the Wayland++ manual, and it is literally the context object for keyboard grab manager. that's the whole name vibe 🎀

🦋 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

  • zwp_xwayland_keyboard_grab_v1_t grab_keyboard (surface_t const &surface, seat_t const &seat) — grab the keyboard to a surface
  • 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 grab_keyboard_since_version = 1 — Minimum protocol version required for the grab_keyboard function.

💖 Detailed Description 💖

context object for keyboard grab manager

A global interface used for grabbing the keyboard.

Definition at line 8885 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 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.

🌟 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 303 of file wayland-client.hpp.

🎀 zwp_xwayland_keyboard_grab_v1_t zwp_xwayland_keyboard_grab_manager_v1_t::grab_keyboard (surface_t const & surface, seat_t const & seat)

grab the keyboard to a surface

Parameters

  • surface — surface to report keyboard events to
  • seat — the seat for which the keyboard should be grabbed

The grab_keyboard request asks for a grab of the keyboard, forcing the keyboard focus for the given seat upon the given surface.

The protocol provides no guarantee that the grab is ever satisfied, and does not require the compositor to send an error if the grab cannot ever be satisfied. It is thus possible to request a keyboard grab that will never be effective.

The protocol:

  • does not guarantee that the grab itself is applied for a surface, the grab request may be silently ignored by the compositor,
  • does not guarantee that any events are sent to this client even if the grab is applied to a surface,
  • does not guarantee that events sent to this client are exhaustive, a compositor may filter some events for its own consumption,
  • does not guarantee that events sent to this client are continuous, a compositor may change and reroute keyboard events while the grab is nominally active.

Definition at line 10224 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.

💜 Member Data Documentation 💜

std::uint32_t wayland::zwp_xwayland_keyboard_grab_manager_v1_t::grab_keyboard_since_version = 1 [static], [constexpr]

Minimum protocol version required for the grab_keyboard function.

Definition at line 8936 of file wayland-client-protocol-unstable.hpp.

🌈 Author 🌈

Generated automatically by Doxygen for Wayland++ from the source code.

okay bestie, that's the whole tea: Version 1.0.1, dated Fri Mar 27 2026, straight from the Wayland++ source. mwah 💋✨

📦 where this page comes from