Skip to content
Vextr

LayoutSpec

LayoutSpec

Section titled “LayoutSpec”
#include <Layout.hpp>

Specifies how a widget should be sized and positioned within its layout slot.

This is passed to Container::addChild() to control layout behavior. Different layout engines may use different fields.

Common usage:

// Widget takes 50% of available width
container->addChild(widget, LayoutSpec{.fixedW = pct(50)});


// Widget has equal weight with siblings (stretches)
container->addChild(widget, LayoutSpec{.ratio = 1.0f});

Public Attributes

Section titled “Public Attributes”
ReturnNameDescription
floatratioRelative weight among siblings in stack layouts. Used when dividing remaining space among children.
ScalarSpecfixedWFixed slot width - overrides ratio in horizontal stacks.
ScalarSpecfixedHFixed slot height - overrides ratio in vertical stacks.
ScalarSpecsizeWIf set, widget is this size inside its slot. If not set, widget fills slot according to alignH/alignV.
ScalarSpecsizeH
ScalarSpecminW
ScalarSpecminHMinimum widget size.
ScalarSpecmaxW
ScalarSpecmaxHMaximum widget size.
AlignalignHHorizontal alignment.
AlignalignVVertical alignment.
MarginSpecmarginSpacing around widget.
intcolColumn in grid (0-based)
introwRow in grid (0-based)
intcolSpanHow many columns this widget spans.
introwSpanHow many rows this widget spans.
ScalarSpecabsXAbsolute X position.
ScalarSpecabsYAbsolute Y position.

ratio

Section titled “ratio”
float ratio = 1.0f

Relative weight among siblings in stack layouts. Used when dividing remaining space among children.

fixedW

Section titled “fixedW”
ScalarSpec fixedW

Fixed slot width - overrides ratio in horizontal stacks.

fixedH

Section titled “fixedH”
ScalarSpec fixedH

Fixed slot height - overrides ratio in vertical stacks.

sizeW

Section titled “sizeW”
ScalarSpec sizeW

If set, widget is this size inside its slot. If not set, widget fills slot according to alignH/alignV.

sizeH

Section titled “sizeH”
ScalarSpec sizeH

minW

Section titled “minW”
ScalarSpec minW

minH

Section titled “minH”
ScalarSpec minH

Minimum widget size.

maxW

Section titled “maxW”
ScalarSpec maxW

maxH

Section titled “maxH”
ScalarSpec maxH

Maximum widget size.

alignH

Section titled “alignH”
Align alignH = Align::Stretch

Horizontal alignment.

Alignment of widget within slot. Only meaningful when sizeW/sizeH is set or widget is smaller than slot.

alignV

Section titled “alignV”
Align alignV = Align::Stretch

Vertical alignment.

margin

Section titled “margin”
MarginSpec margin

Spacing around widget.

col

Section titled “col”
int col = 0

Column in grid (0-based)

row

Section titled “row”
int row = 0

Row in grid (0-based)

colSpan

Section titled “colSpan”
int colSpan = 1

How many columns this widget spans.

rowSpan

Section titled “rowSpan”
int rowSpan = 1

How many rows this widget spans.

absX

Section titled “absX”
ScalarSpec absX

Absolute X position.

absY

Section titled “absY”
ScalarSpec absY

Absolute Y position.