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

Autotile-engine control: algorithm selection, master-area operations, focus cycling, and autotile configuration. Window lifecycle and tile requests ride org.phosphor_works.Placement.Tiling.

Well-known name org.phosphor_works.Placement.Autotile
Source XML org.phosphor_works.Placement.Autotile.xml
Methods 12
Signals 2
Properties 7

Methods

swapWindows()

Swap positions of two tiled windows.

Arg Direction Type Description
windowId1 in s (string) First window ID.
windowId2 in s (string) Second window ID.

promoteToMaster()

Promote a window to the master area.

Arg Direction Type Description
windowId in s (string) Window ID to promote.

demoteFromMaster()

Demote a window from master to stack area.

Arg Direction Type Description
windowId in s (string) Window ID to demote.

focusMaster()

Focus the master window on the current screen.

No arguments.

focusNext()

Cycle focus to the next tiled window.

No arguments.

focusPrevious()

Cycle focus to the previous tiled window.

No arguments.

increaseMasterRatio()

Increase the master area ratio by delta (default 5%).

Arg Direction Type Description
delta in d (double) Amount to increase (e.g., 0.05 for 5%).

decreaseMasterRatio()

Decrease the master area ratio by delta (default 5%).

Arg Direction Type Description
delta in d (double) Amount to decrease (e.g., 0.05 for 5%).

increaseMasterCount()

Increase the number of master windows by one.

No arguments.

decreaseMasterCount()

Decrease the number of master windows by one.

No arguments.

availableAlgorithms()

Get list of available tiling algorithm IDs.

Arg Direction Type Description
algorithms out as (array<string>) List of algorithm IDs (e.g., master-stack, bsp, columns).

algorithmInfo()

Get information about a specific algorithm. An unknown ID returns a default-constructed struct rather than an error; the returned id echoes the queried ID only on a successful lookup, so an empty id means the query missed.

Arg Direction Type Description
algorithmId in s (string) Algorithm ID to query.
info out (sssbbbbdibsbbb) (struct(string,string,string,bool,bool,bool,bool,double,int32,bool,string,bool,bool,bool)) Struct: (id, name, description, supportsMasterCount, supportsSplitRatio, centerLayout, producesOverlappingZones, defaultSplitRatio, defaultMaxWindows, isScripted, zoneNumberDisplay, isUserScript, supportsMemory, supportsSingleWindow).

Signals

algorithmChanged

Emitted when the tiling algorithm changes.

Arg Direction Type Description
algorithmId out s (string) New algorithm ID.

configChanged

Emitted when any autotile configuration property changes.

No payload.

Properties

Property Access Type Description
algorithm readwrite s (string) Current tiling algorithm ID (e.g., master-stack, bsp, columns).
masterRatio readwrite d (double) Ratio of screen width for master area (0.1 to 0.9).
masterCount readwrite i (int32) Number of windows in master area (1 to 5).
innerGap read i (int32) Gap between tiled windows in pixels. Read-only: gaps are rule-backed, set them via org.phosphor_works.Placement.Rules.
outerGap read i (int32) Gap from screen edges in pixels. Read-only: gaps are rule-backed, set them via org.phosphor_works.Placement.Rules.
smartGaps readwrite b (bool) Hide gaps when only one window is tiled.
focusNewWindows readwrite b (bool) Automatically focus newly opened windows.