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

Autotiling control: enable/disable, algorithm selection, window operations, and focus management.

Well-known name org.plasmazones.Autotile
Source XML org.plasmazones.Autotile.xml
Methods 19
Signals 9
Properties 9

Methods

<tt>retile()</tt>

Force retiling of windows on a screen, or all screens if empty.

Arg Direction Type Description
screenName in s *(string)* Screen to retile, or empty for all screens.

<tt>retileAllScreens()</tt>

Force retiling of all autotile screens. Convenience method equivalent to retile with empty screen name.

No arguments.

<tt>swapWindows()</tt>

Swap positions of two tiled windows.

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

<tt>promoteToMaster()</tt>

Promote a window to the master area.

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

<tt>demoteFromMaster()</tt>

Demote a window from master to stack area.

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

<tt>focusMaster()</tt>

Focus the master window on the current screen.

No arguments.

<tt>focusNext()</tt>

Cycle focus to the next tiled window.

No arguments.

<tt>focusPrevious()</tt>

Cycle focus to the previous tiled window.

No arguments.

<tt>notifyWindowFocused()</tt>

Notify the daemon that a window has been focused (called from KWin effect). Updates autotile engine focus tracking and window-to-screen mapping.

Arg Direction Type Description
windowId in s *(string)* Window ID that gained focus.
screenName in s *(string)* Screen where the window is located (for window-to-screen mapping update).

<tt>increaseMasterRatio()</tt>

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%).

<tt>decreaseMasterRatio()</tt>

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%).

<tt>increaseMasterCount()</tt>

Increase the number of master windows by one.

No arguments.

<tt>decreaseMasterCount()</tt>

Decrease the number of master windows by one.

No arguments.

<tt>availableAlgorithms()</tt>

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).

<tt>algorithmInfo()</tt>

Get information about a specific algorithm.

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

<tt>windowOpened()</tt>

Notify the daemon that a window was opened (called from KWin effect).

Arg Direction Type Description
windowId in s *(string)* Window ID from KWin.
screenName in s *(string)* Screen where the window appeared.
minWidth in i *(int32)* Window minimum width in pixels (0 if unconstrained).
minHeight in i *(int32)* Window minimum height in pixels (0 if unconstrained).

<tt>windowsOpenedBatch()</tt>

Batch window-opened notifications: process multiple windowOpened in one D-Bus call. Used on daemon startup/restart and autotile toggle-on. Array of (windowId, screenId, minWidth, minHeight).

Arg Direction Type Description
entries in a(ssii) *(array<struct(string,string,int32,int32)>)* Array of window-opened entry structs.

<tt>windowMinSizeUpdated()</tt>

Update a window's minimum size at runtime. Called by KWin effect when a window's minimum size changes after initial windowOpened. Triggers retiling if the value differs.

Arg Direction Type Description
windowId in s *(string)* Window ID from KWin.
minWidth in i *(int32)* New minimum width in pixels (0 if unconstrained).
minHeight in i *(int32)* New minimum height in pixels (0 if unconstrained).

<tt>windowClosed()</tt>

Notify the daemon that a window was closed (called from KWin effect).

Arg Direction Type Description
windowId in s *(string)* Window ID from KWin.

Signals

<tt>enabledChanged</tt>

Emitted when autotiling enabled state changes (any screen active/inactive).

Arg Direction Type Description
enabled out b *(bool)* New enabled state.

<tt>autotileScreensChanged</tt>

Emitted when the set of screens using autotile changes.

Arg Direction Type Description
screenNames out as *(array<string>)* List of screen names currently using autotile.
isDesktopSwitch out b *(bool)* True if the change is due to desktop/activity switch (effect should skip geometry restore/re-notification).

<tt>algorithmChanged</tt>

Emitted when the tiling algorithm changes.

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

<tt>tilingChanged</tt>

Emitted when tiling layout changes for a screen.

Arg Direction Type Description
screenName out s *(string)* Screen that was retiled.

<tt>windowsTileRequested</tt>

Emitted when windows should be moved to new geometries (batch).

Arg Direction Type Description
tileRequests out a(siiiissbb) *(array<struct(string,int32,int32,int32,int32,string,string,bool,bool)>)* Array of (windowId, x, y, width, height, zoneId, screenId, monocle, floating).

<tt>focusWindowRequested</tt>

Emitted when a window should be focused by the KWin effect.

Arg Direction Type Description
windowId out s *(string)* Window ID to focus.

<tt>configChanged</tt>

Emitted when any autotile configuration property changes.

No payload.

<tt>windowsReleasedFromTiling</tt>

Emitted when windows are released from autotile management (e.g., screen removed from autotile). KWin effect should restore these windows to pre-autotile geometry.

Arg Direction Type Description
windowIds out as *(array<string>)* Window IDs no longer under autotile control.

<tt>windowFloatingChanged</tt>

Emitted when a window's floating state changes.

Arg Direction Type Description
windowId out s *(string)* Window ID whose floating state changed.
isFloating out b *(bool)* Whether the window is now floating.
screenName out s *(string)* Screen where the window is located.

Properties

Property Access Type Description
enabled read b *(bool)* Whether autotiling is active on any screen (read-only, derived from assignments).
autotileScreens read as *(array<string>)* List of screen names currently using autotile.
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 readwrite i *(int32)* Gap between tiled windows in pixels (0 to 50).
outerGap readwrite i *(int32)* Gap from screen edges in pixels (0 to 50).
smartGaps readwrite b *(bool)* Hide gaps when only one window is tiled.
focusNewWindows readwrite b *(bool)* Automatically focus newly opened windows.