{ "name": "GlobalShortcut", "module": "Quickshell.Hyprland", "type": "class", "super": { "type": "qt", "module": "qml.QtQml", "name": "QtObject" }, "description": "Hyprland global shortcut.", "details": "Global shortcut implemented with [hyprland_global_shortcuts_v1].\n\nYou can use this within hyprland as a global shortcut:\n```\nbind = , , global, :\n```\nSee [the wiki] for details.\n\n> [!WARNING] The shortcuts protocol does not allow duplicate appid + name pairs.\n> Within a single instance of quickshell this is handled internally, and both\n> users will be notified, but multiple instances of quickshell or XDPH may collide.\n>\n> If that happens, whichever client that tries to register the shortcuts last will crash.\n\n> [!NOTE] This type does *not* use the xdg-desktop-portal global shortcuts protocol,\n> as it is not fully functional without flatpak and would cause a considerably worse\n> user experience from other limitations. It will only work with Hyprland.\n> Note that, as this type bypasses xdg-desktop-portal, XDPH is not required.\n\n[hyprland_global_shortcuts_v1]: https://github.com/hyprwm/hyprland-protocols/blob/main/protocols/hyprland-global-shortcuts-v1.xml\n[the wiki]: https://wiki.hyprland.org/Configuring/Binds/#dbus-global-shortcuts\n", "properties": { "name": { "type": { "type": "qt", "module": "qml", "name": "string" }, "details": "The name of the shortcut.\nYou cannot change this at runtime.\n" }, "pressed": { "type": { "type": "qt", "module": "qml", "name": "bool" }, "details": "If the keybind is currently pressed.\n", "flags": [ "readonly" ] }, "triggerDescription": { "type": { "type": "qt", "module": "qml", "name": "string" }, "details": "Have not seen this used ever, but included for completeness. Safe to ignore.\n" }, "description": { "type": { "type": "qt", "module": "qml", "name": "string" }, "details": "The description of the shortcut that appears in `hyprctl globalshortcuts`.\nYou cannot change this at runtime.\n" }, "appid": { "type": { "type": "qt", "module": "qml", "name": "string" }, "details": "The appid of the shortcut. Defaults to `quickshell`.\nYou cannot change this at runtime.\n\nIf you have more than one shortcut we recommend subclassing\nGlobalShortcut to set this.\n" } }, "functions": [], "signals": { "pressed": { "name": "pressed", "details": "Fired when the keybind is pressed.\n", "params": [] }, "released": { "name": "released", "details": "Fired when the keybind is released.\n", "params": [] } }, "variants": {} }