Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
org.phosphor_works.Placement.Control

High-level convenience API for third-party integrations and scripts.

Well-known name org.phosphor_works.Placement.Control
Source XML org.phosphor_works.Placement.Control.xml
Methods 6
Signals 1
Properties 0

Methods

snapWindowToZone()

Snap a window to a zone by number on a screen.

Arg Direction Type Description
windowId in s (string) Window to snap.
zoneNumber in i (int32) Zone number, 1-based; any number the layout has.
screenId in s (string) Screen to snap on, a screen id or connector name. Empty means the screen the window is on.

toggleAutotileForScreen()

Switch the screen between snapping and autotile, the way the mode-toggle shortcut does on that screen. It acts on the screen's current desktop and activity, brings back the layout or algorithm it had before, does not switch into a mode that is turned off, and shows the disabled notice where PlasmaZones is disabled. A scrolling screen switches to autotile.

Arg Direction Type Description
screenId in s (string) Screen to toggle: a screen id or a connector name. A monitor split into virtual screens resolves to the one the cursor is in.

getFullState()

Get complete daemon state snapshot as JSON.

Arg Direction Type Description
state out s (string) JSON with layouts, windows, autotile state.

generateSupportReport()

Generate a redacted support report for bug reports and discussions.

Arg Direction Type Description
sinceMinutes in i (int32) Minutes of journal logs to include (0 = default 30, max 120).
report out s (string) Markdown-formatted support report with config, screens, and logs.

quit()

Ask the daemon to shut down cleanly. Quits the event loop, so the daemon runs its ordinary teardown on the main thread rather than tearing down inside the call. This is what plasmazonesd --replace calls on the running instance before claiming the bus name. Calling it while a shutdown is already in flight is a no-op.

No arguments.

getShortcutsJson()

Every settings-driven PlasmaZones shortcut with the user's effective key bindings, as a JSON array, for the Phosphor shell's keybind cheatsheet (which draws each chord on the placement-map rect it acts on). One object per action, uncompressed: id (the action id, e.g. move_window_left, snap_to_zone_3, scroll_focus_column_right), label, description, category, categoryOrder, rowOrder, triggers (array of key sequences in Qt PortableText spelling, e.g. Meta+Left; empty when unbound), assigned (bool), mode (all | snapping | autotile | scrolling | layouts | managed: which placement mode the action applies in). Sorted by categoryOrder then rowOrder. Answers [] before the daemon has registered its shortcuts and after it has released them. Changes are announced by shortcutsChanged.

Arg Direction Type Description
shortcuts out s (string) JSON array of shortcut objects.

Signals

shortcutsChanged

The catalog behind getShortcutsJson changed: a sequence was rebound (in the settings, or externally through the compositor) or the registration batch settled. Consumers re-read getShortcutsJson.

No payload.