Skip to main content

Module foreign_toplevel

Module foreign_toplevel 

Source
Expand description

zwlr_foreign_toplevel_manager_v1, the window list a taskbar reads and acts on. zwlr_foreign_toplevel_manager_v1: the window list a taskbar reads and acts on. Every mapped toplevel is a handle on each bound manager, carrying its title, app id, states, and output; a taskbar’s requests (activate, minimize, maximize, fullscreen, close) go to the window policy where one is installed, and without one the activate raises and focuses, the close asks the client, and the rest are ignored since every window is fullscreen then. A taskbar’s set_rectangle tells the policy where it shows the window, the target of a minimize effect, in layout coordinates: the rectangle arrives relative to the taskbar’s own surface, a layer surface whose place on its output the layer map knows. A window the policy put on another virtual desktop stays listed but on no output, neither minimized nor shown, so a taskbar following the outputs drops it from the current desktop’s list and takes it back when the window enters its output again.

Structs§

ForeignToplevelState
The manager instances bound and the handles each window has on them.
HandleData
The user data of a handle: the window it stands for.
Published 🔒
What every handle of a window was last told.

Functions§

activate_plain 🔒
Raise and focus a window where no policy decides.
add
A window mapped: give every bound taskbar a handle for it.
layer_surface_origin 🔒
Where a taskbar’s surface sits on the layout: a layer surface’s geometry on its output.
listed 🔒
mapped 🔒
Whether a window is listed: a toplevel on screen or hidden, never a parked one. Whether a window is mapped: in the space, or hidden by the policy (minimized, or on another virtual desktop). One a client withdrew, an unmapped X11 window or an xdg toplevel waiting for its next map, is not, so a change to it does not list it again.
output_bound
A client bound a wl_output: the handles it holds of the windows on that output enter it, since an enter reaches only the objects the client held when it was sent.
published_of 🔒
What a window’s handles say about it now.
remove
A window is gone, or withdrawn: close its handles.
send_all 🔒
update
A window’s title, app id, states, or output may have changed: tell its handles.
update_all
Every listed window’s handles brought up to date, after a focus change.