{ "name": "Quickshell", "module": "Quickshell", "type": "class", "super": { "type": "qt", "module": "qml.QtQml", "name": "QtObject" }, "description": null, "details": null, "flags": [ "singleton" ], "properties": { "screens": { "type": { "type": "qt", "module": "qml", "name": "list", "of": { "type": "local", "module": "Quickshell", "name": "ShellScreen" } }, "details": "All currently connected screens.\n\nThis property updates as connected screens change.\n\n#### Reusing a window on every screen\n```qml\nShellRoot {\n Variants {\n // see Variants for details\n variants: Quickshell.screens\n PanelWindow {\n property var modelData\n screen: modelData\n }\n }\n}\n```\n\nThis creates an instance of your window once on every screen.\nAs screens are added or removed your window will be created or destroyed on those screens.\n", "flags": [ "readonly" ] }, "watchFiles": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If true then the configuration will be reloaded whenever any files change.\nDefaults to true.\n" }, "workingDirectory": { "type": { "type": "qt", "module": "qml", "name": "string" }, "details": "Quickshell's working directory. Defaults to whereever quickshell was launched from.\n" }, "processId": { "type": { "type": "qt", "module": "qml", "name": "int" }, "details": "Quickshell's process id.\n", "flags": [ "readonly" ] } }, "functions": [ { "ret": { "type": "qt", "module": "qml", "name": "variant" }, "name": "env", "id": "env", "details": "Returns the string value of an environment variable or null if it is not set.\n", "params": [ { "name": "variable", "type": { "type": "qt", "module": "qml", "name": "string" } } ] }, { "ret": { "type": "qt", "module": "qml", "name": "string" }, "name": "iconPath", "id": "iconPath", "details": "Returns a string usable for a {{< qmltypelink type=\"qt\" module=\"qml.QtQuick\" name=\"Image\" mtype=\"prop\" mname=\"source\" >}} for a given system icon.\n", "params": [ { "name": "icon", "type": { "type": "qt", "module": "qml", "name": "string" } } ] }, { "ret": { "type": "qt", "module": "qml", "name": "void" }, "name": "reload", "id": "reload", "details": "Reload the shell.\n\n`hard` - perform a hard reload. If this is false, Quickshell will attempt to reuse windows\nthat already exist. If true windows will be recreated.\n\nSee {{< qmltypelink type=\"local\" module=\"Quickshell\" name=\"Reloadable\" mtype=\"\" mname=\"\" >}} for more information on what can be reloaded and how.\n", "params": [ { "name": "hard", "type": { "type": "qt", "module": "qml", "name": "bool" } } ] } ], "signals": { "reloadCompleted": { "name": "reloadCompleted", "details": "The reload sequence has completed successfully.\n", "params": [] }, "reloadFailed": { "name": "reloadFailed", "details": "The reload sequence has failed.\n", "params": [ { "name": "errorString", "type": { "type": "qt", "module": "qml", "name": "string" } } ] }, "lastWindowClosed": { "name": "lastWindowClosed", "details": "Sent when the last window is closed.\n\nTo make the application exit when the last window is closed run `Qt.quit()`.\n", "params": [] } }, "variants": {} }