---
name: "wayland_zxdg_toplevel_decoration_v1_t"
section: "3"
platform: "linux"
package: "waylandpp-dev"
version: "1.0.0-6+b2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/wayland_zxdg_toplevel_decoration_v1_t"
---

# wayland\_zxdg\_toplevel\_decoration\_v1\_t(3)

decoration object for a toplevel surface

## NAME

wayland::zxdg\_toplevel\_decoration\_v1\_t - decoration object for a toplevel surface

## SYNOPSIS

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

Inherits **wayland::proxy\_t**.

### Public Types

enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\

### Public Member Functions

void **set\_mode** (zxdg\_toplevel\_decoration\_v1\_mode const &mode)\
 set the decoration mode  void **unset\_mode** ()\
 unset the decoration mode  std::function\< void(zxdg\_toplevel\_decoration\_v1\_mode)\> & **on\_configure** ()\
 suggest a surface change  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 **set\_mode\_since\_version** = 1\
 Minimum protocol version required for the **set\_mode** function.  static constexpr std::uint32\_t **unset\_mode\_since\_version** = 1\
 Minimum protocol version required for the **unset\_mode** function.

## Detailed Description

decoration object for a toplevel surface

The decoration object allows the compositor to toggle server-side window decorations for a toplevel surface. The client can request to switch to another mode.

The xdg\_toplevel\_decoration object must be destroyed before its xdg\_toplevel.

Definition at line **6934** 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

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

- *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* **116** *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*

### 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.*

**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* **302** *of file* **wayland-client.hpp***.*

### std::function\< void(zxdg\_toplevel\_decoration\_v1\_mode)\> & zxdg\_toplevel\_decoration\_v1\_t::on\_configure ()

*suggest a surface change*

**Parameters**

*mode the decoration mode*

*The configure event asks the client to change its decoration mode. The configured state should not be applied immediately. Clients must send an ack\_configure in response to this event. See xdg\_surface.configure and xdg\_surface.ack\_configure for details.*

*A configure event can be sent at any time. The specified mode must be obeyed by the client.*

*Definition at line* **8908** *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*

### 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.*

### 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.*

**Examples** **foreign\_display.cpp***.*

### void zxdg\_toplevel\_decoration\_v1\_t::set\_mode (zxdg\_toplevel\_decoration\_v1\_mode const & mode)

*set the decoration mode*

**Parameters**

*mode the decoration mode*

*Set the toplevel surface decoration mode. This informs the compositor that the client prefers the provided decoration mode.*

*After requesting a decoration mode, the compositor will respond by emitting an xdg\_surface.configure event. The client should then update its content, drawing it without decorations if the received mode is server-side decorations. The client must also acknowledge the configure when committing the new content (see xdg\_surface.ack\_configure).*

*The compositor can decide not to use the client's mode and enforce a different mode instead.*

*Clients whose decoration mode depend on the xdg\_toplevel state may send a set\_mode request in response to an xdg\_surface.configure event and wait for the next xdg\_surface.configure event to prevent unwanted state. Such clients are responsible for preventing configure loops and must make sure not to send multiple successive set\_mode requests with the same decoration mode.*

*Definition at line* **8896** *of file* **wayland-client-protocol-unstable.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***.*

### void zxdg\_toplevel\_decoration\_v1\_t::unset\_mode ()

*unset the decoration mode Unset the toplevel surface decoration mode. This informs the compositor that the client doesn't prefer a particular decoration mode.*

*This request has the same semantics as set\_mode.*

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

## Member Data Documentation

### constexpr std::uint32\_t wayland::zxdg\_toplevel\_decoration\_v1\_t::set\_mode\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_mode** *function.*

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

### constexpr std::uint32\_t wayland::zxdg\_toplevel\_decoration\_v1\_t::unset\_mode\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **unset\_mode** *function.*

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

## Author

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