A component that allows you to create a table to align a series of Widget. In addition, to be able to compact the information presented on the Grid an open and close mechanism is provided.

See Also

Widget

Static Variables

Name	Description
`widget`	Base Widget where the Grid component is defined.
Declaration Widget *widget
`row_count`	Total amount of row defined for the active Grid.
Declaration unsigned int row_count

Variables

Name	Description
`open_size`	Size in pixels when the Grid is open.
Declaration ivec2 open_size
`close_size`	Size in pixels when the Grid is closed.
Declaration ivec2 close_size
`open`	Boolean value that determine wether or not the Grid is open.
Declaration bool open
`align_all`	Force to align all Widget connected to the Grid even if they are not visible.
Declaration bool align_all
`margin`	Specify the outter edge margin (in pixels) of the Grid on the X and Y axis.
Declaration ivec2 margin
`spacing`	Specify the margin (in pixels) between cells and rows of the Grid.
Declaration ivec2 spacing

Functions

Name	Description
`AddRow`	Append a new row to the active Grid.
Declaration void AddRow( unsigned int widget_per_row ) Parameters `widget_per_row`: Specify how many Widget are expected to be placed on the row; in other words the amount of cells that should be created.
`RemoveRow`	Remove a row from the active Grid using its index as key.
Declaration void RemoveRow( unsigned int row_index ) Parameters `row_index`: Index of the row to remove. Return Value `true` if the row was removed; `false` if the index provided is out of bounds.
`SetRow`	Change the amount of cell for a specific row.
Declaration bool SetRow( unsigned int row_index, unsigned int widget_per_row ) Parameters `row_index`: The row index to update. `widget_per_row`: The new amount of Widget that can be placed on the row. Return Value `true` if the row was updated successfully; `false` if the row index provided is invalid.
`ClearRows`	Clear all rows.
Declaration void ClearRows( void ) Parameters `row_index`: Index of the row to remove. Return Value `true` if the row was removed; `false` if the index provided is out of bounds.
`Align`	Automatically realign all Widget connected to the active Grid cells.
Declaration void Align( void )
`AdjustBounds`	Adjust the Grid Widget bounds based if it is open or not.
Declaration void AdjustBounds( void )

GridType

Available type of Grid that can be used to dictate its behavior.

kNormal: Regular push down, come back up Grid.
kToggle: Push down, stay down, push again, comes back up.
kRadio: Circular radio Grid that works in a group.
kOption: Similar as kToggle but work in a group like kRadio.
kItem: The Grid state is managed by the user.