PhosphorTiles::ScriptedHelpers::ScriptMetadata Struct Reference

Parsed script metadata from a JS-exported metadata object. More...

#include <phosphor-tiles/include/PhosphorTiles/ScriptedAlgorithmHelpers.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, falls back to algorithm default
int	minimumWindows = 0
	0 = unset, falls back to algorithm default
int	masterZoneIndex = -1
bool	supportsMasterCount = false
bool	supportsSplitRatio = false
bool	supportsMemory = false
bool	producesOverlappingZones = false
bool	centerLayout = false
bool	supportsMinSizes = true
	Default true — most algorithms support min sizes.
QString	id
	Optional: register as built-in algorithm ID instead of "script:filename".
QVector< CustomParamDef >	customParams
	Algorithm-declared custom parameters.

Detailed Description

Parsed script metadata from a JS-exported metadata object.

Member Data Documentation

centerLayout

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

customParams

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

Algorithm-declared custom parameters.

defaultMaxWindows

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

0 = unset, falls back to algorithm default

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: register as built-in algorithm ID instead of "script:filename".

masterZoneIndex

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

minimumWindows

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

0 = unset, falls back to algorithm default

name

QString PhosphorTiles::ScriptedHelpers::ScriptMetadata::name

producesOverlappingZones

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

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.

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:

• phosphor-tiles/include/PhosphorTiles/ScriptedAlgorithmHelpers.h