{ "name": "Region", "module": "Quickshell", "type": "class", "super": { "type": "qt", "module": "qml.QtQml", "name": "QtObject" }, "description": "A composable region used as a mask.", "details": "See {{< qmltypelink type=\"local\" module=\"Quickshell\" name=\"QsWindow\" mtype=\"prop\" mname=\"mask\" >}}.\n", "properties": { "item": { "type": { "type": "qt", "module": "qml.QtQuick", "name": "Item" }, "details": "The item that determines the geometry of the region.\n`item` overrides {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"x\" >}}, {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"y\" >}}, {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"width\" >}} and {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"height\" >}}.\n" }, "regions": { "type": { "type": "qt", "module": "qml", "name": "list", "of": { "type": "local", "module": "Quickshell", "name": "Region" } }, "details": "Regions to apply on top of this region.\n\nRegions can be nested to create a more complex region.\nFor example this will create a square region with a cutout in the middle.\n```qml\nRegion {\n width: 100; height: 100;\n\n Region {\n x: 50; y: 50;\n width: 50; height: 50;\n intersection: Intersection.Subtract\n }\n}\n```\n", "flags": [ "default", "readonly" ] }, "intersection": { "type": { "type": "local", "module": "Quickshell", "name": "Intersection" }, "details": "The way this region interacts with its parent region. Defaults to `Combine`.\n" }, "y": { "type": { "type": "qt", "module": "qml", "name": "int" }, "details": "Defaults to 0. Does nothing if {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"item\" >}} is set.\n" }, "width": { "type": { "type": "qt", "module": "qml", "name": "int" }, "details": "Defaults to 0. Does nothing if {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"item\" >}} is set.\n" }, "height": { "type": { "type": "qt", "module": "qml", "name": "int" }, "details": "Defaults to 0. Does nothing if {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"item\" >}} is set.\n" }, "shape": { "type": { "type": "local", "module": "Quickshell", "name": "RegionShape" }, "details": "Defaults to `Rect`.\n" }, "x": { "type": { "type": "qt", "module": "qml", "name": "int" }, "details": "Defaults to 0. Does nothing if {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"prop\" mname=\"item\" >}} is set.\n" } }, "functions": [], "signals": { "childrenChanged": { "name": "childrenChanged", "details": null, "params": [] }, "changed": { "name": "changed", "details": null, "params": [] } }, "variants": {} }