quickshell-web/modules_old/Quickshell.Wayland/Toplevel.json

{
  "name": "Toplevel",
  "module": "Quickshell.Wayland",
  "type": "class",
  "super": {
    "type": "qt",
    "module": "qml.QtQml",
    "name": "QtObject"
  },
  "description": "Window from another application.",
  "details": "A window/toplevel from another application, retrievable from\nthe {{< qmltypelink type=\"local\" module=\"Quickshell.Wayland\" name=\"ToplevelManager\" mtype=\"\" mname=\"\" >}}.\n",
  "flags": [
    "uncreatable"
  ],
  "properties": {
    "appId": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "string"
      },
      "details": null,
      "flags": [
        "readonly"
      ]
    },
    "minimized": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "bool"
      },
      "details": "If the window is currently minimized.\n\nMinimization can be requested by setting this property, though it may\nbe ignored by the compositor.\n"
    },
    "fullscreen": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "bool"
      },
      "details": "If the window is currently fullscreen.\n\nFullscreen can be requested by setting this property, though it may\nbe ignored by the compositor.\nFullscreen can be requested on a specific screen with the {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"func\" mname=\"fullscreenOn\" >}} function.\n"
    },
    "activated": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "bool"
      },
      "details": "If the window is currently activated or focused.\n\nActivation can be requested with the {{< qmltypelink type=\"\" module=\"\" name=\"\" mtype=\"func\" mname=\"activate\" >}} function.\n",
      "flags": [
        "readonly"
      ]
    },
    "maximized": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "bool"
      },
      "details": "If the window is currently maximized.\n\nMaximization can be requested by setting this property, though it may\nbe ignored by the compositor.\n"
    },
    "parent": {
      "type": {
        "type": "local",
        "module": "Quickshell.Wayland",
        "name": "Toplevel"
      },
      "details": "Parent toplevel if this toplevel is a modal/dialog, otherwise null.\n",
      "flags": [
        "readonly"
      ]
    },
    "title": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "string"
      },
      "details": null,
      "flags": [
        "readonly"
      ]
    }
  },
  "functions": [
    {
      "ret": {
        "type": "qt",
        "module": "qml",
        "name": "void"
      },
      "name": "activate",
      "id": "activate",
      "details": "Request that this toplevel is activated.\nThe request may be ignored by the compositor.\n",
      "params": []
    },
    {
      "ret": {
        "type": "qt",
        "module": "qml",
        "name": "void"
      },
      "name": "fullscreenOn",
      "id": "fullscreenOn",
      "details": "Request that this toplevel is fullscreened on a specific screen.\nThe request may be ignored by the compositor.\n",
      "params": [
        {
          "name": "screen",
          "type": {
            "type": "local",
            "module": "Quickshell",
            "name": "ShellScreen"
          }
        }
      ]
    },
    {
      "ret": {
        "type": "qt",
        "module": "qml",
        "name": "void"
      },
      "name": "setRectangle",
      "id": "setRectangle",
      "details": "Provide a hint to the compositor where the visual representation\nof this toplevel is relative to a quickshell window.\nThis hint can be used visually in operations like minimization.\n",
      "params": [
        {
          "name": "window",
          "type": {
            "type": "qt",
            "module": "qml.QtQml",
            "name": "QtObject"
          }
        },
        {
          "name": "rect",
          "type": {
            "type": "qt",
            "module": "qml",
            "name": "rect"
          }
        }
      ]
    },
    {
      "ret": {
        "type": "qt",
        "module": "qml",
        "name": "void"
      },
      "name": "unsetRectangle",
      "id": "unsetRectangle",
      "details": null,
      "params": []
    }
  ],
  "signals": {
    "closed": {
      "name": "closed",
      "details": null,
      "params": []
    }
  },
  "variants": {}
}