Region: QtObject

import Quickshell

A composable region used as a mask. More

Properties

Signals

Detailed Description

See QsWindow.mask.

Property Details

height: int

Defaults to 0. Does nothing if item is set.

intersection: Intersection

The way this region interacts with its parent region. Defaults to Combine.

item: Item

The item that determines the geometry of the region. item overrides x, y, width and height.

[default, readonly]

regions: list<Region>

Regions to apply on top of this region.

Regions can be nested to create a more complex region. For example this will create a square region with a cutout in the middle.

Region {
  width: 100; height: 100;

  Region {
    x: 50; y: 50;
    width: 50; height: 50;
    intersection: Intersection.Subtract
  }
}

shape: RegionShape

Defaults to Rect.

width: int

Defaults to 0. Does nothing if item is set.

x: int

Defaults to 0. Does nothing if item is set.

y: int

Defaults to 0. Does nothing if item is set.

Signal Details

changed()

No details provided.

childrenChanged()

No details provided.