wlr foreign toplevel management

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

stop()
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.

Argument
Type
Description
toplevelnew_id<zwlr_foreign_toplevel_handle_v1>
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()
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.


An opened toplevel

A zwlr_foreign_toplevel_handle_v1 object represents an opened toplevel window. Each app may have multiple opened toplevels.

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

set_maximized()
Requests that the toplevel be maximized

Requests that the toplevel be maximized. If the maximized state actually changes, this will be indicated by the state event.

unset_maximized()
Requests that the toplevel be unmaximized

Requests that the toplevel be unmaximized. If the maximized state actually changes, this will be indicated by the state event.

set_minimized()
Requests that the toplevel be minimized

Requests that the toplevel be minimized. If the minimized state actually changes, this will be indicated by the state event.

unset_minimized()
Requests that the toplevel be unminimized

Requests that the toplevel be unminimized. If the minimized state actually changes, this will be indicated by the state event.

activate(seat: object<wl_seat>)
Argument
Type
Description
seatobject<wl_seat>
Activate the toplevel

Request that this toplevel be activated on the given seat. There is no guarantee the toplevel will be actually activated.

close()
Request that the toplevel be closed

Send a request to the toplevel to close itself. The compositor would typically use a shell-specific method to carry out this request, for example by sending the xdg_toplevel.close event. However, this gives no guarantees the toplevel will actually be destroyed. If and when this happens, the zwlr_foreign_toplevel_handle_v1.closed event will be emitted.

set_rectangle(surface: object<wl_surface>, x: int, y: int, width: int, height: int)
Argument
Type
Description
surfaceobject<wl_surface>
xint
yint
widthint
heightint
The rectangle which represents the toplevel

The rectangle of the surface specified in this request corresponds to the place where the app using this protocol represents the given toplevel. It can be used by the compositor as a hint for some operations, e.g minimizing. The client is however not required to set this, in which case the compositor is free to decide some default value.

If the client specifies more than one rectangle, only the last one is considered.

The dimensions are given in surface-local coordinates. Setting width=height=0 removes the already-set rectangle.

destroy()
Destroy the zwlr_foreign_toplevel_handle_v1 object

Destroys the zwlr_foreign_toplevel_handle_v1 object.

This request should be called either when the client does not want to use the toplevel anymore or after the closed event to finalize the destruction of the object.

set_fullscreen(output: object<wl_output>)
Argument
Type
Description
outputobject<wl_output>allow null
Request that the toplevel be fullscreened

Requests that the toplevel be fullscreened on the given output. If the fullscreen state and/or the outputs the toplevel is visible on actually change, this will be indicated by the state and output_enter/leave events.

The output parameter is only a hint to the compositor. Also, if output is NULL, the compositor should decide which output the toplevel will be fullscreened on, if at all.

unset_fullscreen()
Request that the toplevel be unfullscreened

Requests that the toplevel be unfullscreened. If the fullscreen state actually changes, this will be indicated by the state event.

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

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

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.

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 stops being visible on the given output. It is guaranteed that an entered-output event with the same output has been emitted before this event.

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

This event is emitted immediately after the zlw_foreign_toplevel_handle_v1 is created and each time the toplevel state changes, either because of a compositor action or because of a request in this protocol.

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 zwlr_foreign_toplevel_handle_v1 properties to be seen as atomic, even if they happen via multiple events.

closed()
This toplevel has been destroyed

This event means the toplevel has been destroyed. It is guaranteed there won't be any more events for this zwlr_foreign_toplevel_handle_v1. The toplevel itself becomes inert so any requests will be ignored except the destroy request.

Argument
Type
Description
parentobject<zwlr_foreign_toplevel_handle_v1>allow null
Parent change

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

No event is emitted when the parent handle is destroyed by the client.

Argument
Value
Description
maximized0
the toplevel is maximized
minimized1
the toplevel is minimized
activated2
the toplevel is active
fullscreensince 23
the toplevel is fullscreen
Types of states on the toplevel

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

Argument
Value
Description
invalid_rectangle0
the provided rectangle is invalid

Copyright © 2018 Ilia Bozhinov

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.