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

What a client's own commits have taught the engine about one window's extent ACROSS a strip that runs one way (ScrollEngine::reportCommittedSize): a tile the client answers longer than its share of its column across the strip, inside the work area. More...

#include <PhosphorScrollEngine/ScrollStashTypes.h>

Public Member Functions

bool isEmpty () const

Public Attributes

int floorPx = 0
 The least share of its column across the strip the tile is laid out with, exactly like a declared minimum across the strip (0: none).
int mainPx = 0
 The tile's offer ALONG the strip when the floor was learned: the floor's premise.
bool gaveBack = false
 A shorter answer has given part or all of floorPx back since it was learned, CommittedMainExtent::gaveBack's rule across the strip: it outlives a floor given back entirely, so a re-teach pins.
bool pinned = false
 A longer answer re-taught the floor after a give-back, so a shorter answer no longer gives it back (CommittedMainExtent::pinned's reason).

Detailed Description

What a client's own commits have taught the engine about one window's extent ACROSS a strip that runs one way (ScrollEngine::reportCommittedSize): a tile the client answers longer than its share of its column across the strip, inside the work area.

That share is a stacked tile's slice of the split, a lone tile's height, or a tabbed column's content rect, which every tab is committed at. Runtime state with CommittedMainExtent's lifetime, since it lives in the same CommittedExtent value.

Member Function Documentation

◆ isEmpty()

bool PhosphorScrollEngine::CommittedCrossExtent::isEmpty ( ) const
inline

Member Data Documentation

◆ floorPx

int PhosphorScrollEngine::CommittedCrossExtent::floorPx = 0

The least share of its column across the strip the tile is laid out with, exactly like a declared minimum across the strip (0: none).

The strip reads it through ScrollLayoutParams::committedCrossFloor, so the stack's split gives the tile at least this and shrinks its siblings (and a tabbed column takes the largest such floor among its tabs).

◆ gaveBack

bool PhosphorScrollEngine::CommittedCrossExtent::gaveBack = false

A shorter answer has given part or all of floorPx back since it was learned, CommittedMainExtent::gaveBack's rule across the strip: it outlives a floor given back entirely, so a re-teach pins.

◆ mainPx

int PhosphorScrollEngine::CommittedCrossExtent::mainPx = 0

The tile's offer ALONG the strip when the floor was learned: the floor's premise.

A client that answers its cross extent from its main one (a whole-number scale picked from the column's width) answers a different width differently, so a column whose offer along the strip has moved past this drops the floor rather than holding the tile to a stale one. Re-stamped when the client's own answer leaves a changed, nonzero floor along the strip (a wider answer teaching one, or a narrower one giving part of one back), since the cross answer in the same commit was given at that very width. An answer that gives the floor along the strip back entirely is not re-stamped, and the premise check reads the offer it moved like any other.

◆ pinned

bool PhosphorScrollEngine::CommittedCrossExtent::pinned = false

A longer answer re-taught the floor after a give-back, so a shorter answer no longer gives it back (CommittedMainExtent::pinned's reason).


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