wayland::xdg_activation_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::xdg_activation_v1_t(3) — the Wayland++ glow-up

okay so bestie, welcome to the wayland::xdg_activation_v1_t page from the Wayland++ manual. yes, section 3, library functions, we're in our C++ era ✨

✨ NAME ✨

wayland::xdg_activation_v1_t — literally the interface for activating surfaces, no cap 🫶

🌸 SYNOPSIS 🌸

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

Inherits wayland::proxy_t. it's giving "I get all my proxy powers from my parent" 💅

🎀 Public Types

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the four flavors of wrapper, more on these below 👑

🦋 Public Member Functions

  • xdg_activation_token_v1_t get_activation_token () — requests a token ✨
  • void activate (std::string const &token, surface_t const &surface) — notify new interaction being available 🔥
  • 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_activation_token_since_version = 1 — Minimum protocol version required for the get_activation_token function.
  • static constexpr std::uint32_t activate_since_version = 1 — Minimum protocol version required for the activate function.

👑 Detailed Description 👑

interface for activating surfaces 💖

A global interface used for informing the compositor about applications being activated or started, or for applications to request to be activated. so basically it's the "hey bestie, I'm here, notice me" of the Wayland world 🎀

Definition at line 6671 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. lowkey this enum is the main character of memory management 🧚

Enumerators

  • 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 classic, the blueprint, the moment ✨
  • 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. very "different vibes but still valid" 💜
  • 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. ⚠️ not yours, don't touch it, keep it brief bestie — this is a look-don't-touch situation, fr fr
  • 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. 🫶 it holds your hand so you don't get dropped
Definition at line 117 of file wayland-client.hpp.

💫 Member Function Documentation 💫

void xdg_activation_v1_t::activate (std::string const & token, surface_t const & surface)

notify new interaction being available 🔔

Parameters

  • token — the activation token of the initiating client 🎫
  • surface — the wl_surface to activate 🖼️

Requests surface activation. It's up to the compositor to display this information as desired, for example by placing the surface above the rest. so like, you're asking politely, not demanding 💅

The compositor may know who requested this by checking the activation token and might decide not to follow through with the activation if it's considered unwanted. 😭 okay so the compositor can absolutely leave you on read, that's canon

Compositors can ignore unknown presentation tokens when an invalid token is passed. so don't pass a fake token and expect magic ✨

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

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. 💀 no object, no pointer, just vibes and a throw

xdg_activation_token_v1_t xdg_activation_v1_t::get_activation_token ()

requests a token 🎫 Creates an xdg_activation_token_v1 object that will provide the initiating client with a unique token for this activation. This token should be offered to the clients to be activated. it's the friendship bracelet you hand over so the other client knows you're legit 🫶

Definition at line 8671 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. name reveal ✨

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. yes, that's exactly how it's worded, I'm not fixing it, it's iconic 🙈

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. ⚠️ zero means "idk bestie, guess safely"

display_t will always return version 0. always. every time. no exceptions 👑

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. vibe check on your wrapper 🌸

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. is there a real object in there or are we just pretty? 😭

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

Check whether two wrappers refer to different objects. not the same, periodt 💅

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

Check whether two wrappers refer to the same object. same object, same energy, matched 🎀

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. same question as operator bool, same answer, we love a consistent queen ✨

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. 🚫 so display_t said "I'm not leaving" and honestly? respect

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. you're rerouting the mail, basically 📬

See also: display_t::dispatch_queue().

Examples

proxy_wrapper.cpp.

🍓 Member Data Documentation 🍓

std::uint32_t wayland::xdg_activation_v1_t::activate_since_version = 1 [static], [constexpr]

Minimum protocol version required for the activate function. version 1 and up, we been here since day one 💜

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

std::uint32_t wayland::xdg_activation_v1_t::get_activation_token_since_version = 1 [static], [constexpr]

Minimum protocol version required for the get_activation_token function. also version 1, twinning with the one above 🎀

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

🧚 Author 🧚

Generated automatically by Doxygen for Wayland++ from the source code. not me being auto-generated by Doxygen and still serving looks 💅

and that's the page bestie!! 💖 this was Version 1.0.1, dated Fri Mar 27 2026 13:1, brought to you by Wayland++ — go activate something iconic 🌈⭐🦋

📦 where this page comes from