quickshell-web/modules/Quickshell/Reloadable.json
2024-09-28 02:35:19 +03:00

28 lines
1.7 KiB
JSON

{
"name": "Reloadable",
"module": "Quickshell",
"type": "class",
"super": {
"type": "qt",
"module": "qml.QtQml",
"name": "QtObject"
},
"description": "The base class of all types that can be reloaded.",
"details": "Reloadables will attempt to take specific state from previous config revisions if possible.\nSome examples are TYPE99MQS_Quickshell99NProxyWindowBase99TYPE and TYPE99MQS_Quickshell99NPersistentProperties99TYPE\n",
"flags": [
"uncreatable"
],
"properties": {
"reloadableId": {
"type": {
"type": "qt",
"module": "qml",
"name": "string"
},
"details": "An additional identifier that can be used to try to match a reloadable object to its\nprevious state.\n\nSimply keeping a stable identifier across config versions (saves) is\nenough to help the reloader figure out which object in the old revision corrosponds to\nthis object in the current revision, and facilitate smoother reloading.\n\nNote that identifiers are scoped, and will try to do the right thing in context.\nFor example if you have a TYPE99MQS_Quickshell99NVariants99TYPE wrapping an object with an identified element inside,\na scope is created at the variant level.\n\n```qml\nVariants {\n // multiple variants of the same object tree\n variants: [ { foo: 1 }, { foo: 2 } ]\n\n // any non `Reloadable` object\n QtObject {\n FloatingWindow {\n // this FloatingWindow will now be matched to the same one in the previous\n // widget tree for its variant. \"myFloatingWindow\" refers to both the variant in\n // `foo: 1` and `foo: 2` for each tree.\n reloadableId: \"myFloatingWindow\"\n\n // ...\n }\n }\n}\n```\n"
}
},
"functions": [],
"signals": {},
"variants": {}
}