Treeland foreign toplevel manager
treeland_foreign_toplevel_manager_v1
This interface allows a client to get toplevel some info.
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.
stop()
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.
get_dock_preview_context(relative_surface: object<wl_surface>, id: new_id<treeland_dock_preview_context_v1>)
Argument | Type | Description |
---|---|---|
relative_surface | object<wl_surface> | |
id | new_id<treeland_dock_preview_context_v1> |
toplevel(toplevel: new_id<treeland_foreign_toplevel_handle_v1>)
Argument | Type | Description |
---|---|---|
toplevel | new_id<treeland_foreign_toplevel_handle_v1> |
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 treeland_foreign_toplevel_handle_v1.
finished()
This event indicates that the compositor is done sending events to the treeland_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.
treeland_foreign_toplevel_handle_v1
A treeland_foreign_toplevel_handle_v1 object represents an opened toplevel window. Each app may have multiple opened toplevels.
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.
set_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. If the maximized state actually changes, this will be indicated by the state event.
set_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. If the minimized state actually changes, this will be indicated by the state event.
Request that this toplevel be activated on the given seat. There is no guarantee the toplevel will be actually activated.
close()
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 treeland_foreign_toplevel_handle_v1.closed event will be emitted.
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()
Destroys the treeland_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.
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()
Requests that the toplevel be unfullscreened. If the fullscreen state actually changes, this will be indicated by the state event.
pid(pid: uint)
Argument | Type | Description |
---|---|---|
pid | uint |
This event will be sent when the compositor has set the process id this window belongs to. This should be set once before the initial_state is sent.
title(title: string)
Argument | Type | Description |
---|---|---|
title | string |
This event is emitted whenever the title of the toplevel changes.
app_id(app_id: string)
Argument | Type | Description |
---|---|---|
app_id | string |
This event is emitted whenever the app-id of the toplevel changes.
identifier(identifier: uint)
Argument | Type | Description |
---|---|---|
identifier | uint |
The identifier of each top level and its handle must be unique. Two different top layers cannot have the same identifier. This identifier is only valid as long as the top level is mapped. Identifiers must not be reused if the top level is not mapped. The compositor must not reuse identifiers to ensure there are no races when identifiers are shared between processes.
This event is emitted whenever the toplevel becomes visible on the given output. A toplevel may be visible on multiple outputs.
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 |
---|---|---|
state | array |
This event is emitted immediately after the treeland_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()
This event is sent after all changes in the toplevel state have been sent.
This allows changes to the treeland_foreign_toplevel_handle_v1 properties to be seen as atomic, even if they happen via multiple events.
closed()
This event means the toplevel has been destroyed. It is guaranteed there won't be any more events for this treeland_foreign_toplevel_handle_v1. The toplevel itself becomes inert so any requests will be ignored except the destroy request.
parent(parent: object<treeland_foreign_toplevel_handle_v1>)
Argument | Type | Description |
---|---|---|
parent | object<treeland_foreign_toplevel_handle_v1>allow null |
This event is emitted whenever the parent of the toplevel changes.
No event is emitted when the parent handle is destroyed by the client.
state { maximized, minimized, activated, fullscreen }
Argument | Value | Description |
---|---|---|
maximized | 0 | the toplevel is maximized |
minimized | 1 | the toplevel is minimized |
activated | 2 | the toplevel is active |
fullscreen | 3 | the toplevel is fullscreen |
The different states that a toplevel can have. These have the same meaning as the states with the same names defined in xdg-toplevel
error { invalid_rectangle }
Argument | Value | Description |
---|---|---|
invalid_rectangle | 0 | the provided rectangle is invalid |
treeland_dock_preview_context_v1
This interface allows dock set windows preview.
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.
X and Y are relative to the relative_surface. surfaces wl_array is identifiers.
destroy()
Destroy the context object.
enter()
This event is sent after mouse enter preview box.
leave()
This event is sent after mouse leave preview box.
Compositor Support
Mutter 47.3 | KWin 6.3 | Sway 1.10 | COSMIC 0.1 | Hyprland 0.44 | niri 25.02 | Weston 14 | Mir 2.19 | GameScope 3.15.14 | Jay 1.9.0 | Labwc 0.8.2 | Wayfire 0.9.0 | Treeland 0.5.17 | Louvre 2.14.1 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
treeland_foreign_toplevel_manager_v1 | x | x | x | x | x | x | x | x | x | x | x | x | 1 | x |
Copyright
SPDX-FileCopyrightText: 2024 UnionTech Software Technology Co., Ltd. SPDX-License-Identifier: MIT