Skip to content

xdg_activation_v1¤

wayland.xdg_activation_v1 ¤

Interface for activating surfaces

A global interface used for informing the compositor about applications being activated or started, or for applications to request to be activated.

Methods:

destroy ¤

destroy() -> None

Destroy the xdg_activation object

Notify the compositor that the xdg_activation object will no longer be used.

The child objects created via this interface are unaffected and should be destroyed separately.

get_activation_token ¤

get_activation_token() -> xdg_activation_token_v1

Requests a token

Creates an xdg_activation_token_v1 object that will provide the initiating client with a unique token for this activation. This token should be offered to the clients to be activated.

Returns:

activate ¤

activate(token: str, surface: wl_surface) -> None

Notify new interaction being available

Requests surface activation. It's up to the compositor to display this information as desired, for example by placing the surface above the rest.

The compositor may know who requested this by checking the activation token and might decide not to follow through with the activation if it's considered unwanted.

Compositors can ignore unknown activation tokens when an invalid token is passed.

Parameters:

  • token ¤

    (str) –

    The activation token of the initiating client

  • surface ¤

    (wl_surface) –

    The wl_surface to activate