wayland::server::zxdg_imported_v2_t - an imported 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_imported_v2_t(3)

       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.

constexprstd::uint32_twayland::server::zxdg_imported_v2_t::destroyed_since_version=1[static],[constexpr]
       Minimum protocol version required for the destroyed function.

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

voidzxdg_imported_v2_t::destroyed(boolpost=true)
       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.

   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.

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

   std::function<void(surface_t)>&zxdg_imported_v2_t::on_set_parent_of()
       set as the parent of some surface

       Parameterssurface 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.

   voidzxdg_imported_v2_t::post_invalid_surface(std::stringconst&msg)
       Post error: surface is not an xdg_toplevel.

       Definition at line 8027 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_imported_v2_t - an imported surface handle

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

       Inherits wayland::server::resource_t.

   PublicMemberFunctions
       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 ()

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