wayland::zxdg_importer_v2_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::zxdg_importer_v2_t(3) — the importing-surfaces era, bestie

okay so real talk, this is the wayland::zxdg_importer_v2_t manual page from Wayland++ (that's the manual name, iykyk, we're folding it in up top like a cute little bow 🎀). it's the whole interface for importing surfaces, and honestly? it's giving "backstage pass to somebody else's window" and we are obsessed. let's get into it ✨

🌸 NAME 🌸

wayland::zxdg_importer_v2_t — interface for importing surfaces. that's it, that's the vibe. literally the whole personality 🫶

✨ SYNOPSIS ✨

so first things first, you gotta pull it in:

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

and also — important — it Inherits wayland::proxy_t. so it's part of the proxy_t family, generational excellence, no cap 👑

🎀 Public Types

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper }

🦋 Public Member Functions

  • zxdg_imported_v2_t import_toplevel (std::string const &handle) — import a toplevel surface
  • 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 import_toplevel_since_version = 1 — Minimum protocol version required for the import_toplevel function. one (1) whole version, we respect the bare minimum 💀

🌈 Detailed Description 🌈

okay so picture this: interface for importing surfaces.

A global interface used for importing surfaces exported by xdg_exporter. With this interface, a client can create a reference to a surface of another client. it's literally "your window? our window now, bestie" and honestly the collaboration energy is immaculate 🫶✨

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

💜 Member Enumeration Documentation 💜

enum class wayland::proxy_t::wrapper_type [strong], [inherited]

this one explains the Underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling. so like, the whole personality of your wrapper, the astrology of it all 🧚

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. ⚠️ lowkey do not touch, not yours, hands off.
  • 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. so like... it exists or it throws, very main character of it 😭

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. 🫶 (translation: if you get a 0, don't go guessing, be safe bestie)

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.

zxdg_imported_v2_t zxdg_importer_v2_t::import_toplevel (std::string const &handle)

import a toplevel surface — this is the one, the moment, the main event 💅

Returns — the new xdg_imported object.

Parameters — handle the exported surface handle.

so the scoop: The import_toplevel request imports a surface from any client given a handle retrieved by exporting said surface using xdg_exporter.export_toplevel. When called, a new xdg_imported object will be created. This new object represents the imported surface, and the importing client can manipulate its relationship using it. See xdg_imported for details. it's giving "i brought you into this world and now we're linked" and honestly? iconic 🌟

📌 Definition at line 9310 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: does it actually exist or is it just vibes? 🔍

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. twin behavior 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.

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 don't even try it with a display_t, it's literally not gonna happen, the attempt just gets ignored, periodt.

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 "i'm routing my mail to a different address now" 📬

See also: display_t::dispatch_queue().

Examples — proxy_wrapper.cpp.

💖 Member Data Documentation 💖

std::uint32_t wayland::zxdg_importer_v2_t::import_toplevel_since_version = 1 [static], [constexpr]

Minimum protocol version required for the import_toplevel function. it's 1. that's the number. we love a low bar ✨

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

🧚 Author 🧚

Generated automatically by Doxygen for Wayland++ from the source code. (not a human, not a bot, a Doxygen, and it ate 💅)

and that's the whole page bestie!! 🎀 Version 1.0.1, dated Fri Mar 27 2026 13:15 — that's the tea, that's the whole manual page for wayland::zxdg_importer_v2_t(3), go forth and import those surfaces responsibly 🦋💜

📦 where this page comes from