.TH "wayland::server::shell_t" 3 "Wed May 3 2023" "Version 1.0.0" "Wayland++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
wayland::server::shell_t \- create desktop-style surfaces  

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

.in +1c
.ti -1c
.RI "std::function< void(\fBshell_surface_t\fP, \fBsurface_t\fP)> & \fBon_get_shell_surface\fP ()"
.br
.RI "create a shell surface from a surface "
.ti -1c
.RI "void \fBpost_role\fP (std::string const &msg)"
.br
.RI "Post error: given wl_surface has another role\&. "
.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 
create desktop-style surfaces 

This interface is implemented by servers that provide desktop-style user interfaces\&.
.PP
It allows clients to associate a wl_shell_surface with a basic surface\&.
.PP
Note! This protocol is deprecated and not intended for production use\&. For desktop-style user interfaces, use xdg_shell\&. Compositors and clients should not implement this interface\&. 
.PP
Definition at line \fB1668\fP of file \fBwayland\-server\-protocol\&.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(\fBshell_surface_t\fP, \fBsurface_t\fP)> & shell_t::on_get_shell_surface ()"

.PP
create a shell surface from a surface 
.PP
\fBParameters\fP
.RS 4
\fIid\fP shell surface to create 
.br
\fIsurface\fP surface to be given the shell surface role
.RE
.PP
Create a shell surface for an existing surface\&. This gives the wl_surface the role of a shell surface\&. If the wl_surface already has another role, it raises a protocol error\&.
.PP
Only one shell surface can be associated with a given surface\&. 
.PP
Definition at line \fB2220\fP of file \fBwayland\-server\-protocol\&.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 "void shell_t::post_role (std::string const & msg)"

.PP
Post error: given wl_surface has another role\&. 
.PP
Definition at line \fB2226\fP of file \fBwayland\-server\-protocol\&.cpp\fP\&.
.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\&.