quickshell-web/modules/Quickshell/QsMenuAnchor.json

81 lines
2.4 KiB
JSON
Raw Normal View History

2024-09-27 23:35:19 +00:00
{
"name": "QsMenuAnchor",
"module": "Quickshell",
"type": "class",
"super": {
"type": "qt",
"module": "qml.QtQml",
"name": "QtObject"
},
"description": "Display anchor for platform menus.",
"details": "",
"properties": {
"anchor": {
"type": {
"type": "local",
"module": "Quickshell",
"name": "PopupAnchor"
},
"details": "The menu's anchor / positioner relative to another window. The menu will not be\nshown until it has a valid anchor.\n\n> [!NOTE] *The following is subject to change and NOT a guarantee of future behavior.*\n>\n> A snapshot of the anchor at the time TYPE99Vopened99Tsignal99TYPE is emitted will be\n> used to position the menu. Additional changes to the anchor after this point\n> will not affect the placement of the menu.\n\nYou can set properties of the anchor like so:\n```qml\nQsMenuAnchor {\n anchor.window: parentwindow\n // or\n anchor {\n window: parentwindow\n }\n}\n```\n",
"flags": [
"readonly"
]
},
"menu": {
"type": {
"type": "local",
"module": "Quickshell",
"name": "QsMenuHandle"
},
"details": "The menu that should be displayed on this anchor.\n\nSee also: TYPE99MQS_Quickshell_Services_SystemTray99NSystemTrayItem99Vmenu99Tprop99TYPE.\n"
},
"visible": {
"type": {
"type": "qt",
"module": "qml",
"name": "bool"
},
"details": "If the menu is currently open and visible.\n\nSee also: TYPE99Vopen99Tfunc99TYPE, TYPE99Vclose99Tfunc99TYPE.\n",
"flags": [
"readonly"
]
}
},
"functions": [
{
"ret": {
"type": "qt",
"module": "qml",
"name": "void"
},
"name": "close",
"id": "close",
"details": "Close the open menu.\n",
"params": []
},
{
"ret": {
"type": "qt",
"module": "qml",
"name": "void"
},
"name": "open",
"id": "open",
"details": "Open the given menu on this menu Requires that TYPE99Vanchor99Tprop99TYPE is valid.\n",
"params": []
}
],
"signals": {
"closed": {
"name": "closed",
"details": "Sent when the menu is closed.\n",
"params": []
},
"opened": {
"name": "opened",
"details": "Sent when the menu is displayed onscreen which may be after TYPE99Vvisible99Tprop99TYPE\nbecomes true.\n",
"params": []
}
},
"variants": {}
}