wayland::zxdg_importer_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::zxdg_importer_v1_t(3) — the Wayland++ girlies' guide 💅

okay so bestie, you're looking at wayland::zxdg_importer_v1_t(3) from the Wayland++ manual and honestly? it's giving "let me borrow your surface real quick" energy. buckle up 🎀

✨ NAME ✨

wayland::zxdg_importer_v1_t — literally the interface for importing surfaces. that's it, that's the vibe 🦋

✨ SYNOPSIS ✨

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

Inherits wayland::proxy_t. yes queen, it's part of the proxy family tree 👑

🌸 Public Types

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

🌸 Public Member Functions

  • zxdg_imported_v1_t import (std::string const &handle) — import a surface, 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.

🌸 Static Public Attributes

  • static constexpr std::uint32_t import_since_version = 1 — the minimum protocol version required for the import function. literally the bare minimum, no notes 🔥

💖 Detailed Description 💖

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 giving "sharing is caring" but make it protocol-level 🫶

Definition at line 7102 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 enum is basically the personality quiz of proxies — here's what each result means 💀

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. the good old reliable main character ✨
  • 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. special little guy, different rules 🌈
  • 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. ⚠️ hands off, it's not yours, do NOT 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. 🧚 it keeps its parent alive, so clingy, we love that
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 😭 no object, no pointer, no mercy.

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. 🚨 do NOT assume, bestie, make safe assumptions 🚨

display_t will always return version 0. every single 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. the vibe check, basically 👑

Definition at line 303 of file wayland-client.hpp.

zxdg_imported_v1_t zxdg_importer_v1_t::import (std::string const & handle)

import a surface — the moment we've all been waiting for ✨

Returns: the new xdg_imported object 🎁

Parameters: handle — the exported surface handle

The import request imports a surface from any client given a handle retrieved by exporting said surface using xdg_exporter.export. 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 adoption papers for surfaces, honestly 🫶

Definition at line 9041 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. the "do you actually have a personality or are you just a shell" test 🙈

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

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

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

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

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 if you try it on a display_t, nothing happens — no error, no drama, just silence 💀

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. lowkey the "please send my mail to a different address" of Wayland 📬

See also: display_t::dispatch_queue().

Examples: proxy_wrapper.cpp.

⭐ Member Data Documentation ⭐

std::uint32_t wayland::zxdg_importer_v1_t::import_since_version = 1 [static], [constexpr]

Minimum protocol version required for the import function. version 1, the founding member, the OG 👑

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

💜 Author 💜

Generated automatically by Doxygen for Wayland++ from the source code. yes bestie, a robot wrote the bones of this and i gave it the glitter ✨

and that's the whole page! 🌸 this icon of a manpage is Version 1.0.1, dated Fri Mar 27 2026 13:15 — so go forth, import those surfaces, and slay 💅 periodt.

📦 where this page comes from