---
name: "wayland_server_zxdg_importer_v2_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_importer_v2_t"
---

# wayland\_server\_zxdg\_importer\_v2\_t(3)

interface for importing surfaces

## NAME

wayland::server::zxdg\_importer\_v2\_t - interface for importing surfaces

## SYNOPSIS

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

Inherits wayland::server::resource\_t.

### Public Member Functions

std::function\< void()\> & **on\_destroy** ()\
 destroy the xdg\_importer object  std::function\< void(**zxdg\_imported\_v2\_t**, std::string)\> & **on\_import\_toplevel** ()\
 import a toplevel surface  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** ()\

## Detailed Description

interface for importing surfaces

A global interface used for importing surfaces exported by xdg\_exporter. With this interface, a client can create a reference to a surface of another client.

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

### std::function\< void()\> & zxdg\_importer\_v2\_t::on\_destroy ()

destroy the xdg\_importer object Notify the compositor that the xdg\_importer object will no longer be used.

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

### std::function\< void(zxdg\_imported\_v2\_t, std::string)\> & zxdg\_importer\_v2\_t::on\_import\_toplevel ()

import a toplevel surface

**Parameters**

*id* the new xdg\_imported object \
 *handle* the exported surface handle

The import\_toplevel request imports a surface from any client given a handle retrieved by exporting said surface using xdg\_exporter.export\_toplevel. When called, a new xdg\_imported object will be created. This new object represents the imported surface, and the importing client can manipulate its relationship using it. See xdg\_imported for details.

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

## Author

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