---
name: "wayland_server_zxdg_imported_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_imported_v1_t"
---

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

an imported surface handle

## NAME

wayland::server::zxdg\_imported\_v1\_t - an imported surface handle

## SYNOPSIS

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

Inherits wayland::server::resource\_t.

### Public Member Functions

std::function\< void()\> & **on\_destroy** ()\
 destroy the xdg\_imported object  std::function\< void(**surface\_t**)\> & **on\_set\_parent\_of** ()\
 set as the parent of some surface  void **destroyed** (bool post=true)\
 the imported surface handle has been destroyed  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 **destroyed\_since\_version** = 1\
 Minimum protocol version required for the **destroyed** function.

## Detailed Description

an imported surface handle

An xdg\_imported object represents an imported reference to surface exported by some client. A client can use this interface to manipulate relationships between its own surfaces and the imported surface.

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

## Member Function Documentation

### void zxdg\_imported\_v1\_t::destroyed (bool post = `true`)

the imported surface handle has been destroyed The imported surface handle has been destroyed and any relationship set up has been invalidated. This may happen for various reasons, for example if the exported surface or the exported surface handle has been destroyed, if the handle used for importing was invalid.

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

### 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\_imported\_v1\_t::on\_destroy ()

destroy the xdg\_imported object Notify the compositor that it will no longer use the xdg\_imported object. Any relationship that may have been set up will at this point be invalidated.

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

### std::function\< void(surface\_t)\> & zxdg\_imported\_v1\_t::on\_set\_parent\_of ()

set as the parent of some surface

**Parameters**

*surface* the child surface

Set the imported surface as the parent of some surface of the client. The passed surface must be a toplevel xdg\_surface. Calling this function sets up a surface to surface relation with the same stacking and positioning semantics as xdg\_surface.set\_parent.

Definition at line **7825** 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\_imported\_v1\_t::destroyed\_since\_version = 1` [static]`, ` [constexpr]`

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

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

## Author

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