---
name: "wayland_server_zxdg_exported_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_server_zxdg_exported_v1_t"
---

# wayland\_server\_zxdg\_exported\_v1\_t(3)

an exported surface handle

## NAME

wayland::server::zxdg\_exported\_v1\_t - an exported surface handle

## SYNOPSIS

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

Inherits wayland::server::resource\_t.

### Public Member Functions

std::function\< void()\> & **on\_destroy** ()\
 unexport the exported surface  void **handle** (std::string const &handle, bool post=true)\
 the exported surface handle  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** ()\

### Static Public Attributes

static constexpr std::uint32\_t **handle\_since\_version** = 1\
 Minimum protocol version required for the **handle** function.

## Detailed Description

an exported surface handle

An xdg\_exported object represents an exported reference to a surface. The exported surface may be referenced as long as the xdg\_exported object not destroyed. Destroying the xdg\_exported invalidates any relationship the importer may have established using xdg\_imported.

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

### void zxdg\_exported\_v1\_t::handle (std::string const & handle, bool post = `true`)

the exported surface handle

**Parameters**

*handle* the exported surface handle

The handle event contains the unique handle of this exported surface reference. It may be shared with any client, which then can use it to import the surface by calling xdg\_importer.import. A handle may be used to import the surface multiple times.

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

### std::function\< void()\> & zxdg\_exported\_v1\_t::on\_destroy ()

unexport the exported surface Revoke the previously exported surface. This invalidates any relationship the importer may have set up using the xdg\_imported created given the handle sent via xdg\_exported.handle.

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

## Member Data Documentation

### constexpr std::uint32\_t wayland::server::zxdg\_exported\_v1\_t::handle\_since\_version = 1` [static]`, ` [constexpr]`

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

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

## Author

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