72 lines
2.7 KiB
JSON
72 lines
2.7 KiB
JSON
{
|
|
"name": "PopupWindow",
|
|
"module": "Quickshell",
|
|
"type": "class",
|
|
"super": {
|
|
"type": "local",
|
|
"module": "Quickshell",
|
|
"name": "QsWindow"
|
|
},
|
|
"description": "Popup window.",
|
|
"details": "Popup window that can display in a position relative to a floating\nor panel window.\n\n#### Example\nThe following snippet creates a panel with a popup centered over it.\n\n```qml\nPanelWindow {\n id: toplevel\n\n anchors {\n bottom: true\n left: true\n right: true\n }\n\n PopupWindow {\n parentWindow: toplevel\n relativeX: parentWindow.width / 2 - width / 2\n relativeY: parentWindow.height\n width: 500\n height: 500\n visible: true\n }\n}\n```\n",
|
|
"properties": {
|
|
"parentWindow": {
|
|
"type": {
|
|
"type": "qt",
|
|
"module": "qml.QtQml",
|
|
"name": "QtObject"
|
|
},
|
|
"details": "> [!CAUTION] Deprecated in favor of `anchor.window`.\n\nThe parent window of this popup.\n\nChanging this property reparents the popup.\n"
|
|
},
|
|
"visible": {
|
|
"type": {
|
|
"type": "qt",
|
|
"module": "qml",
|
|
"name": "bool"
|
|
},
|
|
"details": "If the window is shown or hidden. Defaults to false.\n\nThe popup will not be shown until TYPE99Vanchor99Tprop99TYPE is valid, regardless of this property.\n"
|
|
},
|
|
"anchor": {
|
|
"type": {
|
|
"type": "local",
|
|
"module": "Quickshell",
|
|
"name": "PopupAnchor"
|
|
},
|
|
"details": "The popup's anchor / positioner relative to another window. The popup will not be\nshown until it has a valid anchor relative to a window and TYPE99Vvisible99Tprop99TYPE is true.\n\nYou can set properties of the anchor like so:\n```qml\nPopupWindow {\n anchor.window: parentwindow\n // or\n anchor {\n window: parentwindow\n }\n}\n```\n",
|
|
"flags": [
|
|
"readonly"
|
|
]
|
|
},
|
|
"relativeX": {
|
|
"type": {
|
|
"type": "qt",
|
|
"module": "qml",
|
|
"name": "int"
|
|
},
|
|
"details": "> [!CAUTION] Deprecated in favor of `anchor.rect.x`.\n\nThe X position of the popup relative to the parent window.\n"
|
|
},
|
|
"relativeY": {
|
|
"type": {
|
|
"type": "qt",
|
|
"module": "qml",
|
|
"name": "int"
|
|
},
|
|
"details": "> [!CAUTION] Deprecated in favor of `anchor.rect.y`.\n\nThe Y position of the popup relative to the parent window.\n"
|
|
},
|
|
"screen": {
|
|
"type": {
|
|
"type": "local",
|
|
"module": "Quickshell",
|
|
"name": "ShellScreen"
|
|
},
|
|
"details": "The screen that the window currently occupies.\n\nThis may be modified to move the window to the given screen.\n",
|
|
"flags": [
|
|
"readonly"
|
|
]
|
|
}
|
|
},
|
|
"functions": [],
|
|
"signals": {},
|
|
"variants": {}
|
|
}
|