{ "name": "Hyprland", "module": "Quickshell.Hyprland", "type": "class", "super": { "type": "qt", "module": "qml.QtQml", "name": "QtObject" }, "description": null, "details": null, "flags": [ "singleton" ], "properties": { "focusedMonitor": { "type": { "type": "local", "module": "Quickshell.Hyprland", "name": "HyprlandMonitor" }, "details": "The currently focused hyprland monitor. May be null.\n", "flags": [ "readonly" ] }, "requestSocketPath": { "type": { "type": "qt", "module": "qml", "name": "string" }, "details": "Path to the request socket (.socket.sock)\n", "flags": [ "readonly" ] }, "monitors": { "type": { "type": "local", "module": "Quickshell", "name": "ObjectModel", "of": { "type": "local", "module": "Quickshell.Hyprland", "name": "HyprlandMonitor" } }, "details": "All hyprland monitors.\n", "flags": [ "readonly" ] }, "eventSocketPath": { "type": { "type": "qt", "module": "qml", "name": "string" }, "details": "Path to the event socket (.socket2.sock)\n", "flags": [ "readonly" ] }, "workspaces": { "type": { "type": "local", "module": "Quickshell", "name": "ObjectModel", "of": { "type": "local", "module": "Quickshell.Hyprland", "name": "HyprlandWorkspace" } }, "details": "All hyprland workspaces.\n", "flags": [ "readonly" ] } }, "functions": [ { "ret": { "type": "qt", "module": "qml", "name": "void" }, "name": "dispatch", "id": "dispatch", "details": "Execute a hyprland [dispatcher](https://wiki.hyprland.org/Configuring/Dispatchers).\n", "params": [ { "name": "request", "type": { "type": "qt", "module": "qml", "name": "string" } } ] }, { "ret": { "type": "local", "module": "Quickshell.Hyprland", "name": "HyprlandMonitor" }, "name": "monitorFor", "id": "monitorFor", "details": "Get the HyprlandMonitor object that corrosponds to a quickshell screen.\n", "params": [ { "name": "screen", "type": { "type": "local", "module": "Quickshell", "name": "ShellScreen" } } ] }, { "ret": { "type": "qt", "module": "qml", "name": "void" }, "name": "refreshMonitors", "id": "refreshMonitors", "details": "Refresh monitor information.\n\nMany actions that will invalidate monitor state don't send events,\nso this function is available if required.\n", "params": [] }, { "ret": { "type": "qt", "module": "qml", "name": "void" }, "name": "refreshWorkspaces", "id": "refreshWorkspaces", "details": "Refresh workspace information.\n\nMany actions that will invalidate workspace state don't send events,\nso this function is available if required.\n", "params": [] } ], "signals": { "rawEvent": { "name": "rawEvent", "details": "Emitted for every event that comes in through the hyprland event socket (socket2).\n\nSee [Hyprland Wiki: IPC](https://wiki.hyprland.org/IPC/) for a list of events.\n", "params": [ { "name": "event", "type": { "type": "local", "module": "Quickshell.Hyprland", "name": "HyprlandEvent" } } ] } }, "variants": {} }