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

One column's resolved output. More...

#include <PhosphorScrollEngine/ScrollTypes.h>

Public Attributes

int columnIndex = -1
QRect rect
 The column's bounding rect.
bool tabbed = false
QRect tabIndicatorRect
 Where the tab indicator is drawn, in the same absolute screen coordinates as rect.
TabIndicatorPosition tabIndicatorPosition = TabIndicatorPosition::Left
 Which edge tabIndicatorRect runs along, so a consumer can tell the indicator's long axis without re-deriving it from the rect's aspect (a one-tab indicator can be square).
bool extentPinnedByMinimum = false
 True when the column's main extent came from its FLOOR rather than from its stored width intent — its tiles' declared minimum or committed floor (plus any main-axis indicator reservation) is at least as wide as the intent.
bool maximizedToEdges = false
 The column's declared maximize-to-edges state, copied through from Column::maximizedToEdges so the apply pass publishes the DECLARED state instead of measuring the rect (measuring is exactly what the extentPinnedByMinimum note above warns against).
QVector< ResolvedTile > tiles

Detailed Description

One column's resolved output.

Member Data Documentation

◆ columnIndex

int PhosphorScrollEngine::ResolvedColumn::columnIndex = -1

◆ extentPinnedByMinimum

bool PhosphorScrollEngine::ResolvedColumn::extentPinnedByMinimum = false

True when the column's main extent came from its FLOOR rather than from its stored width intent — its tiles' declared minimum or committed floor (plus any main-axis indicator reservation) is at least as wide as the intent.

A consumer inferring "this column is maximized" from rect must exclude these: a column whose floor already reaches the work area renders at full extent no matter what the user asks for. Nothing in this repository reads it (the apply pass publishes the declared maximizedToEdges instead); it stays for out-of-tree consumers of this installed struct.

◆ maximizedToEdges

bool PhosphorScrollEngine::ResolvedColumn::maximizedToEdges = false

The column's declared maximize-to-edges state, copied through from Column::maximizedToEdges so the apply pass publishes the DECLARED state instead of measuring the rect (measuring is exactly what the extentPinnedByMinimum note above warns against).

◆ rect

QRect PhosphorScrollEngine::ResolvedColumn::rect

The column's bounding rect.

This is the column's FULL extent, before any within-column indicator reservation — the tiles carry the reduced rects, and tabIndicatorRect carries what was reserved.

On the CROSS axis this rect always spans the whole work area, even when centerShortColumns has centred the tiles WITHIN it, so a stack's tiles may not start where this rect starts. A tabbed column is the exception: its tiles ride this rect, so centring moves the rect itself. Read the tile rects, never this one, to ask where a column's windows sit on the cross axis.

◆ tabbed

bool PhosphorScrollEngine::ResolvedColumn::tabbed = false

◆ tabIndicatorPosition

TabIndicatorPosition PhosphorScrollEngine::ResolvedColumn::tabIndicatorPosition = TabIndicatorPosition::Left

Which edge tabIndicatorRect runs along, so a consumer can tell the indicator's long axis without re-deriving it from the rect's aspect (a one-tab indicator can be square).

◆ tabIndicatorRect

QRect PhosphorScrollEngine::ResolvedColumn::tabIndicatorRect

Where the tab indicator is drawn, in the same absolute screen coordinates as rect.

NULL (default-constructed) whenever no indicator resolves: a normal column, the indicator switched off, or a single-tab column under hideWhenSingleTab. Under placeWithinColumn this sits inside rect; otherwise it sits outside, which is exactly niri's "the indicator can overlay other windows or go off-screen".

◆ tiles

QVector<ResolvedTile> PhosphorScrollEngine::ResolvedColumn::tiles

The documentation for this struct was generated from the following file:
  • phosphor-scroll-engine/include/PhosphorScrollEngine/ScrollTypes.h