wayland::zxdg...n_manager_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

💅 wayland::zxdg_decoration_manager_v1_t — the Wayland++ girlies' guide ✨

okay so bestie, welcome to the Wayland++ fam 🫶 this one's all about wayland::zxdg_decoration_manager_v1_t, aka the window decoration manager. she manages windows. she decorates. she's booked and busy 💖

🌸 NAME 🌸

wayland::zxdg_decoration_manager_v1_t — window decoration manager ✨

🎀 SYNOPSIS 🎀

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

Inherits wayland::proxy_t. she's got lineage, she's got range, she's iconic 👑

💜 Public Types

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the whole girl squad of proxy wrapper types 🌈

🦋 Public Member Functions

  • zxdg_toplevel_decoration_v1_t get_toplevel_decoration (xdg_toplevel_t const &toplevel) — create a new toplevel decoration object ✨
  • 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 get_toplevel_decoration_since_version = 1 — Minimum protocol version required for the get_toplevel_decoration function. she said version one ONLY, periodt 💅

💖 Detailed Description 💖

window decoration manager — that's her whole job description and she's thriving ✨

So like, this interface allows a compositor to announce support for server-side decorations. no cap 🫶

A window decoration is a set of window controls as deemed appropriate by the party managing them — you know, like the UI bits used to move, resize and change a window's state. the little buttons. the vibes. 🎀

A client can use this protocol to request being decorated by a supporting compositor. basically: "bestie, decorate me please" 💅

If compositor and client do not negotiate the use of a server-side decoration using this protocol, clients continue to self-decorate as they see fit. DIY era 🧚

⚠️ Warning! The protocol described in this file is experimental and backward incompatible changes may be made. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes are done by bumping the version number in the protocol and interface names and resetting the interface version. Once the protocol is to be declared stable, the 'z' prefix and the version number in the protocol and interface names are removed and the interface version number is reset. 😭 so like, don't get too attached to the name, she may rebrand.

Definition at line 6882 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 literally the personality chart of your proxy 🔥

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. 🙈 hands off, she's not yours.
  • 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. 😭 no object? no pointer. that's the rule.

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.

zxdg_toplevel_decoration_v1_t zxdg_decoration_manager_v1_t::get_toplevel_decoration (xdg_toplevel_t const & toplevel)

create a new toplevel decoration object 💅 the main character function, honestly.

Parameters — toplevel

Create a new decoration object associated with the given toplevel.

⚠️ Creating an xdg_toplevel_decoration from an xdg_toplevel which has a buffer attached or committed is a client error, and any attempts by a client to attach or manipulate a buffer prior to the first xdg_toplevel_decoration.configure event must also be treated as errors. fr fr, do not do this 🫶

Definition at line 8833 of file wayland-client-protocol-unstable.cpp.

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. 😬 lowkey stressful but okay.

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.

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.

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

Check whether two wrappers refer to different objects. not the same girl 💀

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

Check whether two wrappers refer to the same object. same girl, different outfit ✨

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. 🙈 like, she's not leaving, stop asking.

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.

See also: display_t::dispatch_queue().

Examples — proxy_wrapper.cpp.

🍓 Member Data Documentation 🍓

std::uint32_t wayland::zxdg_decoration_manager_v1_t::get_toplevel_decoration_since_version = 1 [static], [constexpr]

Minimum protocol version required for the get_toplevel_decoration function.

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

⭐ Author ⭐

Generated automatically by Doxygen for Wayland++ from the source code. (not a person, a whole machine aesthetic 💀)

and that's the tea bestie 🫶 this page is Version 1.0.1, dated Fri Mar 27 2026 — slay, go decorate some windows, ily, bye 💖✨🎀

📦 where this page comes from