Docs
Type Reference
Quickshell
QsWindow

QsWindow: Reloadable [uncreatable]

import Quickshell

Base class of Quickshell windows More

Properties

Signals

Detailed Description

Base class of Quickshell windows

Attached properties

QSWindow can be used as an attached object of anything that subclasses Item. It provides the following properties

  • window - the QSWindow object.
  • contentItem - the contentItem property of the window.

Property Details

[readonly]

backingWindowVisible: bool

If the window is currently shown. You should generally prefer visible.

This property is useful for ensuring windows spawn in a specific order, and you should not use it in place of visible.

color: color

The background color of the window. Defaults to white.

[readonly]

contentItem: Item

No details provided.

[default, readonly]

data: list<QtObject>

No details provided.

height: int

No details provided.

mask: Region

The clickthrough mask. Defaults to null.

If non null then the clickable areas of the window will be determined by the provided region.

ShellWindow {
  // The mask region is set to `rect`, meaning only `rect` is clickable.
  // All other clicks pass through the window to ones behind it.
  mask: Region { item: rect }

  Rectangle {
    id: rect

    anchors.centerIn: parent
    width: 100
    height: 100
  }
}

If the provided region’s intersection mode is Combine (the default), then the region will be used as is. Otherwise it will be applied on top of the window region.

For example, setting the intersection mode to Xor will invert the mask and make everything in the mask region not clickable and pass through clicks inside it through the window.

ShellWindow {
  // The mask region is set to `rect`, but the intersection mode is set to `Xor`.
  // This inverts the mask causing all clicks inside `rect` to be passed to the window
  // behind this one.
  mask: Region { item: rect; intersection: Intersection.Xor }

  Rectangle {
    id: rect

    anchors.centerIn: parent
    width: 100
    height: 100
  }
}

screen: ShellScreen

The screen that the window currently occupies.

This may be modified to move the window to the given screen.

visible: bool

If the window should be shown or hidden. Defaults to true.

width: int

No details provided.

[readonly]

windowTransform: QtObject

Opaque property that will receive an update when factors that affect the window’s position and transform changed.

This property is intended to be used to force a binding update, along with map[To|From]Item (which is not reactive).

Signal Details

windowConnected()

No details provided.

QsMenuOpenerQuickshell