Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorProtocol::Service::StripModelKey Namespace Reference

Keys of the STRIP MODEL payload, org.phosphor_works.Placement.Scrolling.stripModelJson: the whole strip of one screen as the Phosphor shell's placement map draws it, columns on and off screen alike, in pixels along the strip's own axis. More...

Functions

constexpr QLatin1String Axis ("axis")
 0 for a horizontal strip, 1 for a vertical one.
constexpr QLatin1String ViewOffsetPx ("viewOffsetPx")
 The viewport's leading edge in strip coordinates.
constexpr QLatin1String ViewportPx ("viewportPx")
 The viewport's extent along the strip (the work area's main extent).
constexpr QLatin1String StripExtentPx ("stripExtentPx")
 The strip's total extent: every non-minimized column plus the gaps.
constexpr QLatin1String ActiveColumn ("activeColumn")
 Strip index of the active column, -1 on an empty strip.
constexpr QLatin1String Columns ("columns")
 The column array, in strip order.
constexpr QLatin1String Index ("index")
 A column's strip index, which is also what focusColumnAt takes.
constexpr QLatin1String StripPosPx ("stripPosPx")
 A column's leading edge in strip coordinates.
constexpr QLatin1String ExtentPx ("extentPx")
 A column's extent along the strip; 0 for a fully minimized column.
constexpr QLatin1String Display ("display")
 A column's display as a PhosphorScrollEngine::ColumnDisplay underlying value (0 Normal, 1 Tabbed).
constexpr QLatin1String ActiveTile ("activeTile")
 Index into the column's tiles of its active tile.
constexpr QLatin1String Maximized ("maximized")
 The column's declared maximize-to-edges state.
constexpr QLatin1String Tiles ("tiles")
 The column's tile array, in stack order, minimized tiles included.
constexpr QLatin1String WindowId ("windowId")
 A tile's window id.
constexpr QLatin1String CrossPx ("crossPx")
 A tile's resolved extent across the strip; 0 for a minimized tile.
constexpr QLatin1String Minimized ("minimized")
 Whether the tile is minimized (kept in the stack order, laid out nowhere).

Detailed Description

Keys of the STRIP MODEL payload, org.phosphor_works.Placement.Scrolling.stripModelJson: the whole strip of one screen as the Phosphor shell's placement map draws it, columns on and off screen alike, in pixels along the strip's own axis.

Spelled here so the daemon's serializer (plasmazones/src/dbus/scrollingadaptor/scrollingadaptor.cpp) and the shell's reader (phosphor-shell-libs/libs/phosphor-shell/src/placementmapparser.cpp) compile against one definition. Distinct from StripPreviewKey above, which describes only the VISIBLE tiles as screen-normalized rects for a thumbnail.

Display, ActiveTile, Maximized and CrossPx are forward payload: the daemon writes them and nothing in production reads them. The shell's parser reads the rest.

Function Documentation

◆ ActiveColumn()

QLatin1String PhosphorProtocol::Service::StripModelKey::ActiveColumn ( "activeColumn" )
inlineconstexpr

Strip index of the active column, -1 on an empty strip.

◆ ActiveTile()

QLatin1String PhosphorProtocol::Service::StripModelKey::ActiveTile ( "activeTile" )
inlineconstexpr

Index into the column's tiles of its active tile.

◆ Axis()

QLatin1String PhosphorProtocol::Service::StripModelKey::Axis ( "axis" )
inlineconstexpr

0 for a horizontal strip, 1 for a vertical one.

Every other pixel value on the payload runs along this axis (main) or across it (cross).

◆ Columns()

QLatin1String PhosphorProtocol::Service::StripModelKey::Columns ( "columns" )
inlineconstexpr

The column array, in strip order.

◆ CrossPx()

QLatin1String PhosphorProtocol::Service::StripModelKey::CrossPx ( "crossPx" )
inlineconstexpr

A tile's resolved extent across the strip; 0 for a minimized tile.

◆ Display()

QLatin1String PhosphorProtocol::Service::StripModelKey::Display ( "display" )
inlineconstexpr

A column's display as a PhosphorScrollEngine::ColumnDisplay underlying value (0 Normal, 1 Tabbed).

◆ ExtentPx()

QLatin1String PhosphorProtocol::Service::StripModelKey::ExtentPx ( "extentPx" )
inlineconstexpr

A column's extent along the strip; 0 for a fully minimized column.

◆ Index()

QLatin1String PhosphorProtocol::Service::StripModelKey::Index ( "index" )
inlineconstexpr

A column's strip index, which is also what focusColumnAt takes.

◆ Maximized()

QLatin1String PhosphorProtocol::Service::StripModelKey::Maximized ( "maximized" )
inlineconstexpr

The column's declared maximize-to-edges state.

◆ Minimized()

QLatin1String PhosphorProtocol::Service::StripModelKey::Minimized ( "minimized" )
inlineconstexpr

Whether the tile is minimized (kept in the stack order, laid out nowhere).

◆ StripExtentPx()

QLatin1String PhosphorProtocol::Service::StripModelKey::StripExtentPx ( "stripExtentPx" )
inlineconstexpr

The strip's total extent: every non-minimized column plus the gaps.

◆ StripPosPx()

QLatin1String PhosphorProtocol::Service::StripModelKey::StripPosPx ( "stripPosPx" )
inlineconstexpr

A column's leading edge in strip coordinates.

◆ Tiles()

QLatin1String PhosphorProtocol::Service::StripModelKey::Tiles ( "tiles" )
inlineconstexpr

The column's tile array, in stack order, minimized tiles included.

◆ ViewOffsetPx()

QLatin1String PhosphorProtocol::Service::StripModelKey::ViewOffsetPx ( "viewOffsetPx" )
inlineconstexpr

The viewport's leading edge in strip coordinates.

May overhang either end of the strip: the centering policy centres a short strip by design.

◆ ViewportPx()

QLatin1String PhosphorProtocol::Service::StripModelKey::ViewportPx ( "viewportPx" )
inlineconstexpr

The viewport's extent along the strip (the work area's main extent).

◆ WindowId()

QLatin1String PhosphorProtocol::Service::StripModelKey::WindowId ( "windowId" )
inlineconstexpr

A tile's window id.