Hyprland: QtObject [singleton]

import Quickshell.Hyprland

Properties

Functions

Signals

Property Details

[readonly]

eventSocketPath: string

Path to the event socket (.socket2.sock)

[readonly]

focusedMonitor: HyprlandMonitor

The currently focused hyprland monitor. May be null.

[readonly]

monitors: ObjectModel<HyprlandMonitor>

All hyprland monitors.

[readonly]

requestSocketPath: string

Path to the request socket (.socket.sock)

[readonly]

workspaces: ObjectModel<HyprlandWorkspace>

All hyprland workspaces.

Function Details

void dispatch(request: string)

Execute a hyprland dispatcher.

HyprlandMonitor monitorFor(screen: ShellScreen)

Get the HyprlandMonitor object that corrosponds to a quickshell screen.

void refreshMonitors()

Refresh monitor information.

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

void refreshWorkspaces()

Refresh workspace information.

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

Signal Details

rawEvent(event: HyprlandEvent)

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

See Hyprland Wiki: IPC for a list of events.