---
name: "wayland_zxdg_shell_v6_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_shell_v6_t"
---

# wayland\_zxdg\_shell\_v6\_t(3)

create desktop-style surfaces

## NAME

wayland::zxdg\_shell\_v6\_t - create desktop-style surfaces

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

**zxdg\_positioner\_v6\_t** **create\_positioner** ()\
 create a positioner object  **zxdg\_surface\_v6\_t** **get\_xdg\_surface** (**surface\_t** const &surface)\
 create a shell surface from a surface  void **pong** (uint32\_t serial)\
 respond to a ping event  std::function\< void(uint32\_t)\> & **on\_ping** ()\
 check if the client is alive  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 **create\_positioner\_since\_version** = 1\
 Minimum protocol version required for the **create\_positioner** function.  static constexpr std::uint32\_t **get\_xdg\_surface\_since\_version** = 1\
 Minimum protocol version required for the **get\_xdg\_surface** function.  static constexpr std::uint32\_t **pong\_since\_version** = 1\
 Minimum protocol version required for the **pong** function.

## Detailed Description

create desktop-style surfaces

xdg\_shell allows clients to turn a wl\_surface into a 'real window' which can be dragged, resized, stacked, and moved around by the user. Everything about this interface is suited towards traditional desktop environments.

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

### zxdg\_positioner\_v6\_t zxdg\_shell\_v6\_t::create\_positioner ()

*create a positioner object Create a positioner object. A positioner object is used to position surfaces relative to some parent surface. See the interface description and xdg\_surface.get\_popup for details.*

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

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

### zxdg\_surface\_v6\_t zxdg\_shell\_v6\_t::get\_xdg\_surface (surface\_t const & surface)

*create a shell surface from a surface*

**Parameters**

*surface*

*This creates an xdg\_surface for the given surface. While xdg\_surface itself is not a role, the corresponding surface may only be assigned a role extending xdg\_surface, such as xdg\_toplevel or xdg\_popup.*

*This creates an xdg\_surface for the given surface. An xdg\_surface is used as basis to define a role to a given surface, such as xdg\_toplevel or xdg\_popup. It also manages functionality shared between xdg\_surface based surface roles.*

*See the documentation of xdg\_surface for more details about what an xdg\_surface is and how it is used.*

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

### std::function\< void(uint32\_t)\> & zxdg\_shell\_v6\_t::on\_ping ()

*check if the client is alive*

**Parameters**

*serial pass this to the pong request*

*The ping event asks the client if it's still alive. Pass the serial specified in the event back to the compositor by sending a 'pong' request back with the specified serial. See xdg\_shell.ping.*

*Compositors can use this to determine if the client is still alive. It's unspecified what will happen if the client doesn't respond to the ping request, or in what timeframe. Clients should try to respond in a reasonable amount of time.*

*A compositor is free to ping in any way it wants, but a client must always respond to any xdg\_shell object it created.*

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

### void zxdg\_shell\_v6\_t::pong (uint32\_t serial)

*respond to a ping event*

**Parameters**

*serial serial of the ping event*

*A client must respond to a ping event with a pong request or the client may be deemed unresponsive. See xdg\_shell.ping.*

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

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

### constexpr std::uint32\_t wayland::zxdg\_shell\_v6\_t::create\_positioner\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **create\_positioner** *function.*

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

### constexpr std::uint32\_t wayland::zxdg\_shell\_v6\_t::get\_xdg\_surface\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **get\_xdg\_surface** *function.*

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

### constexpr std::uint32\_t wayland::zxdg\_shell\_v6\_t::pong\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **pong** *function.*

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

## Author

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