wayland::server::zxdg_exported_v1_t - an exported surface handle

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

Version 1.0.0                                Wed May 1 2024 17:27:19      wayland::server::zxdg_exported_v1_t(3)

       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.

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

constexprstd::uint32_twayland::server::zxdg_exported_v1_t::handle_since_version=1[static],[constexpr]
       Minimum protocol version required for the handle function.

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

std::stringwayland::server::resource_t::get_class()[inherited]
       Retrieve the interface name (class) of a resource object.

       Returns
           Interface name of the resource object.

   client_twayland::server::resource_t::get_client()const[inherited]
       Get the associated client

       Returns
           the client that owns the resource.

   uint32_twayland::server::resource_t::get_id()const[inherited]
       Get the internal ID of the resource

       Returns
           the internal ID of the resource

   unsignedintwayland::server::resource_t::get_version()const[inherited]
       Get interface version

       Returns
           Interface version this resource has been constructed with.

   voidzxdg_exported_v1_t::handle(std::stringconst&handle,boolpost=true)
       the exported surface handle

       Parametershandle the exported surface handle

       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.

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

   std::function<void()>&zxdg_exported_v1_t::on_destroy()
       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.

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

   voidwayland::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.

   boolwayland::server::resource_t::proxy_has_object()const[inherited]
       Check whether this wrapper actually wraps an object.

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

       wayland::server::zxdg_exported_v1_t - an exported surface handle

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

       Inherits wayland::server::resource_t.

   PublicMemberFunctions
       std::function< void()> & on_destroy ()
           unexport the exported surface
       void handle (std::string const &handle, bool post=true)
           the exported surface handle
       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 ()

   StaticPublicAttributes
       static constexpr std::uint32_t handle_since_version = 1
           Minimum protocol version required for the handle function.