GuiTabBookCtrl

A container.

Inherit:
GuiContainer

Description

A container.

Example:

// Create

Methods

void GuiTabBookCtrl::addPage(string title)

Add a new tab page to the control.

Parameters:title – Title text for the tab page header.
int GuiTabBookCtrl::getSelectedPage()

Get the index of the currently selected tab page.

Returns:Index of the selected tab page or -1 if no tab page is selected.
void GuiTabBookCtrl::onTabRightClick(String text, int index)

Called when the user right-clicks on a tab page header.

Parameters:
  • text – Text of the page header for the tab that is being selected.
  • index – Index of the tab page being selected.
void GuiTabBookCtrl::onTabSelected(String text, int index)

Called when a new tab page is selected.

Parameters:
  • text – Text of the page header for the tab that is being selected.
  • index – Index of the tab page being selected.
void GuiTabBookCtrl::selectPage(int index)

Set the selected tab page.

Parameters:index – Index of the tab page.

Fields

bool GuiTabBookCtrl::allowReorder

Whether reordering tabs with the mouse is allowed.

int GuiTabBookCtrl::defaultPage

Index of page to select on first onWake() call (-1 to disable).

int GuiTabBookCtrl::frontTabPadding

X offset of first tab page header.

int GuiTabBookCtrl::minTabWidth

Minimum width allocated to a tab page header.

int GuiTabBookCtrl::selectedPage

Index of currently selected page.

int GuiTabBookCtrl::tabHeight

Height of tab page headers.

int GuiTabBookCtrl::tabMargin

Spacing to put between individual tab page headers.

GuiTabPosition GuiTabBookCtrl::tabPosition

Where to place the tab page headers.