wayland::zwp_t...t_manager_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

✨ wayland::zwp_text_input_manager_v1_t(3) — Wayland++ ✨

okay so bestie, welcome to the group chat 😌 this one's a page from the Wayland++ manual, section 3, and honestly? it's giving "small but mighty." let's get into it 💅

🦋 NAME 🦋

wayland::zwp_text_input_manager_v1_t — the text input manager, periodt. that's the whole name, that's the whole job 💖

🌸 SYNOPSIS 🌸

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

Inherits wayland::proxy_t. so yeah, it's a proxy at heart, bestie, it just has text input manager main character energy ✨

🎀 Public Types 🎀

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the four flavors of proxy wrapper, we'll get into each one below, don't worry 🫶

💖 Public Member Functions 💖

  • zwp_text_input_v1_t create_text_input () — create text input, literally its whole personality
  • 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 as a conversion, slay)
  • 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 create_text_input_since_version = 1 — minimum protocol version required for the create_text_input function. so like, version 1 is the floor, no notes 🌈

👑 Detailed Description 👑

text input manager 💅

A factory for text_input objects. This object is a global singleton. iykyk — one manager to rule them all 🧚

Definition at line 6099 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. this is the vibe check for wrappers, fr fr 🔥

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. the default, the classic, the icon 👑
  • 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. extra special, does its own thing 💫
  • 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. ⚠️ hands off bestie, it's not yours ⚠️
  • 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. keeping each other alive, we love to see it 🫶
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, check first, okay?

🎀 zwp_text_input_v1_t zwp_text_input_manager_v1_t::create_text_input ()

create text input. Creates a new text_input object. the factory doing exactly what a factory does 💖

Definition at line 8381 of file wayland-client-protocol-unstable.cpp.

💜 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 cap, don't assume anything fancy 💀

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.

💖 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. 🙈 rude, but okay.

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. so like, routing your notifications to a different folder, iconic behavior 📬

See also: display_t::dispatch_queue().

Examples — proxy_wrapper.cpp.

🧚 Member Data Documentation 🧚

💫 std::uint32_t wayland::zwp_text_input_manager_v1_t::create_text_input_since_version = 1 [static], [constexpr]

Minimum protocol version required for the create_text_input function. version 1 and up, bestie, that's the bar ⭐

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

🎀 Author 🎀

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

and that's the whole page, bestie!! 🦋 before you close the tab: Version 1.0.1, dated Fri Mar 27 2026, from the Wayland++ docs 🫶 go forth and make text inputs, you've got this 👑💅

📦 where this page comes from