wayland::zwp_x...oard_grab_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💖 NAME 💖

okay bestie, welcome to the wayland::zwp_xwayland_keyboard_grab_v1_t page from the Wayland++ manual, section 3. This is literally the interface for grabbing the keyboard — the whole vibe is “a global interface used for grabbing the keyboard,” and yes, that’s the official summary. 🎀

✨ SYNOPSIS ✨

#include <wayland-client-protocol-unstable.hpp>

Inherits wayland::proxy_t. 💅

🌸 Public Types 🌸

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the wrapper-type enum, with all four flavors listed below.

🦋 Public Member Functions 🦋

  • 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 🦋

interface for grabbing the keyboard

A global interface used for grabbing the keyboard. That’s the whole personality, bestie — it’s a global interface, and it grabs the keyboard. Slay. 💅

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

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.

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.

⚠️ caveat, bestie: 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. 🤖✨

okay bestie, that’s the whole page — this was Wayland++ version 1.0.1, dated Fri Mar 27 2026, generated automatically by Doxygen for Wayland++ from the source code. mwah 💋💖✨

📦 where this page comes from