struct Layout in Tinman.AddOns.GUI

struct

Layout

Public / Constants

Default

Default layout settings.

public static readonly field	Default
type	Layout

Remarks:

The following default layout settings are defined:

• LayoutMargin: 1
• LayoutInsets: 2

None

Empty layout settings.

public static readonly field	None
type	Layout

Public / Attributes

LayoutAlign

The cell alignment.

public readonly field	LayoutAlign
type	Anchor

LayoutFill

The cell fill mode.

public readonly field	LayoutFill
type	Axis

LayoutGrid

The cell bounds.

public readonly field	LayoutGrid
type	Box2I

LayoutGrow

The grow mode.

public readonly field	LayoutGrow
type	Axis

LayoutInsets

The container insets.

public readonly field	LayoutInsets
type	Edging

LayoutMargin

The component margin.

public readonly field	LayoutMargin
type	Edging

LayoutShrink

The shrink mode.

public readonly field	LayoutShrink
type	Axis

LayoutSize

The requested pixel size.

public readonly field	LayoutSize
type	Vec2I

Public / Constructors

At

Returns a new Layout value that places the component at the given grid position.

[Pure]
public static method	At (Box2I grid)
type	Layout
params	grid		The grid position.
returns			The Layout value.

Remarks:

The returned layout value is based on None and only specifies the layout grid bounds.

---

Returns a new Layout value that places the component at the given grid position.

[Pure]
public static method	At (int32 x, int32 y, int32 width = 1, int32 height = 1)
type	Layout
params	x		The grid X-position.
	y		The grid Y-position.
	width		The grid span width, in cells. Defaults to 1.
	height		The grid span height, in cells. Defaults to 1.
returns			The Layout value.

Remarks:

The returned layout value is based on None and only specifies the layout grid bounds.

Public / Methods

Align

Specifies the layout grid cell align of the component.

[Pure]
public method	Align (Anchor align)
type	Layout
params	align		The alignment of the component in its layout grid cell.
returns			The resulting Layout value.

Fill

Specifies how the component shall fill its layout grid cell.

[Pure]
public method	Fill (Axis fill)
type	Layout
params	fill		The fill axes.
returns			The resulting Layout value.

Grow

Specifies whether the layout grid cell can grow in order to compensate for additional missing space.

[Pure]
public method	Grow (Axis grow)
type	Layout
params	grow		The grow axes.
returns			The resulting Layout value.

Height

Specifies the requested height of the component.

[Pure]
public method	Height (int32 height)
type	Layout
params	height		The requested height, in pixels.
returns			The resulting Layout value.

Insets

Specifies the insets of the container.

[Pure]
public method	Insets (int32 insets)
type	Layout
params	insets		The container insets.
returns			The resulting Layout value.

---

Specifies the insets of the container.

[Pure]
public method	Insets (Edging insets)
type	Layout
params	insets		The container insets.
returns			The resulting Layout value.

---

Specifies the insets of the container.

[Pure]
public method	Insets (int32 insetTop, int32 insetLeft, int32 insetBottom, int32 insetRight)
type	Layout
params	insetTop		The top insets.
	insetLeft		The left insets.
	insetBottom		The bottom insets.
	insetRight		The right insets.
returns			The resulting Layout value.

InsetsBottom

Specifies the insets of the container.

[Pure]
public method	InsetsBottom (int32 insetBottom)
type	Layout
params	insetBottom		The bottom insets.
returns			The resulting Layout value.

InsetsLeft

Specifies the insets of the container.

[Pure]
public method	InsetsLeft (int32 insetLeft)
type	Layout
params	insetLeft		The left insets.
returns			The resulting Layout value.

InsetsRight

Specifies the insets of the container.

[Pure]
public method	InsetsRight (int32 insetRight)
type	Layout
params	insetRight		The right insets.
returns			The resulting Layout value.

InsetsTop

Specifies the insets of the container.

[Pure]
public method	InsetsTop (int32 insetTop)
type	Layout
params	insetTop		The top insets.
returns			The resulting Layout value.

Margin

Specifies the margin of the component.

[Pure]
public method	Margin (int32 margin)
type	Layout
params	margin		The component margin.
returns			The resulting Layout value.

---

Specifies the margin of the component.

[Pure]
public method	Margin (Edging margin)
type	Layout
params	margin		The component margin.
returns			The resulting Layout value.

---

Specifies the margin of the component.

[Pure]
public method	Margin (int32 marginTop, int32 marginLeft, int32 marginBottom, int32 marginRight)
type	Layout
params	marginTop		The top margin.
	marginLeft		The left margin.
	marginBottom		The bottom margin.
	marginRight		The right margin.
returns			The resulting Layout value.

MarginBottom

Specifies the margin of the component.

[Pure]
public method	MarginBottom (int32 marginBottom)
type	Layout
params	marginBottom		The bottom margin.
returns			The resulting Layout value.

MarginLeft

Specifies the margin of the component.

[Pure]
public method	MarginLeft (int32 marginLeft)
type	Layout
params	marginLeft		The left margin.
returns			The resulting Layout value.

MarginRight

Specifies the margin of the component.

[Pure]
public method	MarginRight (int32 marginRight)
type	Layout
params	marginRight		The right margin.
returns			The resulting Layout value.

MarginTop

Specifies the margin of the component.

[Pure]
public method	MarginTop (int32 marginTop)
type	Layout
params	marginTop		The top margin.
returns			The resulting Layout value.

SetDefault

Checks which layout properties are specified by other but not by this layout and copies them to this layout.

[Pure]
public method	SetDefault (Layout other)
type	Layout
params	other		The other layout values.
returns			The resulting Layout value.

Shrink

Specifies whether the layout grid cell can shrink in order to compensate for missing space.

[Pure]
public method	Shrink (Axis shrink)
type	Layout
params	shrink		The shrink axes.
returns			The resulting Layout value.

Size

Specifies the requested size of the component.

[Pure]
public method	Size (Vec2I size)
type	Layout
params	size		The requested size, in pixels.
returns			The resulting Layout value.

---

Specifies the requested size of the component.

[Pure]
public method	Size (int32 width, int32 height)
type	Layout
params	width		The requested width, in pixels.
	height		The requested height, in pixels.
returns			The resulting Layout value.

Width

Specifies the requested width of the component.

[Pure]
public method	Width (int32 width)
type	Layout
params	width		The requested width, in pixels.
returns			The resulting Layout value.