zwlr_foreign_toplevel_handle_v1¤
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.
Methods:
-
set_maximized–Requests that the toplevel be maximized
-
unset_maximized–Requests that the toplevel be unmaximized
-
set_minimized–Requests that the toplevel be minimized
-
unset_minimized–Requests that the toplevel be unminimized
-
activate–Activate the toplevel
-
close–Request that the toplevel be closed
-
set_rectangle–The rectangle which represents the toplevel
-
destroy–Destroy the zwlr_foreign_toplevel_handle_v1 object
-
set_fullscreen–Request that the toplevel be fullscreened
-
unset_fullscreen–Request that the toplevel be unfullscreened
-
on_title–Title change.
-
on_app_id–App-id change.
-
on_output_enter–Toplevel entered an output.
-
on_output_leave–Toplevel left an output.
-
on_state–The toplevel state changed.
-
on_done–All information about the toplevel has been sent.
-
on_closed–This toplevel has been destroyed.
-
on_parent–Parent change.
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
-
maximized–The toplevel is maximized -
minimized–The toplevel is minimized -
activated–The toplevel is active -
fullscreen–The toplevel is fullscreen
-
invalid_rectangle–The provided rectangle is invalid
title(title: str) -> None
Title change
This event is emitted whenever the title of the toplevel changes.
app_id(app_id: str) -> None
App-id change
This event is emitted whenever the app-id of the toplevel changes.
output_enter(output: wl_output) -> None
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: wl_output) -> None
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: list) -> None
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() -> None
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() -> None
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.
parent(parent: zwlr_foreign_toplevel_handle_v1) -> None
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.
set_maximized() -> None
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() -> None
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() -> None
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() -> None
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: wl_seat) -> None
Activate the toplevel
Request that this toplevel be activated on the given seat. There is no guarantee the toplevel will be actually activated.
close() -> None
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: wl_surface, x: int, y: int, width: int, height: int) -> None
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() -> None
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: wl_output) -> None
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() -> None
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.
on_title(title: str) -> None
Title change.
Override to handle wayland.zwlr_foreign_toplevel_handle_v1.events.title.
on_app_id(app_id: str) -> None
App-id change.
Override to handle wayland.zwlr_foreign_toplevel_handle_v1.events.app_id.
on_output_enter(output: wl_output) -> None
Toplevel entered an output.
Override to handle wayland.zwlr_foreign_toplevel_handle_v1.events.output_enter.
on_output_leave(output: wl_output) -> None
Toplevel left an output.
Override to handle wayland.zwlr_foreign_toplevel_handle_v1.events.output_leave.
on_state(state: list) -> None
The toplevel state changed.
Override to handle wayland.zwlr_foreign_toplevel_handle_v1.events.state.
on_done() -> None
All information about the toplevel has been sent.
Override to handle wayland.zwlr_foreign_toplevel_handle_v1.events.done.
on_closed() -> None
This toplevel has been destroyed.
Override to handle wayland.zwlr_foreign_toplevel_handle_v1.events.closed.
on_parent(parent: zwlr_foreign_toplevel_handle_v1) -> None
Parent change.
Override to handle wayland.zwlr_foreign_toplevel_handle_v1.events.parent.