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

One column: a stack of tiles ACROSS the strip (vertical on a horizontal strip, horizontal on a vertical one). More...

#include <PhosphorScrollEngine/ScrollTypes.h>

Public Member Functions

bool isEmpty () const
const Tile * heightOwner () const
 The tile whose height decides this column's cross extent while tabbed, or nullptr when no live non-minimized tab owns it.
int visibleTileCount () const
 How many tiles are laid out, i.e.
bool isFullyMinimized () const
 True when every tile is minimized — the column occupies no strip MAIN extent.
int indexOfWindow (const QString &windowId) const
QString anchorSiblingFor (int tileIdx) const
 Surviving sibling to anchor a stack re-insert on: the nearest tile above tileIdx with a non-empty id, else the nearest below, else empty.

Public Attributes

QVector< Tile > tiles
int activeTileIdx = 0
ColumnWidth width
ColumnDisplay display = ColumnDisplay::Normal
QString heightOwnerId
 Which tab's height intent decides a TABBED column's cross extent, by window id.
bool maximizedToEdges = false
 Maximize-to-edges (niri parity): the column takes the RAW work area (ScrollLayoutParams::rawWorkArea) on BOTH axes, with inner gaps suppressed between its stacked tiles.

Detailed Description

One column: a stack of tiles ACROSS the strip (vertical on a horizontal strip, horizontal on a vertical one).

Member Function Documentation

◆ anchorSiblingFor()

QString PhosphorScrollEngine::Column::anchorSiblingFor ( int tileIdx) const
inline

Surviving sibling to anchor a stack re-insert on: the nearest tile above tileIdx with a non-empty id, else the nearest below, else empty.

Shared by the float capture, the minimize round trip and the drag-preview slot capture, which must agree on the anchor choice.

◆ heightOwner()

const Tile * PhosphorScrollEngine::Column::heightOwner ( ) const
inline

The tile whose height decides this column's cross extent while tabbed, or nullptr when no live non-minimized tab owns it.

Minimized tabs are refused: they are dropped from the layout entirely, so a height they carry must not size a column they do not appear in.

◆ indexOfWindow()

int PhosphorScrollEngine::Column::indexOfWindow ( const QString & windowId) const
inline

◆ isEmpty()

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

◆ isFullyMinimized()

bool PhosphorScrollEngine::Column::isFullyMinimized ( ) const
inline

True when every tile is minimized — the column occupies no strip MAIN extent.

◆ visibleTileCount()

int PhosphorScrollEngine::Column::visibleTileCount ( ) const
inline

How many tiles are laid out, i.e.

every tile that is not minimized.

The tab indicator's reserved thickness scales with this (one segment per visible tab), and the relayout's own visible-tile walk shares the definition, so it lives beside isFullyMinimized rather than being re-counted at each site — the two answers must agree, and a count that drifted from the minimized predicate would size the reservation for tabs the column does not draw.

Member Data Documentation

◆ activeTileIdx

int PhosphorScrollEngine::Column::activeTileIdx = 0

◆ display

ColumnDisplay PhosphorScrollEngine::Column::display = ColumnDisplay::Normal

◆ heightOwnerId

QString PhosphorScrollEngine::Column::heightOwnerId

Which tab's height intent decides a TABBED column's cross extent, by window id.

Meaningless while the column is Normal, where every tile's own height governs its slice of the stack.

A tabbed column shows one tab at a time, so its extent cannot be "the shown tab's height" — that would resize the column on every tab switch and break the compositor's cross-fade, which is built on the arriving tab occupying the rect the outgoing one vacated. One tab therefore owns the extent for as long as the column is tabbed.

Held as an ID rather than an index because tiles are inserted, removed and reordered underneath it (an index would need re-clamping at every one of those sites, which is precisely the bookkeeping that rots), and because an id that no longer names a live tile is self-describing: the resolver falls back rather than pointing at whatever moved into the slot. Empty means "no tab has claimed it", which resolves to the deterministic scan tabbedColumnCrossPx documents.

This is the ONE place the ownership lives. It used to be inferred — every height writer rewrote its siblings to Auto so a scan for the first non-Auto tab would find the right one. That destroyed the siblings' intents irrecoverably on a tab toggle, and it could not be maintained at all while the column was Normal, so a Normal column with several sized tiles handed its extent to whichever tile sat first in the stack the moment it was tabbed.

◆ maximizedToEdges

bool PhosphorScrollEngine::Column::maximizedToEdges = false

Maximize-to-edges (niri parity): the column takes the RAW work area (ScrollLayoutParams::rawWorkArea) on BOTH axes, with inner gaps suppressed between its stacked tiles.

Declared state, never inferred from rendered rects — the width intent below stays untouched while the flag holds, so clearing it is a plain "stop overriding". The user-facing width and height sizing verbs clear it (the width toggles and presets, expand, equalize, minimize-width, the interactive resize reconcile, and the height verbs when they actually change a height or move a tabbed column's extent owner); display (tab/stack) toggles do not, and neither do the restore paths that re-state a remembered height intent through setWindowHeightIntent. resetToDefaults is the deliberate split: it clears the flag when a default width is supplied and keeps it when the context's width default is "the client decides". This is the one state the effect mirrors onto KWin's maximize bit; toggleMaximizeColumn is a pure width verb with no mirror.

◆ tiles

QVector<Tile> PhosphorScrollEngine::Column::tiles

◆ width

ColumnWidth PhosphorScrollEngine::Column::width

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