Skip to content

zxdg_imported_v2¤

wayland.zxdg_imported_v2 ¤

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.

Methods:

  • destroy –

    Destroy the xdg_imported object

  • set_parent_of –

    Set as the parent of some surface

  • on_destroyed –

    The imported surface handle has been destroyed.

error ¤

Error values

These errors can be emitted in response to invalid xdg_imported requests.

events

destroyed ¤

destroyed() -> None

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.

destroy ¤

destroy() -> None

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.

set_parent_of ¤

set_parent_of(surface: wl_surface) -> None

Set as the parent of some 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.

Parameters:

on_destroyed ¤

on_destroyed() -> None

The imported surface handle has been destroyed.

Override to handle wayland.zxdg_imported_v2.events.destroyed.