wayland::zwp_input_method_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💖 NAME 💖

wayland::zwp_input_method_v1_t(3) — the Wayland++ input method class, bestie ✨. It's the input method object, and yes it inherits wayland::proxy_t.

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

💅 Public Member Functions 💅

  • std::function< void(zwp_input_method_context_v1_t)> & on_activate () — activate event
  • std::function< void(zwp_input_method_context_v1_t)> & on_deactivate () — deactivate event
  • 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 🌸

input method — okay so this is the whole vibe: an input method object is responsible for composing text in response to input from hardware or virtual keyboards. There is one input method object per seat. On activate there is a new input method context object created which allows the input method to communicate with the text input. No cap, that's the main character energy of this class 💫.

Definition at line 1008 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. It's giving "know your wrapper, know your life" ✨.

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

💖 std::function< void(zwp_input_method_context_v1_t)> & zwp_input_method_v1_t::on_activate ()

Activate event.

Parameters: id

A text input was activated. Creates an input method context object which allows communication with the text input.

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

🎀 std::function< void(zwp_input_method_context_v1_t)> & zwp_input_method_v1_t::on_deactivate ()

Deactivate event.

Parameters: context

The text input corresponding to the context argument was deactivated. The input method context should be destroyed after deactivation is handled.

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

🌺 Author 🌺

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

okay that's the whole page, bestie 💖 Version 1.0.1 • Fri Mar 27 2026 • source/version footer gremlin: 13wayland::zwp_input_method_v1_t(3) — mwah, go make that text input communicate ✨💅

📦 where this page comes from