wayland::zxdg_exported_v2_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

✨ wayland::zxdg_exported_v2_t ✨

bestie, welcome to the Wayland++ glow-up 💅. this page is literally about wayland::zxdg_exported_v2_t — an exported surface handle. no cap, it's giving "main character energy" for surfaces that need to be referenced across clients 🦋.

🌸 NAME 🌸

wayland::zxdg_exported_v2_t — an exported surface handle 🫶

🎀 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 vibe check for what kind of C pointer this wrapper is holding ✨

🌈 Public Member Functions 🌈

  • std::function< void(std::string)> & on_handle () — the exported surface handle, bestie 🎀
  • 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. lowkey important 👑

🦋 Detailed Description 🦋

okay so, an xdg_exported object represents an exported reference to a surface. the exported surface may be referenced as long as the xdg_exported object is not destroyed. destroying the xdg_exported invalidates any relationship the importer may have established using xdg_imported. so like… don't destroy it while someone's still using it, bestie 😭💀.

Definition at line 7368 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 "what am I even holding?" enum, iykyk.

✨ 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. classic, no cap 💅.
  • 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. this one's special 🫶.
  • 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 🔥.
  • 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. very demure, very mindful 🌸.
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… guard your heart and your pointers 🙈.

🧚 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. it's giving "who dis?" energy 💅.

⭐ 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. every object has a government name, periodt 🎀.

🌈 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. no version? no cap, be safe bestie 😭.

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(std::string)> & zxdg_exported_v2_t::on_handle () 🌸

the exported surface handle. this is the whole point of the page, bestie 🫶.

Parameters: handle — the exported surface handle.

The handle event contains the unique handle of this exported surface reference. It may be shared with any client, which then can use it to import the surface by calling xdg_importer.import_toplevel. A handle may be used to import the surface multiple times. so like… it's shareable, iconic, and reusable 💅✨.

Definition at line 9373 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. vibe check: are you real or are you a ghost? 👻.

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

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

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

Check whether two wrappers refer to the same object. twins fr fr 👯‍♀️.

🎀 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 energy as operator bool, but make it a method 💖.

👑 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 like… you can't release the display, bestie, it's not that kind of party 🙈.

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 "sort your notifications" energy 📲.

See also: display_t::dispatch_queue().

Examples: proxy_wrapper.cpp.

🌟 Author 🌟

Generated automatically by Doxygen for Wayland++ from the source code. the robots did this, not me 💀.

🌸 Version 1.0.1 🌸

okay bestie, we're literally at version 1.0.1 and this whole page was cooked up on Fri Mar 27 2026 13:15. that's the sign-off — now go export some surfaces and slay 💅✨🦋.

📦 where this page comes from