Quickshell

Types

Hyprland: QtObject

singleton
import Quickshell.Hyprland
  • eventSocketPath :  string
    readonly

    Path to the event socket (.socket2.sock)

  • focusedMonitor :  HyprlandMonitor
    readonly

    The currently focused hyprland monitor. May be null.

  • monitors :  ObjectModel <HyprlandMonitor>
    readonly

    All hyprland monitors.

  • requestSocketPath :  string
    readonly

    Path to the request socket (.socket.sock)

  • workspaces :  ObjectModel <HyprlandWorkspace>
    readonly

    All hyprland workspaces.

  • dispatch(request) :  void

    Property request: string

    Execute a hyprland dispatcher.

  • monitorFor(screen) :  HyprlandMonitor

    Property screen: ShellScreen

    Get the HyprlandMonitor object that corrosponds to a quickshell screen.

  • refreshMonitors() :  void

    Refresh monitor information.

    Many actions that will invalidate monitor state don’t send events, so this function is available if required.

  • refreshWorkspaces() :  void

    Refresh workspace information.

    Many actions that will invalidate workspace state don’t send events, so this function is available if required.

  • rawEvent(event)   ?

    Property event: HyprlandEvent

    Emitted for every event that comes in through the hyprland event socket (socket2).

    See Hyprland Wiki: IPC for a list of events.