list toplevels and properties thereof

The purpose of this protocol is to enable clients such as taskbars or docks to access a list of opened applications and basic properties thereof.

It thus extends ext_foreign_toplevel_v1 to provide more information and actions on foreign toplevels.

stop()
stop sending events

This request indicates that 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.

Note: This request isn't necessary for clients binding version 2 of this protocol and will be ignored.

get cosmic toplevel extension object

Request a zcosmic_toplevel_handle_v1 extension object for an existing ext_foreign_toplevel_handle_v1.

All initial properties of the toplevel (states, etc.) will be sent immediately after this event via the corresponding events in zcosmic_toplevel_handle_v1.

Argument
Type
Description
toplevelnew_id<zcosmic_toplevel_handle_v1>
a toplevel has been created

This event is never emitted for clients binding version 2 of this protocol, they should use `get_cosmic_toplevel` instead.

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

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

finished()
the compositor has finished with the toplevel manager

This event indicates that the compositor is done sending events to the zcosmic_toplevel_info_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.

Note: This event is emitted immediately after calling `stop` for clients binding version 2 of this protocol for backwards compatibility.

done()
all information about active toplevels have been sent

This event is sent after all changes for currently active zcosmic_toplevel_handle_v1 have been sent.

This allows changes to multiple zcosmic_toplevel_handle_v1 handles and their properties to be seen as atomic, even if they happen via multiple events.


an open toplevel

A zcosmic_toplevel_handle_v1 object represents an open toplevel window. A single app may have multiple open toplevels.

Each toplevel has a list of outputs it is visible on, exposed to the client via the output_enter and output_leave events.

destroy()
destroy the zcosmic_toplevel_handle_v1 object

This request should be called either when the client will no longer use the zcosmic_toplevel_handle_v1.

closed()
the toplevel has been closed

The server will emit no further events on the zcosmic_toplevel_handle_v1 after this event. Any requests received aside from the destroy request will be ignored. Upon receiving this event, the client should make the destroy request to allow freeing of resources.

Note: This event will not be emitted for clients binding version 2 of this protocol, as `ext_foreign_toplevel_handle_v1.closed` is equivalent.

done()
all information about the toplevel has been sent

This event is sent after all changes in the toplevel state have been sent.

This allows changes to the zcosmic_toplevel_handle_v1 properties to be seen as atomic, even if they happen via multiple events.

Note: this is is not sent after the closed event.

Note: This event will not be emitted for clients binding version 2 of this protocol, as `ext_foreign_toplevel_handle_v1.done` is equivalent.

title(title: string)
Argument
Type
Description
titlestring
title change

This event is emitted whenever the title of the toplevel changes.

Note: This event will not be emitted for clients binding version 2 of this protocol, as `ext_foreign_toplevel_handle_v1.title` is equivalent.

app_id(app_id: string)
Argument
Type
Description
app_idstring
app_id change

This event is emitted whenever the app_id of the toplevel changes.

Note: This event will not be emitted for clients binding version 2 of this protocol, as `ext_foreign_toplevel_handle_v1.app_id` is equivalent.

output_enter(output: object<wl_output>)
Argument
Type
Description
outputobject<wl_output>
toplevel entered an output

This event is emitted whenever the toplevel becomes visible on the given output. A toplevel may be visible on multiple outputs.

output_leave(output: object<wl_output>)
Argument
Type
Description
outputobject<wl_output>
toplevel left an output

This event is emitted whenever the toplevel is no longer visible on a given output. It is guaranteed that an output_enter event with the same output has been emitted before this event.

workspace_enter(workspace: object<zcosmic_workspace_handle_v1>)
Argument
Type
Description
workspaceobject<zcosmic_workspace_handle_v1>
toplevel entered an workspace

This event is emitted whenever the toplevel becomes visible on the given workspace. A toplevel may be visible on multiple workspaces.

workspace_leave(workspace: object<zcosmic_workspace_handle_v1>)
Argument
Type
Description
workspaceobject<zcosmic_workspace_handle_v1>
toplevel left an workspace

This event is emitted whenever the toplevel is no longer visible on a given workspace. It is guaranteed that an workspace_enter event with the same workspace has been emitted before this event.

state(state: array)
Argument
Type
Description
statearray
the toplevel state changed

This event is emitted once on creation of the zcosmic_toplevel_handle_v1 and again whenever the state of the toplevel changes.

geometry(output: object<wl_output>, x: int, y: int, width: int, height: int)
Argument
Type
Description
outputobject<wl_output>
xint
x coordinate of the upper-left corner
yint
y coordinate of the upper-left corner
widthint
width of the toplevel
heightint
height of the toplevel
the toplevel's position and/or size has changed

Emitted when the geometry of a toplevel (it's position and/or size) relative to the provided output has changed.

This event is emitted once on creation of the zcosmic_toplevel_handle_v1 for every entered output and again whenever the geometry of the toplevel changes relative to any output.

ext_workspace_enter(workspace: object<ext_workspace_handle_v1>)
Argument
Type
Description
workspaceobject<ext_workspace_handle_v1>
toplevel entered an workspace

This event is emitted whenever the toplevel becomes visible on the given workspace. A toplevel may be visible on multiple workspaces.

ext_workspace_leave(workspace: object<ext_workspace_handle_v1>)
Argument
Type
Description
workspaceobject<ext_workspace_handle_v1>
toplevel left an workspace

This event is emitted whenever the toplevel is no longer visible on a given workspace. It is guaranteed that an workspace_enter event with the same workspace has been emitted before this event.

Argument
Value
Description
maximized0
the toplevel is maximized
minimized1
the toplevel is minimized
activated2
the toplevel is active
fullscreen3
the toplevel is fullscreen
stickysince 24
the toplevel is sticky
types of states on the toplevel

The different states that a toplevel may have. These have the same meaning as the states with the same names defined in xdg-toplevel


Compositor Support

Mutter
Mutter
48.0
KWin
KWin
6.4
Sway
Sway
1.11
COSMIC
COSMIC
...
Hyprland
Hyprland
0.48
niri
25.02
Weston
Weston
14
Labwc
Labwc
0.9.0
Cage
Cage
0.2.0
Wayfire
Wayfire
0.9.0
GameScope
GameScope
3.15.14
Jay
1.11.0
Mir
Mir
2.19
Treeland
Treeland
0.6.1
Louvre
Louvre
2.14.1
zcosmic_toplevel_info_v1
x
x
x
3
x
x
x
x
x
x
x
x
x
x
x

Copyright © 2018 Ilia Bozhinov Copyright © 2020 Isaac Freund Copyright © 2024 Victoria Brekenfeld

Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the copyright holders not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The copyright holders make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.