FlowContainer

Documentation

Overview

A container that arranges its child controls horizontally or vertically and wraps them around at the borders. This is similar to how text in a book wraps around when no more words can fit on a line.

Index

• type Advanced
• type AlignmentMode
• type Any
• type Extension
  • func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
  • func (self *Extension[T]) AsContainer() Container.Instance
  • func (self *Extension[T]) AsControl() Control.Instance
  • func (self *Extension[T]) AsFlowContainer() Instance
  • func (self *Extension[T]) AsNode() Node.Instance
  • func (self *Extension[T]) AsObject() [1]gd.Object
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) Alignment() AlignmentMode
  • func (self Instance) AsCanvasItem() CanvasItem.Instance
  • func (self Instance) AsContainer() Container.Instance
  • func (self Instance) AsControl() Control.Instance
  • func (self Instance) AsFlowContainer() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) GetLineCount() int
  • func (self Instance) ID() ID
  • func (self Instance) LastWrapAlignment() LastWrapAlignmentMode
  • func (self Instance) ReverseFill() bool
  • func (self Instance) SetAlignment(value AlignmentMode)
  • func (self Instance) SetLastWrapAlignment(value LastWrapAlignmentMode)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) SetReverseFill(value bool)
  • func (self Instance) SetVertical(value bool)
  • func (self Instance) Vertical() bool
  • func (self Instance) Virtual(name string) reflect.Value
• type LastWrapAlignmentMode

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type AlignmentMode

type AlignmentMode int //gd:FlowContainer.AlignmentMode

const (
	// The child controls will be arranged at the beginning of the container, i.e. top if orientation is vertical, left if orientation is horizontal (right for RTL layout).
	AlignmentBegin AlignmentMode = 0
	// The child controls will be centered in the container.
	AlignmentCenter AlignmentMode = 1
	// The child controls will be arranged at the end of the container, i.e. bottom if orientation is vertical, right if orientation is horizontal (left for RTL layout).
	AlignmentEnd AlignmentMode = 2
)

type Any

type Any interface {
	gd.IsClass
	AsFlowContainer() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsCanvasItem

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsContainer

func (self *Extension[T]) AsContainer() Container.Instance

func (*Extension[T]) AsControl

func (self *Extension[T]) AsControl() Control.Instance

func (*Extension[T]) AsFlowContainer

func (self *Extension[T]) AsFlowContainer() Instance

func (*Extension[T]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.FlowContainer

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) Alignment

func (self Instance) Alignment() AlignmentMode

The alignment of the container's children (must be one of AlignmentBegin, AlignmentCenter, or AlignmentEnd).

func (Instance) AsCanvasItem

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsContainer

func (self Instance) AsContainer() Container.Instance

func (Instance) AsControl

func (self Instance) AsControl() Control.Instance

func (Instance) AsFlowContainer

func (self Instance) AsFlowContainer() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) GetLineCount

func (self Instance) GetLineCount() int

Returns the current line count.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) LastWrapAlignment

func (self Instance) LastWrapAlignment() LastWrapAlignmentMode

The wrap behavior of the last, partially filled row or column (must be one of LastWrapAlignmentInherit, LastWrapAlignmentBegin, LastWrapAlignmentCenter, or LastWrapAlignmentEnd).

func (Instance) ReverseFill

func (self Instance) ReverseFill() bool

If true, reverses fill direction. Horizontal FlowContainers will fill rows bottom to top, vertical FlowContainers will fill columns right to left.

When using a vertical FlowContainer with a right to left Control.LayoutDirection, columns will fill left to right instead.

func (Instance) SetAlignment

func (self Instance) SetAlignment(value AlignmentMode)

SetAlignment sets the property returned by [GetAlignment].

func (Instance) SetLastWrapAlignment

func (self Instance) SetLastWrapAlignment(value LastWrapAlignmentMode)

SetLastWrapAlignment sets the property returned by [GetLastWrapAlignment].

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetReverseFill

func (self Instance) SetReverseFill(value bool)

SetReverseFill sets the property returned by [IsReverseFill].

func (Instance) SetVertical

func (self Instance) SetVertical(value bool)

SetVertical sets the property returned by [IsVertical].

func (Instance) Vertical

func (self Instance) Vertical() bool

If true, the FlowContainer will arrange its children vertically, rather than horizontally.

Can't be changed when using HFlowContainer and VFlowContainer.

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type LastWrapAlignmentMode

type LastWrapAlignmentMode int //gd:FlowContainer.LastWrapAlignmentMode

const (
	// The last partially filled row or column will wrap aligned to the previous row or column in accordance with [Alignment].
	//
	// [Alignment]: https://pkg.go.dev/graphics.gd/classdb/#Instance.Alignment
	LastWrapAlignmentInherit LastWrapAlignmentMode = 0
	// The last partially filled row or column will wrap aligned to the beginning of the previous row or column.
	LastWrapAlignmentBegin LastWrapAlignmentMode = 1
	// The last partially filled row or column will wrap aligned to the center of the previous row or column.
	LastWrapAlignmentCenter LastWrapAlignmentMode = 2
	// The last partially filled row or column will wrap aligned to the end of the previous row or column.
	LastWrapAlignmentEnd LastWrapAlignmentMode = 3
)