Unigine::WidgetGridBox Class

WidgetGridBox Class

Members

---

static WidgetGridBoxPtr create ( const Ptr<Gui> & gui, int num = 2, int x = 0, int y = 0 ) #

Constructor. Creates a grid box with given parameters.

Arguments

• const Ptr<Gui> & gui - GUI, to which the new box will belong.
• int num - Number of columns in the grid. This is an optional parameter.
• int x - Horizontal space between the widgets in the box and between them and the box border. This is an optional parameter.
• int y - Vertical space between the widgets in the box and between them and the box border. This is an optional parameter.

Ptr<WidgetGridBox> cast ( const Ptr<Widget> & widget ) #

Casts a WidgetGridBox out of the Widget instance.

Arguments

• const Ptr<Widget> & widget - Pointer to Widget.

Return value

Pointer to WidgetGridBox.

void setColumnRatio ( int num, int ratio ) #

Sets the width-to-height ratio of the specified column.

Arguments

• int num - Column number in range from 0 to the total number of columns.
• int ratio - Width-to-height ratio.

int getColumnRatio ( int num ) #

Returns the current width-to-height ratio of the specified column.

Arguments

• int num - Column number in range from 0 to the total number of columns.

Return value

Width-to-height ratio.

void setNumColumns ( int columns ) #

Sets a number of columns in the grid.

Arguments

• int columns - Number of columns.

int getNumColumns ( ) #

Returns the number of columns in the grid.

Return value

Number of columns.

int type ( ) #

WidgetGridBox type.

Return value

WidgetGridBox type identifier.