Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorScrollEngine::ScrollPerScreenKeys Namespace Reference

Per-screen override-map keys for ScrollEngine::applyPerScreenConfig. More...

Functions

QString centerFocusedColumn ()
QString stripAxis ()
 SHARED key: which way this screen's strip runs, as the TRI-STATE intent (0 auto, 1 horizontal, 2 vertical) — not the resolved two-valued PhosphorProtocol::ScrollAxis, whose Horizontal is 0.
QString defaultColumnWidth ()
 RULE channel: a bare work-area fraction (SetScrollDefaultColumnWidth).
QString defaultColumnDisplay ()
QString defaultColumnWidthKind ()
 SETTINGS channel: the per-screen override map mirrors the config's kind-aware width trio so a monitor can pin Fixed pixels or a preset index, which the rule channel's bare fraction cannot express.
QString defaultColumnWidthValue ()
QString defaultColumnWidthPresetIndex ()
QString defaultWindowHeight ()
 RULE channel for the default window height: a bare work-area fraction (resolved against the live work area at relayout, committed as Fixed).
QString defaultWindowHeightKind ()
 SETTINGS channel height trio (kind / fixed px / preset index).
QString defaultWindowHeightValue ()
QString defaultWindowHeightPresetIndex ()
QString insertPosition ()
 RULE channel (SetScrollInsertPosition); the settings store deliberately does not write it — insert position is app-wide config, per-context only via rules, matching the tiling siblings' exposure.
QString alwaysCenterSingleColumn ()
 RULE channel for the scrolling BEHAVIOUR toggles (SetScrollAlwaysCenter- SingleColumn / …CenterShortColumns / …RespectMinimumSize / …CropStraddlers / …FocusNewWindows / …SmartGaps / …StickyWindowHandling).
QString centerShortColumns ()
QString respectMinimumSize ()
QString cropStraddlers ()
QString focusNewWindows ()
QString smartGaps ()
QString stickyWindowHandling ()
 StickyWindowHandling ints (treatAsNormal 0 / restoreOnly 1 / ignoreAll 2).
QString tabIndicatorEnabled ()
 RULE channel for the tab indicator's GEOMETRY half, one key per property so independent rules cascade per-property the way the width trio does.
QString tabIndicatorHideWhenSingleTab ()
QString tabIndicatorPlaceWithinColumn ()
QString tabIndicatorGap ()
QString tabIndicatorWidth ()
QString tabIndicatorLengthProportion ()
QString tabIndicatorPosition ()
QString presetColumnWidths ()
 TEMPLATE channel: preset lists from the screen's assigned scrolling template, as a QVariantList of doubles.
QString presetWindowHeights ()
QString templateColumns ()
 TEMPLATE channel: the template's seed BLUEPRINT as a QVariantList of {width (double fraction), display (int ColumnDisplay)} maps, ordered along the strip.
QString templateColumnWidth ()
QString templateColumnDisplay ()

Detailed Description

Per-screen override-map keys for ScrollEngine::applyPerScreenConfig.

Both sides of the daemon↔engine seam MUST use these accessors — a raw string literal here is a silent rule-override drop when it drifts (mirrors the autotile PerScreenKeys convention).

Function Documentation

◆ alwaysCenterSingleColumn()

QString PhosphorScrollEngine::ScrollPerScreenKeys::alwaysCenterSingleColumn ( )
inline

RULE channel for the scrolling BEHAVIOUR toggles (SetScrollAlwaysCenter- SingleColumn / …CenterShortColumns / …RespectMinimumSize / …CropStraddlers / …FocusNewWindows / …SmartGaps / …StickyWindowHandling).

Like insertPosition these are rules-only: the per-screen settings store does not write them, so an absent key means "use the global config value" and the engine's effective* readers supply exactly that fallback.

◆ centerFocusedColumn()

QString PhosphorScrollEngine::ScrollPerScreenKeys::centerFocusedColumn ( )
inline

◆ centerShortColumns()

QString PhosphorScrollEngine::ScrollPerScreenKeys::centerShortColumns ( )
inline

◆ cropStraddlers()

QString PhosphorScrollEngine::ScrollPerScreenKeys::cropStraddlers ( )
inline

◆ defaultColumnDisplay()

QString PhosphorScrollEngine::ScrollPerScreenKeys::defaultColumnDisplay ( )
inline

◆ defaultColumnWidth()

QString PhosphorScrollEngine::ScrollPerScreenKeys::defaultColumnWidth ( )
inline

RULE channel: a bare work-area fraction (SetScrollDefaultColumnWidth).

Outranks the settings-channel kind trio below — rule > per-screen setting > global. The settings app never writes this key.

◆ defaultColumnWidthKind()

QString PhosphorScrollEngine::ScrollPerScreenKeys::defaultColumnWidthKind ( )
inline

SETTINGS channel: the per-screen override map mirrors the config's kind-aware width trio so a monitor can pin Fixed pixels or a preset index, which the rule channel's bare fraction cannot express.

◆ defaultColumnWidthPresetIndex()

QString PhosphorScrollEngine::ScrollPerScreenKeys::defaultColumnWidthPresetIndex ( )
inline

◆ defaultColumnWidthValue()

QString PhosphorScrollEngine::ScrollPerScreenKeys::defaultColumnWidthValue ( )
inline

◆ defaultWindowHeight()

QString PhosphorScrollEngine::ScrollPerScreenKeys::defaultWindowHeight ( )
inline

RULE channel for the default window height: a bare work-area fraction (resolved against the live work area at relayout, committed as Fixed).

◆ defaultWindowHeightKind()

QString PhosphorScrollEngine::ScrollPerScreenKeys::defaultWindowHeightKind ( )
inline

SETTINGS channel height trio (kind / fixed px / preset index).

◆ defaultWindowHeightPresetIndex()

QString PhosphorScrollEngine::ScrollPerScreenKeys::defaultWindowHeightPresetIndex ( )
inline

◆ defaultWindowHeightValue()

QString PhosphorScrollEngine::ScrollPerScreenKeys::defaultWindowHeightValue ( )
inline

◆ focusNewWindows()

QString PhosphorScrollEngine::ScrollPerScreenKeys::focusNewWindows ( )
inline

◆ insertPosition()

QString PhosphorScrollEngine::ScrollPerScreenKeys::insertPosition ( )
inline

RULE channel (SetScrollInsertPosition); the settings store deliberately does not write it — insert position is app-wide config, per-context only via rules, matching the tiling siblings' exposure.

◆ presetColumnWidths()

QString PhosphorScrollEngine::ScrollPerScreenKeys::presetColumnWidths ( )
inline

TEMPLATE channel: preset lists from the screen's assigned scrolling template, as a QVariantList of doubles.

A present, non-empty list replaces the settings-configured preset list WHOLESALE for that screen — no merge, so preset indices and the cycle order stay stable within one template. The daemon writes these from the assignment cascade; neither the rules bridge nor the settings app does.

◆ presetWindowHeights()

QString PhosphorScrollEngine::ScrollPerScreenKeys::presetWindowHeights ( )
inline

◆ respectMinimumSize()

QString PhosphorScrollEngine::ScrollPerScreenKeys::respectMinimumSize ( )
inline

◆ smartGaps()

QString PhosphorScrollEngine::ScrollPerScreenKeys::smartGaps ( )
inline

◆ stickyWindowHandling()

QString PhosphorScrollEngine::ScrollPerScreenKeys::stickyWindowHandling ( )
inline

StickyWindowHandling ints (treatAsNormal 0 / restoreOnly 1 / ignoreAll 2).

◆ stripAxis()

QString PhosphorScrollEngine::ScrollPerScreenKeys::stripAxis ( )
inline

SHARED key: which way this screen's strip runs, as the TRI-STATE intent (0 auto, 1 horizontal, 2 vertical) — not the resolved two-valued PhosphorProtocol::ScrollAxis, whose Horizontal is 0.

The two numberings deliberately disagree and must never be cast into each other.

Written by BOTH channels: the per-screen settings store seeds it and the SetScrollStripAxis context rule overwrites the seed where a rule matched (rule > per-screen setting > global, the same collapse every shared int key gets in the daemon's merge). A rule that matches on desktop or activity can therefore flip the axis on a live populated strip when the context switches; the flip rides the ordinary retile the override-map change schedules.

◆ tabIndicatorEnabled()

QString PhosphorScrollEngine::ScrollPerScreenKeys::tabIndicatorEnabled ( )
inline

RULE channel for the tab indicator's GEOMETRY half, one key per property so independent rules cascade per-property the way the width trio does.

The indicator's paint half never reaches this library (see IScrollSettings), so it overrides through the daemon's own channel and has no key here. Absent key = fall back to the configured value.

◆ tabIndicatorGap()

QString PhosphorScrollEngine::ScrollPerScreenKeys::tabIndicatorGap ( )
inline

◆ tabIndicatorHideWhenSingleTab()

QString PhosphorScrollEngine::ScrollPerScreenKeys::tabIndicatorHideWhenSingleTab ( )
inline

◆ tabIndicatorLengthProportion()

QString PhosphorScrollEngine::ScrollPerScreenKeys::tabIndicatorLengthProportion ( )
inline

◆ tabIndicatorPlaceWithinColumn()

QString PhosphorScrollEngine::ScrollPerScreenKeys::tabIndicatorPlaceWithinColumn ( )
inline

◆ tabIndicatorPosition()

QString PhosphorScrollEngine::ScrollPerScreenKeys::tabIndicatorPosition ( )
inline

◆ tabIndicatorWidth()

QString PhosphorScrollEngine::ScrollPerScreenKeys::tabIndicatorWidth ( )
inline

◆ templateColumnDisplay()

QString PhosphorScrollEngine::ScrollPerScreenKeys::templateColumnDisplay ( )
inline

◆ templateColumns()

QString PhosphorScrollEngine::ScrollPerScreenKeys::templateColumns ( )
inline

TEMPLATE channel: the template's seed BLUEPRINT as a QVariantList of {width (double fraction), display (int ColumnDisplay)} maps, ordered along the strip.

Consumed at column CREATION on the fresh-open path: a column materializing while the strip holds fewer columns than the blueprint takes the next entry's width and display (per-window open rules still outrank it). Never resizes existing columns. Only the daemon writes it.

An entry may carry either key alone: a missing width or display falls through to the effective default rather than reading as zero. That makes the precedence asymmetric on purpose. Within the blueprint, an entry that DOES carry a display outranks a screen-wide SetScrollDefaultColumnDisplay rule; past the blueprint (and for entries that omit the key) the rule decides. A per-column blueprint entry is the more specific statement, so it wins where it speaks and stays silent where it does not. The in-tree daemon always writes both keys on every entry, so the either-key tolerance is a public-API belt for embedder-supplied maps rather than a fix for a shipped bug.

◆ templateColumnWidth()

QString PhosphorScrollEngine::ScrollPerScreenKeys::templateColumnWidth ( )
inline