wayland::serv..._imported_v2_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::serv..._imported_v2_t(3) — Wayland++

okay so bestie, welcome to the page for wayland::server::zxdg_imported_v2_t — it's an imported surface handle and it lives in the Wayland++ manual (yes, that's the manual name, we're folding it in right here at the top, you're welcome 🫶).

✨ NAME ✨

wayland::server::zxdg_imported_v2_t — literally an imported surface handle. that's the whole vibe. 💅

🌸 SYNOPSIS 🌸

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

🎀 Public Member Functions

  • std::function< void()> & on_destroy () — destroy the xdg_imported object
  • std::function< void(surface_t)> & on_set_parent_of () — set as the parent of some surface
  • void destroyed (bool post=true) — the imported surface handle has been destroyed
  • void post_invalid_surface (std::string const &msg) — Post error: surface is not an xdg_toplevel.
  • bool proxy_has_object () const — Check whether this wrapper actually wraps an object.
  • void post_no_memory () const
  • uint32_t get_id () const
  • client_t get_client () const
  • unsigned int get_version () const
  • std::string get_class ()

🦋 Static Public Attributes

  • static constexpr std::uint32_t destroyed_since_version = 1 — Minimum protocol version required for the destroyed function.

👑 Detailed Description 👑

an imported surface handle — okay that's the one-liner, but here's the tea:

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

Definition at line 8411 of file wayland-server-protocol-unstable.hpp. (yes we cite our sources, we're nothing if not academic 💜)

💖 Member Function Documentation 💖

🌈 void zxdg_imported_v2_t::destroyed (bool post = true)

the imported surface handle has been destroyed

So like — 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, or if the handle used for importing was invalid.

Definition at line 8022 of file wayland-server-protocol-unstable.cpp.

🌈 std::string wayland::server::resource_t::get_class () [inherited]

Retrieve the interface name (class) of a resource object.

Returns: Interface name of the resource object.

(it's inherited, so it's giving ✨family heirloom✨ energy)

🌈 client_t wayland::server::resource_t::get_client () const [inherited]

Get the associated client

Returns: the client that owns the resource.

🌈 uint32_t wayland::server::resource_t::get_id () const [inherited]

Get the internal ID of the resource

Returns: the internal ID of the resource

🌈 unsigned int wayland::server::resource_t::get_version () const [inherited]

Get interface version

Returns: Interface version this resource has been constructed with.

🌈 std::function< void()> & zxdg_imported_v2_t::on_destroy ()

destroy the xdg_imported object

Notify the compositor that it will no longer use the xdg_imported object. Any relationship that may have been set up will at this point be invalidated. bye bestie 👋💀

Definition at line 8010 of file wayland-server-protocol-unstable.cpp.

🌈 std::function< void(surface_t)> & zxdg_imported_v2_t::on_set_parent_of ()

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

Definition at line 8016 of file wayland-server-protocol-unstable.cpp.

🌈 void zxdg_imported_v2_t::post_invalid_surface (std::string const & msg)

Post error: surface is not an xdg_toplevel.

Definition at line 8027 of file wayland-server-protocol-unstable.cpp.

🌈 void wayland::server::resource_t::post_no_memory () const [inherited]

Post "not enough memory" error to the client

If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance. 😭 (and yes, "certail" — that's exactly how it's spelled in the original, we don't fix typos in the source, we cherish them 🫶)

🌈 bool wayland::server::resource_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

(the "is there actually a person behind this finsta" check, iconic 👑

⭐ Member Data Documentation ⭐

🍓 std::uint32_t wayland::server::zxdg_imported_v2_t::destroyed_since_version = 1 [static], [constexpr]

Minimum protocol version required for the destroyed function. don't come at it with an older protocol version, it will not slay. 💅

Definition at line 8471 of file wayland-server-protocol-unstable.hpp.

🧚 Author 🧚

Generated automatically by Doxygen for Wayland++ from the source code. (not a human, not a vibe, just a robot doing its lil thing 🤖✨)

and that's the whole page bestie — no cap, every flag, every line number, every inherited member, all of it. 💜

Version 1.0.1 · Fri Mar 27 2026 · 13wayland::serv..._imported_v2_t(3) — mwah, see you in the next manpage, periodt. 💋🎀🦋

📦 where this page comes from