.TH "wayland::server::xdg_activation_v1_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
wayland::server::xdg_activation_v1_t \- interface for activating surfaces  

.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 "destroy the xdg_activation object "
.ti -1c
.RI "std::function< void(\fBxdg_activation_token_v1_t\fP)> & \fBon_get_activation_token\fP ()"
.br
.RI "requests a token "
.ti -1c
.RI "std::function< void(std::string, \fBsurface_t\fP)> & \fBon_activate\fP ()"
.br
.RI "notify new interaction being available "
.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
.SH "Detailed Description"
.PP 
interface for activating surfaces 

A global interface used for informing the compositor about applications being activated or started, or for applications to request to be activated\&. 
.PP
Definition at line \fB7514\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 "std::function< void(std::string, \fBsurface_t\fP)> & xdg_activation_v1_t::on_activate ()"

.PP
notify new interaction being available 
.PP
\fBParameters\fP
.RS 4
\fItoken\fP the activation token of the initiating client 
.br
\fIsurface\fP the wl_surface to activate
.RE
.PP
Requests surface activation\&. It's up to the compositor to display this information as desired, for example by placing the surface above the rest\&.
.PP
The compositor may know who requested this by checking the activation token and might decide not to follow through with the activation if it's considered unwanted\&.
.PP
Compositors can ignore unknown presentation tokens when an invalid token is passed\&. 
.PP
Definition at line \fB7435\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void()> & xdg_activation_v1_t::on_destroy ()"

.PP
destroy the xdg_activation object Notify the compositor that the xdg_activation object will no longer be used\&.
.PP
The child objects created via this interface are unaffected and should be destroyed separately\&. 
.PP
Definition at line \fB7423\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&.
.SS "std::function< void(\fBxdg_activation_token_v1_t\fP)> & xdg_activation_v1_t::on_get_activation_token ()"

.PP
requests a token 
.PP
\fBParameters\fP
.RS 4
\fIid\fP 
.RE
.PP
Creates an xdg_activation_token_v1 object that will provide the initiating client with a unique token for this activation\&. This token should be offered to the clients to be activated\&. 
.PP
Definition at line \fB7429\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 "Author"
.PP 
Generated automatically by Doxygen for Wayland++ from the source code\&.