wayland::zxdg_imported_v2_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::zxdg_imported_v2_t(3) — the imported surface handle, bestie

okay so you're reading the Wayland++ manual, section 3, and the star of the show is wayland::zxdg_imported_v2_t 🎀 this is the page for it, and yes it's a whole vibe. let's get into it.

✨ NAME ✨

wayland::zxdg_imported_v2_t — an imported surface handle 🫶

🌸 SYNOPSIS 🌸

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

so iconic, it inherits wayland::proxy_t 👑

🦋 Public Types

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the whole little family of proxy flavours, listed out for you.

🎀 Public Member Functions

  • void set_parent_of (surface_t const &surface) — set as the parent of some surface
  • std::function< void()> & on_destroyed () — the imported surface handle has been destroyed
  • 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 set_parent_of_since_version = 1 — Minimum protocol version required for the set_parent_of function.

🌈 Detailed Description 🌈

an imported surface handle 💅

so like, an xdg_imported object represents an imported reference to a surface exported by some client. a client can use this interface to manipulate relationships between its own surfaces and the imported surface. that's the whole thing — no cap.

ngl, this is literally defined at line 7412 of 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 lore 🧚

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.
  • 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. 😭 (respect other people's objects, 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.
defined at line 117 of wayland-client.hpp 🎀

💖 Member Function Documentation 💖

wl_proxy * wayland::proxy_t::c_ptr () const [inherited]

Get a pointer to the underlying C struct. it's giving "hand me the raw thing" ✨

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. main character identification energy 👑

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. every object gets its own little ID card 🪪

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. (yes bestie, guessing is on you 💀)

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. which flavour of proxy are we today 🍓

defined at line 303 of wayland-client.hpp

std::function< void()> & zxdg_imported_v2_t::on_destroyed ()

the imported surface handle has been destroyed 🫠 The imported surface handle has been destroyed and any relationship set up has been invalidated. This may happen for various reasons, for example if the exported surface or the exported surface handle has been destroyed, if the handle used for importing was invalid.

defined at line 9447 of wayland-client-protocol-unstable.cpp 📍

wayland::proxy_t::operator bool () const [inherited]

Check whether this wrapper actually wraps an object. vibe check on the wrapper itself 🦋

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. not the same, not the same 🙈

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

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

bool wayland::proxy_t::proxy_has_object () const [inherited]

Check whether this wrapper actually wraps an object. (yes it's the bool-operator's twin, they're matching 👯)

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

careful bestie — note that display_t instances cannot be released this way. attempts to do so are ignored. 💀

Examples: foreign_display.cpp.

void zxdg_imported_v2_t::set_parent_of (surface_t const & surface)

set as the parent of some surface 👑

Parameters: surface — the child surface

Set the imported surface as the parent of some surface of the client. The passed surface must be an xdg_toplevel equivalent, otherwise an invalid_surface protocol error is sent. ‼️ Calling this function sets up a surface to surface relation with the same stacking and positioning semantics as xdg_toplevel.set_parent.

defined at line 9441 of wayland-client-protocol-unstable.cpp 📍

void wayland::proxy_t::set_queue (event_queue_t queue) [inherited]

Assign a proxy to an event queue. sending it to a different group chat 💌

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

Minimum protocol version required for the set_parent_of function. like, the bare minimum version, she said 💅

defined at line 7449 of wayland-client-protocol-unstable.hpp 📍

🌟 Author 🌟

Generated automatically by Doxygen for Wayland++ from the source code. (not a human, just a very diligent little robot 🤖✨)

🎀 and that's the page!! Version 1.0.1, dated Fri Mar 27 2026 13:15 — write it down bestie, iykyk, periodt 💖🦋🌈
📦 where this page comes from