Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorTiles::ScriptedHelpers::ScriptMetadata Struct Reference

Parsed metadata from a scripted algorithm's metadata table. More...

#include <PhosphorTiles/TileScriptMetadata.h>

Public Attributes

QString name
QString description
PhosphorLayout::ZoneNumberDisplay zoneNumberDisplay = PhosphorLayout::ZoneNumberDisplay::RendererDecides
qreal defaultSplitRatio = 0.0
 0.0 = unset, falls back to algorithm default
int defaultMaxWindows = 0
 0 = unset
int minimumWindows = 0
 0 = unset
int masterZoneIndex = -1
bool supportsMasterCount = false
bool supportsSplitRatio = false
bool supportsMemory = false
bool supportsScriptState = false
 Persists an opaque ctx.state bag across retiles (non-tree memory).
bool producesOverlappingZones = false
bool centerLayout = false
bool supportsSingleWindow = false
 Owns the single-window case (else calculateZones() fills the work area).
bool supportsMinSizes = true
 Default true — most algorithms support min sizes.
bool retileOnFocus = false
 Re-run the layout when focus moves between tiled windows (focus-driven layouts).
QString overlapStacking
 For overlap layouts: "firstOnTop" or "lastOnTop"; empty = lastOnTop.
QString id
 Optional algorithm id (else "script:filename").
QVector< CustomParamDef > customParams

Detailed Description

Parsed metadata from a scripted algorithm's metadata table.

Member Data Documentation

◆ centerLayout

bool PhosphorTiles::ScriptedHelpers::ScriptMetadata::centerLayout = false

◆ customParams

QVector<CustomParamDef> PhosphorTiles::ScriptedHelpers::ScriptMetadata::customParams

◆ defaultMaxWindows

int PhosphorTiles::ScriptedHelpers::ScriptMetadata::defaultMaxWindows = 0

0 = unset

◆ defaultSplitRatio

qreal PhosphorTiles::ScriptedHelpers::ScriptMetadata::defaultSplitRatio = 0.0

0.0 = unset, falls back to algorithm default

◆ description

QString PhosphorTiles::ScriptedHelpers::ScriptMetadata::description

◆ id

QString PhosphorTiles::ScriptedHelpers::ScriptMetadata::id

Optional algorithm id (else "script:filename").

◆ masterZoneIndex

int PhosphorTiles::ScriptedHelpers::ScriptMetadata::masterZoneIndex = -1

◆ minimumWindows

int PhosphorTiles::ScriptedHelpers::ScriptMetadata::minimumWindows = 0

0 = unset

◆ name

QString PhosphorTiles::ScriptedHelpers::ScriptMetadata::name

◆ overlapStacking

QString PhosphorTiles::ScriptedHelpers::ScriptMetadata::overlapStacking

For overlap layouts: "firstOnTop" or "lastOnTop"; empty = lastOnTop.

◆ producesOverlappingZones

bool PhosphorTiles::ScriptedHelpers::ScriptMetadata::producesOverlappingZones = false

◆ retileOnFocus

bool PhosphorTiles::ScriptedHelpers::ScriptMetadata::retileOnFocus = false

Re-run the layout when focus moves between tiled windows (focus-driven layouts).

◆ supportsMasterCount

bool PhosphorTiles::ScriptedHelpers::ScriptMetadata::supportsMasterCount = false

◆ supportsMemory

bool PhosphorTiles::ScriptedHelpers::ScriptMetadata::supportsMemory = false

◆ supportsMinSizes

bool PhosphorTiles::ScriptedHelpers::ScriptMetadata::supportsMinSizes = true

Default true — most algorithms support min sizes.

◆ supportsScriptState

bool PhosphorTiles::ScriptedHelpers::ScriptMetadata::supportsScriptState = false

Persists an opaque ctx.state bag across retiles (non-tree memory).

◆ supportsSingleWindow

bool PhosphorTiles::ScriptedHelpers::ScriptMetadata::supportsSingleWindow = false

Owns the single-window case (else calculateZones() fills the work area).

◆ supportsSplitRatio

bool PhosphorTiles::ScriptedHelpers::ScriptMetadata::supportsSplitRatio = false

◆ zoneNumberDisplay

PhosphorLayout::ZoneNumberDisplay PhosphorTiles::ScriptedHelpers::ScriptMetadata::zoneNumberDisplay = PhosphorLayout::ZoneNumberDisplay::RendererDecides

The documentation for this struct was generated from the following file: