Layout

Description

struct Tinman.Engine.GUI.Layout

Layout descriptor for GUI components in a LayoutGrid.

Public / Constants

Default

public static readonly attribute Default → (Layout)

Default layout settings.

The following default layout settings are defined:

LayoutMargin: 1
LayoutInsets: 2

None

public static readonly attribute None → (Layout)

Empty layout settings.

Public / Constructors

At

_2 overloads

[Pure]
public static method At¹ → (1)

grid ⁱⁿ : Box2I: The grid position.
returns → Layout: The Layout value.

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

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

[Pure]
public static method At² → (4)

x ⁱⁿ : int32: The grid X-position.
y ⁱⁿ : int32: The grid Y-position.
width ^opt : int32 = 1: The grid span width, in cells.
height ^opt : int32 = 1: The grid span height, in cells.
returns → Layout: The Layout value.

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

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

Public / Methods

Align

[Pure]
public method Align → (1)

align ⁱⁿ : Anchor: The alignment of the component in its layout grid cell.
returns → Layout: The resulting Layout value.

Specifies the layout grid cell align of the component.

Compact

[Pure]
public method Compact → ()

returns → Layout: The resulting Layout value.

Specifies zero margin and insets.

Fill

[Pure]
public method Fill → (1)

fill ⁱⁿ : Axis: The fill axes.
returns → Layout: The resulting Layout value.

Specifies how the component shall fill its layout grid cell.

Grow

[Pure]
public method Grow → (1)

grow ⁱⁿ : Axis: The grow axes.
returns → Layout: The resulting Layout value.

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

Insets

_3 overloads

[Pure]
public method Insets¹ → (1)

insets ⁱⁿ : int32: The container insets.
returns → Layout: The resulting Layout value.

Specifies the insets of the container.

[Pure]
public method Insets² → (1)

insets ⁱⁿ : Edging: The container insets.
returns → Layout: The resulting Layout value.

Specifies the insets of the container.

[Pure]
public method Insets³ → (4)

insetTop ⁱⁿ : int32: The top insets.
insetLeft ⁱⁿ : int32: The left insets.
insetBottom ⁱⁿ : int32: The bottom insets.
insetRight ⁱⁿ : int32: The right insets.
returns → Layout: The resulting Layout value.

Specifies the insets of the container.

InsetsBottom

[Pure]
public method InsetsBottom → (1)

insetBottom ⁱⁿ : int32: The bottom insets.
returns → Layout: The resulting Layout value.

Specifies the insets of the container.

InsetsLeft

[Pure]
public method InsetsLeft → (1)

insetLeft ⁱⁿ : int32: The left insets.
returns → Layout: The resulting Layout value.

Specifies the insets of the container.

InsetsRight

[Pure]
public method InsetsRight → (1)

insetRight ⁱⁿ : int32: The right insets.
returns → Layout: The resulting Layout value.

Specifies the insets of the container.

InsetsTop

[Pure]
public method InsetsTop → (1)

insetTop ⁱⁿ : int32: The top insets.
returns → Layout: The resulting Layout value.

Specifies the insets of the container.

Limit

_2 overloads

[Pure]
public method Limit¹ → (1)

size ⁱⁿ : Vec2I: The maximum size, in pixels.
returns → Layout: The resulting Layout value.

Specifies the maximum size of the component.

[Pure]
public method Limit² → (2)

width ⁱⁿ : int32: The maximum width, in pixels.
height ⁱⁿ : int32: The maximum height, in pixels.
returns → Layout: The resulting Layout value.

Specifies the maximum size of the component.

Margin

_3 overloads

[Pure]
public method Margin¹ → (1)

margin ⁱⁿ : int32: The component margin.
returns → Layout: The resulting Layout value.

Specifies the margin of the component.

[Pure]
public method Margin² → (1)

margin ⁱⁿ : Edging: The component margin.
returns → Layout: The resulting Layout value.

Specifies the margin of the component.

[Pure]
public method Margin³ → (4)

marginTop ⁱⁿ : int32: The top margin.
marginLeft ⁱⁿ : int32: The left margin.
marginBottom ⁱⁿ : int32: The bottom margin.
marginRight ⁱⁿ : int32: The right margin.
returns → Layout: The resulting Layout value.

Specifies the margin of the component.

MarginBottom

[Pure]
public method MarginBottom → (1)

marginBottom ⁱⁿ : int32: The bottom margin.
returns → Layout: The resulting Layout value.

Specifies the margin of the component.

MarginLeft

[Pure]
public method MarginLeft → (1)

marginLeft ⁱⁿ : int32: The left margin.
returns → Layout: The resulting Layout value.

Specifies the margin of the component.

MarginRight

[Pure]
public method MarginRight → (1)

marginRight ⁱⁿ : int32: The right margin.
returns → Layout: The resulting Layout value.

Specifies the margin of the component.

MarginTop

[Pure]
public method MarginTop → (1)

marginTop ⁱⁿ : int32: The top margin.
returns → Layout: The resulting Layout value.

Specifies the margin of the component.

SetDefault

[Pure]
public method SetDefault → (1)

other ⁱⁿ : Layout: The other layout values.
returns → Layout: The resulting Layout value.

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

Shrink

[Pure]
public method Shrink → (1)

shrink ⁱⁿ : Axis: The shrink axes.
returns → Layout: The resulting Layout value.

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

Size

_2 overloads

[Pure]
public method Size¹ → (1)

size ⁱⁿ : Vec2I: The minimum size, in pixels.
returns → Layout: The resulting Layout value.

Specifies the minimum size of the component.

[Pure]
public method Size² → (2)

width ⁱⁿ : int32: The minimum width, in pixels.
height ⁱⁿ : int32: The minimum height, in pixels.
returns → Layout: The resulting Layout value.

Specifies the minimum size of the component.

Public / Attributes

LayoutAlign

public readonly attribute LayoutAlign → (Anchor)

The cell alignment.

See also: Component.LayoutAlign

LayoutFill

public readonly attribute LayoutFill → (Axis)

The cell fill mode.

See also: Component.LayoutFill

LayoutGrid

public readonly attribute LayoutGrid → (Box2I)

The cell bounds.

See also: Component.LayoutGrid

LayoutGrow

public readonly attribute LayoutGrow → (Axis)

The grow mode.

See also: Component.LayoutGrow

LayoutInsets

public readonly attribute LayoutInsets → (Edging)

The container insets.

See also: Container.LayoutInsets

LayoutLimit

public readonly attribute LayoutLimit → (Vec2I)

The maximum pixel size.

See also: Component.LayoutLimit

LayoutMargin

public readonly attribute LayoutMargin → (Edging)

The component margin.

See also: Component.LayoutMargin

LayoutShrink

public readonly attribute LayoutShrink → (Axis)

The shrink mode.

See also: Component.LayoutShrink

LayoutSize

public readonly attribute LayoutSize → (Vec2I)

The minimum pixel size.

See also: Component.LayoutSize