wayland::zwp_t...t_manager_v3_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::zwp_t...t_manager_v3_t(3) — Wayland++ manual, bestie edition ✨

Okay so this is a page from the Wayland++ manual, and no cap, it's a whole vibe. We're talking zwp_text_input_manager_v3_t and all the inherited proxy_t goodies that come with it. Sit down, grab a strawberry drink 🍓, and let's get into it.

✨ NAME ✨

wayland::zwp_text_input_manager_v3_t — the text input manager, periodt. 👑

🦋 SYNOPSIS 🦋

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

Lowkey important: this bad boy inherits wayland::proxy_t. So everything proxy_t can do, she can do too. Main character energy fr fr. 💅

🎀 Public Types

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper }

🌸 Public Member Functions

  • zwp_text_input_v3_t get_text_input (seat_t const &seat) — create a new text input object
  • 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 get_text_input_since_version = 1 — Minimum protocol version required for the get_text_input function.

💖 Detailed Description 💖

text input manager 🫶

A factory for text-input objects. This object is a global singleton — think one per whole compositor, iykyk.

Defined at line 6627 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. Basically the "what kind of girl is this wrapper" enum. 💀

🌟 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. Your basic textbook 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. She's a little different, okay.
  • 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. 🙈 Like, don't get attached.
  • 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. 🎀
Defined 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. 😭 Yes, thrown, so handle her gently.

🌸 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_text_input_v3_t zwp_text_input_manager_v3_t::get_text_input (seat_t const & seat)

create a new text input object ✨

Parameters

  • seat

Creates a new text-input object for a given seat. She's your seat's personal text input bestie now. 🫶

Defined at line 8608 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. Ngl, that's a red flag, so be careful. 🙈

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.

Defined 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. 💅 Like, she said no.

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_text_input_manager_v3_t::get_text_input_since_version = 1 [static], [constexpr]

Minimum protocol version required for the get_text_input function. Like, version 1 or nothing, bestie.

Defined at line 6659 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. 🤖✨

okay that's the whole page, no cap, every flag and every line kept. Slay. 💅🫶

Sign-off time 🎀 — this icon of a page is Version 1.0.1, dated Fri Mar 27 2026, served fresh from the Wayland++ / Doxygen kitchen. Bye bestie, go write some text input code! 🌸🦋💖

📦 where this page comes from