wayland::zwp_input_panel_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::zwp_input_panel_v1_t — the Wayland++ manual, bestie edition 🎀

okay so you're reading the wayland::zwp_input_panel_v1_t(3) page from the Wayland++ manual and honestly? iconic of you. let's get into it ✨

🌸 NAME 🌸

wayland::zwp_input_panel_v1_t — the interface for implementing keyboards, no cap.

✨ SYNOPSIS ✨

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

it inherits from wayland::proxy_t, periodt. 🫶

🦋 Public Types 🦋

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the four flavors, bestie.

💜 Public Member Functions 💜

  • zwp_input_panel_surface_v1_t get_input_panel_surface (surface_t const &surface) — grab yourself an input panel 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 (yes, again, but make it operator-y).
  • 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 get_input_panel_surface_since_version = 1 — the minimum protocol version required for the get_input_panel_surface function. lowkey important, don't skip it 💀

🧚 Detailed Description 🧚

interface for implementing keyboards

Only one client can bind this interface at a time. like. one. client. that's it. that's the whole vibe check 🙈

Definition at line 1059 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. so basically this enum is the main character of the proxy lifecycle 🌈

the enumerators, bestie:

  • 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 😭 (fr fr, it will not be cute about it).

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

💜 zwp_input_panel_surface_v1_t zwp_input_panel_v1_t::get_input_panel_surface (surface_t const & surface) 💜

Parameters:

  • surface — that's the surface, bestie.
Definition at line 4802 of file wayland-client-protocol-unstable.cpp.

🌟 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. like, you're on your own, king 👑

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.

🌸 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. yes, that's the whole thing, she's simple and she slays.

💅 bool wayland::proxy_t::operator== (const proxy_t & right) const [inherited] 💅

Check whether two wrappers refer to the same object. the matching set to the one above, we love consistency 🫶

⭐ 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. it's giving "redirect the group chat" energy ngl 🌈

See also: display_t::dispatch_queue().

Examples: proxy_wrapper.cpp.

🎀 Member Data Documentation 🎀

💫 std::uint32_t wayland::zwp_input_panel_v1_t::get_input_panel_surface_since_version = 1 [static], [constexpr] 💫

Minimum protocol version required for the get_input_panel_surface function.

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

🌈 Author 🌈

Generated automatically by Doxygen for Wayland++ from the source code. not a human, not a vibe, just doxygen doing doxygen things 😭

okay that's the whole page, nothing skipped, nothing merged, every single flag and function accounted for. you ate this, bestie 💅✨

Version 1.0.1 🦋 Fri Mar 27 2026 — mwah, that's the whole sign-off, see you in the next man page 🎀💖🫶

📦 where this page comes from