Per-element overrides of style layout properties. More...

#include <gui_core/layout/gui_constraints.h>

Classes
struct	[struct].grid
	Grid item overrides; Default tracks and start < 0 keep the style's values. More...

Public Member Functions
	LayoutOverride ()=default
constexpr bool	HasFixedWidth () const
	Whether an explicit width / height is set; axis 0 = width, 1 = height.
constexpr bool	HasFixedHeight () const
constexpr bool	HasFixedAxis (int axis) const
constexpr bool	IsFullyConstrained () const
	Both width and height are explicit.
constexpr int32_t	ClampWidth (int32_t w) const
	Clamps a size to the min / max constraints, ignoring the explicit size.
constexpr int32_t	ClampHeight (int32_t h) const
int2	Size () const
	The explicit sizes; kAuto on axes without one.
int2	ApplySize (int2 s) const
	The explicit size where set, else s clamped to min / max.
int32_t	ApplyWidth (int32_t s) const
int32_t	ApplyHeight (int32_t s) const
constexpr bool	IsInFlowX () const
	True when the element takes part in the parent's flow on that axis (see PositionConstraintAxis::IsInFlow).
constexpr bool	IsInFlowY () const
constexpr bool	IsInFlow () const
constexpr bool	IsInFlowAxis (int axis) const
void	ApplyHorizontal (IntRect &rect, const IntRect &targetRect) const
	Positions rect on one axis against targetRect (the parent, or the anchor target).
void	ApplyVertical (IntRect &rect, const IntRect &targetRect) const
template<class PxFn>
void	ResolveCss (const PxFn &px)
	CSS px to pixels; ElementStorage::Add does it with the style manager's Px.
LayoutOverride &	Centered () &
	Centered in the parent on both axes.
LayoutOverride &&	Centered () &&
LayoutOverride &	ClampScroll (bool v=true) &
	Overrides the style's scroll clamping (false = unclamped / infinite scroll).
LayoutOverride &&	ClampScroll (bool v=true) &&
uint32_t	GetFlexGrow (const LayoutStyle *ls) const
	Resolvers take the element's layout style (may be null) and return the effective value.
uint32_t	GetFlexShrink (const LayoutStyle *ls) const
BreakBehavior	GetBreakBehavior (const LayoutStyle *ls) const
bool	GetBreakBefore (const LayoutStyle *ls) const
bool	GetBreakAfter (const LayoutStyle *ls) const
bool	GetKeepWithNext (const LayoutStyle *ls) const
bool	GetClampScroll (const LayoutStyle *ls) const
IconSide	GetIconSide (const LayoutStyle *ls) const
uint16_t	GetIconTextGap (const LayoutStyle *ls) const
GridProperties	GetGridItem (const LayoutStyle *layoutStyle) const
	Style values with non-Default overrides applied.

Static Public Member Functions
static LayoutOverride	Auto ()
	No overrides: everything comes from the style.
static LayoutOverride	FixedSize (CssPx w, CssPx h)
	Sizes in CSS px (scaled by the UI scale) or in Pixels (as they are); see gui_units.h.
static LayoutOverride	FixedSize (Pixels w, Pixels h)
static LayoutOverride	FixedSize (int2 pixels)
static LayoutOverride	FixedWidth (CssPx w)
static LayoutOverride	FixedWidth (Pixels w)
static LayoutOverride	FixedHeight (CssPx h)
static LayoutOverride	FixedHeight (Pixels h)

Public Attributes
SizeConstraintAxis	width {}
SizeConstraintAxis	height {}
	Size constraints; set with the size builders.
PositionConstraintAxis	x {}
PositionConstraintAxis	y {}
	Position constraints; set with the position builders.
FlexOverride	flex {}
	flex-grow / flex-shrink overrides
struct	grid
int16_t	iconTextGapOverride = -1
	Icon layout overrides (-1 = use style).
IconSide	iconSideOverride: 3 = IconSide::None
	None = use style.
uint8_t	breakBehaviorOverride: 3 = 0
	0 = use style, otherwise BreakBehavior + 1
TriState	clampScroll: 2 = TriState::Default
	Override of the style's scroll clamping.
bool	outOfFlow = false
	Set by ElementStorage::Add for display:none / visibility:collapsed; such elements take no space in the parent's flex/grid.
LayoutOverride &	Size (CssPx w, CssPx h) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	Size (CssPx w, CssPx h) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	Size (Pixels w, Pixels h) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	Size (Pixels w, Pixels h) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	Size (int2 pixels) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	Size (int2 pixels) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	Width (CssPx w) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	Width (CssPx w) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	Width (Pixels w) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	Width (Pixels w) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	Height (CssPx h) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	Height (CssPx h) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	Height (Pixels h) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	Height (Pixels h) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	MinWidth (CssPx w) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	MinWidth (CssPx w) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	MinWidth (Pixels w) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	MinWidth (Pixels w) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	MinHeight (CssPx h) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	MinHeight (CssPx h) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	MinHeight (Pixels h) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	MinHeight (Pixels h) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	MaxWidth (CssPx w) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	MaxWidth (CssPx w) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	MaxWidth (Pixels w) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	MaxWidth (Pixels w) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	MaxHeight (CssPx h) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	MaxHeight (CssPx h) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	MaxHeight (Pixels h) &
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &&	MaxHeight (Pixels h) &&
	Size, min and max size, in CSS px (scaled by the UI scale) or Pixels (as they are).
LayoutOverride &	Position (int2 p) &
	Position builders, in pixels (near = left/top, far = right/bottom).
LayoutOverride &&	Position (int2 p) &&
	Position builders, in pixels (near = left/top, far = right/bottom).
LayoutOverride &	Position (int32_t px, int32_t py) &
	Position builders, in pixels (near = left/top, far = right/bottom).
LayoutOverride &&	Position (int32_t px, int32_t py) &&
	Position builders, in pixels (near = left/top, far = right/bottom).
LayoutOverride &	Position (int32_t t, int32_t r, int32_t b, int32_t l) &
	Position builders, in pixels (near = left/top, far = right/bottom).
LayoutOverride &&	Position (int32_t t, int32_t r, int32_t b, int32_t l) &&
	Position builders, in pixels (near = left/top, far = right/bottom).
LayoutOverride &	Position (const EdgeInset &i) &
	Position builders, in pixels (near = left/top, far = right/bottom).
LayoutOverride &&	Position (const EdgeInset &i) &&
	Position builders, in pixels (near = left/top, far = right/bottom).
LayoutOverride &	Relative () &
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &&	Relative () &&
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &	Relative (const EdgeInset &i) &
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &&	Relative (const EdgeInset &i) &&
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &	Relative (int32_t t, int32_t r, int32_t b, int32_t l) &
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &&	Relative (int32_t t, int32_t r, int32_t b, int32_t l) &&
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &	Relative (int32_t px, int32_t py) &
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &&	Relative (int32_t px, int32_t py) &&
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &	Relative (const int2 &p) &
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &&	Relative (const int2 &p) &&
	In flow, shifted by the given offsets from the laid-out position.
LayoutOverride &	Absolute (const EdgeInset &i) &
	Out of flow, inset from the parent's edges; scrolls with the parent's content.
LayoutOverride &&	Absolute (const EdgeInset &i) &&
	Out of flow, inset from the parent's edges; scrolls with the parent's content.
LayoutOverride &	Absolute (int32_t t, int32_t r, int32_t b, int32_t l) &
	Out of flow, inset from the parent's edges; scrolls with the parent's content.
LayoutOverride &&	Absolute (int32_t t, int32_t r, int32_t b, int32_t l) &&
	Out of flow, inset from the parent's edges; scrolls with the parent's content.
LayoutOverride &	Absolute (int32_t px, int32_t py) &
	Out of flow, inset from the parent's edges; scrolls with the parent's content.
LayoutOverride &&	Absolute (int32_t px, int32_t py) &&
	Out of flow, inset from the parent's edges; scrolls with the parent's content.
LayoutOverride &	Absolute (const int2 &p) &
	Out of flow, inset from the parent's edges; scrolls with the parent's content.
LayoutOverride &&	Absolute (const int2 &p) &&
	Out of flow, inset from the parent's edges; scrolls with the parent's content.
LayoutOverride &	Anchored (ID target, AnchorPlacement pl, const int2 &off={}, AutoFlipMode af=AutoFlipMode::None) &
	Placed next to / inside the target element per the placement, plus an offset in pixels.
LayoutOverride &&	Anchored (ID target, AnchorPlacement pl, const int2 &off={}, AutoFlipMode af=AutoFlipMode::None) &&
	Placed next to / inside the target element per the placement, plus an offset in pixels.
LayoutOverride &	Anchored (ID target, AnchorPlacement pl, int32_t ox, int32_t oy, AutoFlipMode af=AutoFlipMode::None) &
	Placed next to / inside the target element per the placement, plus an offset in pixels.
LayoutOverride &&	Anchored (ID target, AnchorPlacement pl, int32_t ox, int32_t oy, AutoFlipMode af=AutoFlipMode::None) &&
	Placed next to / inside the target element per the placement, plus an offset in pixels.
LayoutOverride &	Anchored (ID target, AnchorPlacementAxis px, int32_t ox, AnchorPlacementAxis py, int32_t oy, AutoFlipMode af=AutoFlipMode::None) &
	Placed next to / inside the target element per the placement, plus an offset in pixels.
LayoutOverride &&	Anchored (ID target, AnchorPlacementAxis px, int32_t ox, AnchorPlacementAxis py, int32_t oy, AutoFlipMode af=AutoFlipMode::None) &&
	Placed next to / inside the target element per the placement, plus an offset in pixels.
LayoutOverride &	Overhang (const int2 &o) &
	After Anchored: how far past the work area the element may reach on each axis, for see-through room around what it shows (a shadow): flips and clamps keep only the rest on the screen.
LayoutOverride &&	Overhang (const int2 &o) &&
	Placed next to / inside the target element per the placement, plus an offset in pixels.
LayoutOverride &	PositionX (PositionConstraintAxis ax) &
	Sets one axis's constraint, or only its PositionType.
LayoutOverride &&	PositionX (PositionConstraintAxis ax) &&
	Sets one axis's constraint, or only its PositionType.
LayoutOverride &	PositionY (PositionConstraintAxis ay) &
	Sets one axis's constraint, or only its PositionType.
LayoutOverride &&	PositionY (PositionConstraintAxis ay) &&
	Sets one axis's constraint, or only its PositionType.
LayoutOverride &	WithTypeX (PositionType t) &
	Sets one axis's constraint, or only its PositionType.
LayoutOverride &&	WithTypeX (PositionType t) &&
	Sets one axis's constraint, or only its PositionType.
LayoutOverride &	WithTypeY (PositionType t) &
	Sets one axis's constraint, or only its PositionType.
LayoutOverride &&	WithTypeY (PositionType t) &&
	Sets one axis's constraint, or only its PositionType.
LayoutOverride &	StickyX (int16_t threshold=0) &
	See PositionConstraintAxis::Sticky.
LayoutOverride &&	StickyX (int16_t threshold=0) &&
	See PositionConstraintAxis::Sticky.
LayoutOverride &	StickyY (int16_t threshold=0) &
	See PositionConstraintAxis::Sticky.
LayoutOverride &&	StickyY (int16_t threshold=0) &&
	See PositionConstraintAxis::Sticky.
LayoutOverride &	Sticky (int16_t thresholdX=0, int16_t thresholdY=0) &
	See PositionConstraintAxis::Sticky.
LayoutOverride &&	Sticky (int16_t thresholdX=0, int16_t thresholdY=0) &&
	See PositionConstraintAxis::Sticky.
LayoutOverride &	BreakAfter (bool v=true) &
	Forces a line break after / before this element, or keeps it on the same line as the next one.
LayoutOverride &&	BreakAfter (bool v=true) &&
	Forces a line break after / before this element, or keeps it on the same line as the next one.
LayoutOverride &	BreakBefore (bool v=true) &
	Forces a line break after / before this element, or keeps it on the same line as the next one.
LayoutOverride &&	BreakBefore (bool v=true) &&
	Forces a line break after / before this element, or keeps it on the same line as the next one.
LayoutOverride &	KeepWithNext (bool v=true) &
	Forces a line break after / before this element, or keeps it on the same line as the next one.
LayoutOverride &&	KeepWithNext (bool v=true) &&
	Forces a line break after / before this element, or keeps it on the same line as the next one.
LayoutOverride &	FlexGrow (int16_t v) &
	Overrides the style's flex-grow / flex-shrink.
LayoutOverride &&	FlexGrow (int16_t v) &&
	Overrides the style's flex-grow / flex-shrink.
LayoutOverride &	FlexShrink (int16_t v) &
	Overrides the style's flex-grow / flex-shrink.
LayoutOverride &&	FlexShrink (int16_t v) &&
	Overrides the style's flex-grow / flex-shrink.
LayoutOverride &	NoGrow () &
	Shorthands for FlexGrow(0) / FlexShrink(0).
LayoutOverride &&	NoGrow () &&
	Shorthands for FlexGrow(0) / FlexShrink(0).
LayoutOverride &	NoShrink () &
	Shorthands for FlexGrow(0) / FlexShrink(0).
LayoutOverride &&	NoShrink () &&
	Shorthands for FlexGrow(0) / FlexShrink(0).
LayoutOverride &	SetIconSide (IconSide s) &
	Overrides the style's icon side / icon-text gap (pixels).
LayoutOverride &&	SetIconSide (IconSide s) &&
	Overrides the style's icon side / icon-text gap (pixels).
LayoutOverride &	IconTextGap (int16_t gap) &
	Overrides the style's icon side / icon-text gap (pixels).
LayoutOverride &&	IconTextGap (int16_t gap) &&
	Overrides the style's icon side / icon-text gap (pixels).
LayoutOverride &	ColumnTrack (GridTrack t) &
	Overrides the style's column / row track size.
LayoutOverride &&	ColumnTrack (GridTrack t) &&
	Overrides the style's column / row track size.
LayoutOverride &	RowTrack (GridTrack t) &
	Overrides the style's column / row track size.
LayoutOverride &&	RowTrack (GridTrack t) &&
	Overrides the style's column / row track size.
LayoutOverride &	GridColumn (int16_t start, int16_t span=1) &
	Explicit grid placement: start cell and span.
LayoutOverride &&	GridColumn (int16_t start, int16_t span=1) &&
	Explicit grid placement: start cell and span.
LayoutOverride &	GridRow (int16_t start, int16_t span=1) &
	Explicit grid placement: start cell and span.
LayoutOverride &&	GridRow (int16_t start, int16_t span=1) &&
	Explicit grid placement: start cell and span.

Detailed Description

Per-element overrides of style layout properties.

Sizes are CSS px; the builders chain:

BeginWindow(windowID, "Hello", LayoutOverride{}.Size(360, 160));
BeginVertical(LayoutOverride{}.FlexGrow(1));                  // fill the free space
Button("Object", onClick, LayoutOverride{}.NoGrow());         // keep its natural width
BeginWindow(windowID, "Docking", theme.mainWindowStyleRef,
            LayoutOverride::FixedSize(900, 600).Centered());

Examples: controls/controls.cpp, custom_theme/custom_theme.cpp, docking/docking.cpp, and hello_world/hello_world.cpp.

Constructor & Destructor Documentation

◆ LayoutOverride()

tachyon::LayoutOverride::LayoutOverride ( )

default

Member Function Documentation

◆ Auto()

LayoutOverride tachyon::LayoutOverride::Auto ( )

inlinestatic

No overrides: everything comes from the style.

Examples: docking/docking.cpp.

◆ FixedSize() [1/3]

LayoutOverride tachyon::LayoutOverride::FixedSize	(	CssPx	w,
		CssPx	h )

inlinestatic

Sizes in CSS px (scaled by the UI scale) or in Pixels (as they are); see gui_units.h.

Examples: docking/docking.cpp.

◆ FixedSize() [2/3]

LayoutOverride tachyon::LayoutOverride::FixedSize	(	Pixels	w,
		Pixels	h )

inlinestatic

◆ FixedSize() [3/3]

LayoutOverride tachyon::LayoutOverride::FixedSize ( int2 pixels )

inlinestatic

◆ FixedWidth() [1/2]

LayoutOverride tachyon::LayoutOverride::FixedWidth ( CssPx w )

inlinestatic

◆ FixedWidth() [2/2]

LayoutOverride tachyon::LayoutOverride::FixedWidth ( Pixels w )

inlinestatic

◆ FixedHeight() [1/2]

LayoutOverride tachyon::LayoutOverride::FixedHeight ( CssPx h )

inlinestatic

◆ FixedHeight() [2/2]

LayoutOverride tachyon::LayoutOverride::FixedHeight ( Pixels h )

inlinestatic

◆ HasFixedWidth()

bool tachyon::LayoutOverride::HasFixedWidth ( ) const

inlineconstexpr

Whether an explicit width / height is set; axis 0 = width, 1 = height.

◆ HasFixedHeight()

bool tachyon::LayoutOverride::HasFixedHeight ( ) const

inlineconstexpr

◆ HasFixedAxis()

bool tachyon::LayoutOverride::HasFixedAxis ( int axis ) const

inlineconstexpr

◆ IsFullyConstrained()

bool tachyon::LayoutOverride::IsFullyConstrained ( ) const

inlineconstexpr

Both width and height are explicit.

◆ ClampWidth()

int32_t tachyon::LayoutOverride::ClampWidth ( int32_t w ) const

inlineconstexpr

Clamps a size to the min / max constraints, ignoring the explicit size.

◆ ClampHeight()

int32_t tachyon::LayoutOverride::ClampHeight ( int32_t h ) const

inlineconstexpr

◆ Size() [1/7]

int2 tachyon::LayoutOverride::Size ( ) const

inline

The explicit sizes; kAuto on axes without one.

Examples: controls/controls.cpp, custom_theme/custom_theme.cpp, and hello_world/hello_world.cpp.

◆ ApplySize()

int2 tachyon::LayoutOverride::ApplySize ( int2 s ) const

inline

The explicit size where set, else s clamped to min / max.

◆ ApplyWidth()

int32_t tachyon::LayoutOverride::ApplyWidth ( int32_t s ) const

inline

◆ ApplyHeight()

int32_t tachyon::LayoutOverride::ApplyHeight ( int32_t s ) const

inline

◆ IsInFlowX()

bool tachyon::LayoutOverride::IsInFlowX ( ) const

inlineconstexpr

True when the element takes part in the parent's flow on that axis (see PositionConstraintAxis::IsInFlow).

◆ IsInFlowY()

bool tachyon::LayoutOverride::IsInFlowY ( ) const

inlineconstexpr

◆ IsInFlow()

bool tachyon::LayoutOverride::IsInFlow ( ) const

inlineconstexpr

◆ IsInFlowAxis()

bool tachyon::LayoutOverride::IsInFlowAxis ( int axis ) const

inlineconstexpr

◆ ApplyHorizontal()

void tachyon::LayoutOverride::ApplyHorizontal	(	IntRect &	rect,
		const IntRect &	targetRect ) const

inline

Positions rect on one axis against targetRect (the parent, or the anchor target).

◆ ApplyVertical()

void tachyon::LayoutOverride::ApplyVertical	(	IntRect &	rect,
		const IntRect &	targetRect ) const

inline