.TH "wayland::server::zxdg_exported_v1_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
wayland::server::zxdg_exported_v1_t \- an exported surface handle  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <wayland\-server\-protocol\-unstable\&.hpp>\fP
.PP
Inherits wayland::server::resource_t\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "std::function< void()> & \fBon_destroy\fP ()"
.br
.RI "unexport the exported surface "
.ti -1c
.RI "void \fBhandle\fP (std::string const &handle, bool post=true)"
.br
.RI "the exported surface handle "
.ti -1c
.RI "bool \fBproxy_has_object\fP () const"
.br
.RI "Check whether this wrapper actually wraps an object\&. "
.ti -1c
.RI "void \fBpost_no_memory\fP () const"
.br
.ti -1c
.RI "uint32_t \fBget_id\fP () const"
.br
.ti -1c
.RI "client_t \fBget_client\fP () const"
.br
.ti -1c
.RI "unsigned int \fBget_version\fP () const"
.br
.ti -1c
.RI "std::string \fBget_class\fP ()"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static constexpr std::uint32_t \fBhandle_since_version\fP = 1"
.br
.RI "Minimum protocol version required for the \fBhandle\fP function\&. "
.in -1c
.SH "Detailed Description"
.PP 
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\&. 
.PP
Definition at line \fB8073\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.
.SH "Member Function Documentation"
.PP 
.SS "std::string wayland::server::resource_t::get_class ()\fC [inherited]\fP"
Retrieve the interface name (class) of a resource object\&.
.PP
\fBReturns\fP
.RS 4
Interface name of the resource object\&. 
.RE
.PP

.SS "client_t wayland::server::resource_t::get_client () const\fC [inherited]\fP"
Get the associated client
.PP
\fBReturns\fP
.RS 4
the client that owns the resource\&. 
.RE
.PP

.SS "uint32_t wayland::server::resource_t::get_id () const\fC [inherited]\fP"
Get the internal ID of the resource
.PP
\fBReturns\fP
.RS 4
the internal ID of the resource 
.RE
.PP

.SS "unsigned int wayland::server::resource_t::get_version () const\fC [inherited]\fP"
Get interface version
.PP
\fBReturns\fP
.RS 4
Interface version this resource has been constructed with\&. 
.RE
.PP

.SS "void zxdg_exported_v1_t::handle (std::string const & handle, bool post = \fCtrue\fP)"

.PP
the exported surface handle 
.PP
\fBParameters\fP
.RS 4
\fIhandle\fP the exported surface handle
.RE
.PP
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\&. 
.PP
Definition at line \fB7783\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void()> & zxdg_exported_v1_t::on_destroy ()"

.PP
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\&. 
.PP
Definition at line \fB7777\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "void wayland::server::resource_t::post_no_memory () const\fC [inherited]\fP"
Post 'not enough memory' error to the client
.PP
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\&. 
.SS "bool wayland::server::resource_t::proxy_has_object () const\fC [inherited]\fP"

.PP
Check whether this wrapper actually wraps an object\&. 
.PP
\fBReturns\fP
.RS 4
true if there is an underlying object, false if this wrapper is empty 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "constexpr std::uint32_t wayland::server::zxdg_exported_v1_t::handle_since_version = 1\fC [static]\fP, \fC [constexpr]\fP"

.PP
Minimum protocol version required for the \fBhandle\fP function\&. 
.PP
Definition at line \fB8121\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Wayland++ from the source code\&.