wayland::serv..._importer_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 NAME

okay bestie, this is the Wayland++ manpage for wayland::server::zxdg_importer_v1_t — literally interface for importing surfaces. The header up top is wayland::serv..._importer_v1_t(3), and the manual name is folded in right here like a little name tag: Wayland++. 🎀

✨ SYNOPSIS

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

🧸 Public Member Functions

  • std::function< void()> & on_destroy () — destroy the xdg_importer object
  • std::function< void(zxdg_imported_v1_t, std::string)> & on_import () — import a surface
  • 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 ()

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

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

🧚 MEMBER FUNCTION DOCUMENTATION

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

🐚 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_importer_v1_t::on_destroy ()

destroy the xdg_importer object — Notify the compositor that the xdg_importer object will no longer be used.

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

🫶 std::function< void(zxdg_imported_v1_t, std::string)> & zxdg_importer_v1_t::on_import ()

import a surface ✨

Parameters

  • id — the new xdg_imported object
  • 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.

Definition at line 7737 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.

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

👑 AUTHOR

Generated automatically by Doxygen for Wayland++ from the source code.

💌 cute little sign-off, no cap: this page is rockin’ Wayland++ version 1.0.1, dated Fri Mar 27 2026, and the footer energy is very “source code generated this, bestie.” byeeee 🫶✨
📦 where this page comes from