wayland::server::zxdg_imported_v2_t(3) Wayland++ wayland::server::zxdg_imported_v2_t(3)

wayland::server::zxdg_imported_v2_t - an imported surface handle

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

Inherits wayland::server::resource_t.


std::function< void()> & on_destroy ()
destroy the xdg_imported object std::function< void(surface_t)> & on_set_parent_of ()
set as the parent of some surface void destroyed (bool post=true)
the imported surface handle has been destroyed void post_invalid_surface (std::string const &msg)
Post error: surface is not an xdg_toplevel. 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 constexpr std::uint32_t destroyed_since_version = 1
Minimum protocol version required for the destroyed function.

an imported surface handle

An xdg_imported object represents an imported reference to surface exported by some client. A client can use this interface to manipulate relationships between its own surfaces and the imported surface.

Definition at line 8410 of file wayland-server-protocol-unstable.hpp.

the imported surface handle has been destroyed The imported surface handle has been destroyed and any relationship set up has been invalidated. This may happen for various reasons, for example if the exported surface or the exported surface handle has been destroyed, if the handle used for importing was invalid.

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

Retrieve the interface name (class) of a resource object.

Returns

Interface name of the resource object.

Get the associated client

Returns

the client that owns the resource.

Get the internal ID of the resource

Returns

the internal ID of the resource

Get interface version

Returns

Interface version this resource has been constructed with.

destroy the xdg_imported object Notify the compositor that it will no longer use the xdg_imported object. Any relationship that may have been set up will at this point be invalidated.

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

set as the parent of some surface

Parameters

surface the child surface

Set the imported surface as the parent of some surface of the client. The passed surface must be an xdg_toplevel equivalent, otherwise an invalid_surface protocol error is sent. Calling this function sets up a surface to surface relation with the same stacking and positioning semantics as xdg_toplevel.set_parent.

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

Post error: surface is not an xdg_toplevel.

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

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.

Check whether this wrapper actually wraps an object.

Returns

true if there is an underlying object, false if this wrapper is empty

Minimum protocol version required for the destroyed function.

Definition at line 8470 of file wayland-server-protocol-unstable.hpp.

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

Mon Apr 22 2024 09:52:15 Version 1.0.0