Quickshell

Windowset: QtObject

uncreatable
import Quickshell.WindowManager

A Windowset is a generic type that encompasses both “Workspaces” and “Tags” in window managers. Because the definition encompasses both you may not necessarily need all features.

Properties [?]

  • coordinates :  list <int>
    readonly

    Coordinates of the workspace, represented as an N-dimensional array. Most WMs will only expose one coordinate. If more than one is exposed, the first is conventionally X, the second Y, and the third Z.

  • projection :  WindowsetProjection
    readonly

    The projection this windowset is a member of. A projection is the set of screens covered by a windowset.

  • urgent :  bool
    readonly

    If true, a window in this windowset has been marked as urgent.

  • shouldDisplay :  bool
    readonly

    If false, this windowset should generally be hidden from workspace pickers.

  • canRemove :  bool
    readonly

    If true, the windowset can be removed. This may be done implicitly by the WM as well.

  • canActivate :  bool
    readonly

    If true, the windowset can be activated. In a workspace based WM, this will make the workspace current, in a tag based wm, the tag will be activated.

  • canSetProjection :  bool
    readonly

    If true, the windowset can be moved to a different projection.

  • id :  string
    readonly

    A persistent internal identifier for the windowset. This property should be identical across restarts and destruction/recreation of a windowset.

  • active :  bool
    readonly

    True if the windowset is currently active. In a workspace based WM, this means the represented workspace is current. In a tag based WM, this means the represented tag is active.

  • name :  string
    readonly

    Human readable name of the windowset.

  • canDeactivate :  bool
    readonly

    If true, the windowset can be deactivated. In a workspace based WM, deactivation is usually implicit and based on activation of another workspace.

Functions [?]