Skip to content

zwlr_foreign_toplevel_manager_v1¤

wayland.zwlr_foreign_toplevel_manager_v1 ¤

List and control opened apps

The purpose of this protocol is to enable the creation of taskbars and docks by providing them with a list of opened applications and letting them request certain actions on them, like maximizing, etc.

After a client binds the zwlr_foreign_toplevel_manager_v1, each opened toplevel window will be sent via the toplevel event

Methods:

  • stop

    Stop sending events

  • on_toplevel

    A toplevel has been created.

  • on_finished

    The compositor has finished with the toplevel manager.

events

toplevel ¤

toplevel(toplevel: zwlr_foreign_toplevel_handle_v1) -> None

A toplevel has been created

This event is emitted whenever a new toplevel window is created. It is emitted for all toplevels, regardless of the app that has created them.

All initial details of the toplevel(title, app_id, states, etc.) will be sent immediately after this event via the corresponding events in zwlr_foreign_toplevel_handle_v1.

finished ¤

finished() -> None

The compositor has finished with the toplevel manager

This event indicates that the compositor is done sending events to the zwlr_foreign_toplevel_manager_v1. The server will destroy the object immediately after sending this request, so it will become invalid and the client should free any resources associated with it.

stop ¤

stop() -> None

Stop sending events

Indicates the client no longer wishes to receive events for new toplevels. However the compositor may emit further toplevel_created events, until the finished event is emitted.

The client must not send any more requests after this one.

on_toplevel ¤

on_toplevel(toplevel: zwlr_foreign_toplevel_handle_v1) -> None

A toplevel has been created.

Override to handle wayland.zwlr_foreign_toplevel_manager_v1.events.toplevel.

on_finished ¤

on_finished() -> None

The compositor has finished with the toplevel manager.

Override to handle wayland.zwlr_foreign_toplevel_manager_v1.events.finished.