{ "name": "PanelWindow", "module": "Quickshell", "type": "class", "super": { "type": "local", "module": "Quickshell", "name": "QsWindow" }, "description": "Decorationless window attached to screen edges by anchors.", "details": "Decorationless window attached to screen edges by anchors.\n\n#### Example\nThe following snippet creates a white bar attached to the bottom of the screen.\n\n```qml\nPanelWindow {\n anchors {\n left: true\n bottom: true\n right: true\n }\n\n Text {\n anchors.centerIn: parent\n text: \"Hello!\"\n }\n}\n```\n", "properties": { "exclusiveZone": { "type": { "type": "qt", "module": "qml", "name": "int" }, "details": "The amount of space reserved for the shell layer relative to its anchors.\nSetting this property sets TYPE99VexclusionMode99Tprop99TYPE to `ExclusionMode.Normal`.\n\n> [!NOTE] Either 1 or 3 anchors are required for the zone to take effect.\n" }, "exclusionMode": { "type": { "type": "local", "module": "Quickshell", "name": "ExclusionMode" }, "details": "Defaults to `ExclusionMode.Auto`.\n" }, "margins": { "type": { "gadget": { "left": { "type": "qt", "module": "qml", "name": "int" }, "bottom": { "type": "qt", "module": "qml", "name": "int" }, "right": { "type": "qt", "module": "qml", "name": "int" }, "top": { "type": "qt", "module": "qml", "name": "int" } } }, "details": "Offsets from the sides of the screen.\n\n> [!NOTE] Only applies to edges with anchors\n" }, "focusable": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If the panel should accept keyboard focus. Defaults to false.\n\nNote: On Wayland this property corrosponds to TYPE99MQS_Quickshell_Wayland99NWlrLayershell99VkeyboardFocus99Tprop99TYPE.\n" }, "aboveWindows": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If the panel should render above standard windows. Defaults to true.\n\nNote: On Wayland this property corrosponds to TYPE99MQS_Quickshell_Wayland99NWlrLayershell99Vlayer99Tprop99TYPE.\n" }, "anchors": { "type": { "gadget": { "right": { "type": "qt", "module": "qml", "name": "bool" }, "left": { "type": "qt", "module": "qml", "name": "bool" }, "bottom": { "type": "qt", "module": "qml", "name": "bool" }, "top": { "type": "qt", "module": "qml", "name": "bool" } } }, "details": "Anchors attach a shell window to the sides of the screen.\nBy default all anchors are disabled to avoid blocking the entire screen due to a misconfiguration.\n\n> [!NOTE] When two opposite anchors are attached at the same time, the corrosponding dimension\n> (width or height) will be forced to equal the screen width/height.\n> Margins can be used to create anchored windows that are also disconnected from the monitor sides.\n" } }, "functions": [], "signals": {}, "variants": {} }