table of contents
wayland::server::callback_t(3) | Wayland++ | wayland::server::callback_t(3) |
NAME¶
wayland::server::callback_t - callback object
SYNOPSIS¶
#include <wayland-server-protocol.hpp>
Inherits wayland::server::resource_t.
Public Member Functions¶
void done (uint32_t callback_data, bool post=true)
done event 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 done_since_version = 1
Minimum protocol version required for the done function.
Detailed Description¶
callback object
Clients can handle the 'done' event to get notified when the related request is done.
Definition at line 219 of file wayland-server-protocol.hpp.
Member Function Documentation¶
void callback_t::done (uint32_t callback_data, bool post = true)¶
done event
Parameters
Notify the client when the related request is done.
Definition at line 1617 of file wayland-server-protocol.cpp.
std::string wayland::server::resource_t::get_class () [inherited]¶
Retrieve the interface name (class) of a resource object.
Returns
client_t wayland::server::resource_t::get_client () const [inherited]¶
Get the associated client
Returns
uint32_t wayland::server::resource_t::get_id () const [inherited]¶
Get the internal ID of the resource
Returns
unsigned int wayland::server::resource_t::get_version () const [inherited]¶
Get interface version
Returns
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
Member Data Documentation¶
constexpr std::uint32_t wayland::server::callback_t::done_since_version = 1 [static], [constexpr]¶
Minimum protocol version required for the done function.
Definition at line 254 of file wayland-server-protocol.hpp.
Author¶
Generated automatically by Doxygen for Wayland++ from the source code.
Wed May 3 2023 | Version 1.0.0 |