Skip to content

xdg_wm_dialog_v1¤

wayland.xdg_wm_dialog_v1 ¤

Create dialogs related to other toplevels

The xdg_wm_dialog_v1 interface is exposed as a global object allowing to register surfaces with a xdg_toplevel role as "dialogs" relative to another toplevel.

The compositor may let this relation influence how the surface is placed, displayed or interacted with.

Warning! The protocol described in this file is currently in the testing phase. Backward compatible changes may be added together with the corresponding interface version bump. Backward incompatible changes can only be done by creating a new major version of the extension.

Methods:

error ¤

  • already_used
    The `xdg_toplevel` object has already been used to create a xdg_dialog_v1

destroy ¤

destroy() -> None

Destroy the dialog manager object

Destroys the xdg_wm_dialog_v1 object. This does not affect the xdg_dialog_v1 objects generated through it.

get_xdg_dialog ¤

get_xdg_dialog(toplevel: xdg_toplevel) -> xdg_dialog_v1

Create a dialog object

Creates a xdg_dialog_v1 object for the given toplevel. See the interface description for more details.

    Compositors must raise an already_used error if clients attempt to
    create multiple xdg_dialog_v1 objects for the same xdg_toplevel.

Returns: