DigitalSpaces::DICEGUITabControl Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
unsigned long	getTabCount ()
	Return number of tabs.
CEGUITabPanePosition	getTabPanePosition ()
	Return the positioning of the tab pane.
void	setTabPanePosition (CEGUITabPanePosition pos)
	Change the positioning of the tab button pane.
void	setSelectedTab (const char *name)
	Set the selected tab by the name of the root window within it. Also ensures that the tab is made visible (tab pane is scrolled if required). Exceptions: InvalidRequestException  thrown if there's no tab named name.
void	setSelectedTab (unsigned int ID)
	Set the selected tab by the ID of the root window within it. Also ensures that the tab is made visible (tab pane is scrolled if required). Exceptions: InvalidRequestException  thrown if index is out of range.
void	setSelectedTabAtIndex (unsigned long index)
	Set the selected tab by the index position in the tab control. Also ensures that the tab is made visible (tab pane is scrolled if required). Exceptions: InvalidRequestException  thrown if index is out of range.
void	makeTabVisible (const char *name)
	Ensure that the tab by the name of the root window within it is visible. Exceptions: InvalidRequestException  thrown if there's no tab named name.
void	makeTabVisible (unsigned int ID)
	Ensure that the tab by the ID of the root window within it is visible. Exceptions: InvalidRequestException  thrown if index is out of range.
void	makeTabVisibleAtIndex (unsigned long index)
	Ensure that the tab by the index position in the tab control is visible. Exceptions: InvalidRequestException  thrown if index is out of range.
DICEGUIWindow *	getTabContentsAtIndex (unsigned long index)
	Return the Window which is the first child of the tab at index position index.
DICEGUIWindow *	getTabContents (const char *name)
	Return the Window which is the tab content with the given name.
DICEGUIWindow *	getTabContents (unsigned int ID)
	Return the Window which is the tab content with the given ID.
bool	isTabContentsSelected (DICEGUIWindow *wnd)
	Return whether the tab contents window is currently selected.
unsigned long	getSelectedTabIndex ()
	Return the index of the currently selected tab.
void	getTabHeight (out_Pairf *height)
	Return the height of the tabs.
void	getTabTextPadding (out_Pairf *padding)
	Return the amount of padding to add either side of the text in the tab.
void	initialiseComponents ()
	Initialise the Window based object ready for use.
void	setTabHeight (in_Pairf *height)
	Set the height of the tabs.
void	setTabTextPadding (in_Pairf *padding)
	Set the amount of padding to add either side of the text in the tab.
void	addTab (DICEGUIWindow *wnd)
	Add a new tab to the tab control.
void	removeTab (const char *name)
	Remove the named tab from the tab control.
void	removeTab (unsigned int ID)
	Remove the tab with the given ID from the tab control.

---

Member Function Documentation

unsigned long DigitalSpaces::DICEGUITabControl::getTabCount

(

)

Return number of tabs.

Returns:

the number of tabs currently present.

CEGUITabPanePosition DigitalSpaces::DICEGUITabControl::getTabPanePosition

(

)

Return the positioning of the tab pane.

Returns:

The positioning of the tab window within the tab control.

void DigitalSpaces::DICEGUITabControl::setTabPanePosition

(

CEGUITabPanePosition

pos

)

Change the positioning of the tab button pane.

Parameters:

pos

The new positioning of the tab pane

void DigitalSpaces::DICEGUITabControl::setSelectedTab

(

const char *

name

)

Set the selected tab by the name of the root window within it. Also ensures that the tab is made visible (tab pane is scrolled if required).

Exceptions:

InvalidRequestException

thrown if there's no tab named name.

void DigitalSpaces::DICEGUITabControl::setSelectedTab

(

unsigned int

ID

)

Set the selected tab by the ID of the root window within it. Also ensures that the tab is made visible (tab pane is scrolled if required).

Exceptions:

InvalidRequestException

thrown if index is out of range.

void DigitalSpaces::DICEGUITabControl::setSelectedTabAtIndex

(

unsigned long

index

)

Set the selected tab by the index position in the tab control. Also ensures that the tab is made visible (tab pane is scrolled if required).

Exceptions:

InvalidRequestException

thrown if index is out of range.

void DigitalSpaces::DICEGUITabControl::makeTabVisible

(

const char *

name

)

Ensure that the tab by the name of the root window within it is visible.

Exceptions:

InvalidRequestException

thrown if there's no tab named name.

void DigitalSpaces::DICEGUITabControl::makeTabVisible

(

unsigned int

ID

)

Ensure that the tab by the ID of the root window within it is visible.

Exceptions:

InvalidRequestException

thrown if index is out of range.

void DigitalSpaces::DICEGUITabControl::makeTabVisibleAtIndex

(

unsigned long

index

)

Ensure that the tab by the index position in the tab control is visible.

Exceptions:

InvalidRequestException

thrown if index is out of range.

DICEGUIWindow* DigitalSpaces::DICEGUITabControl::getTabContentsAtIndex

(

unsigned long

index

)

Return the Window which is the first child of the tab at index position index.

Parameters:

index

Zero based index of the item to be returned.

Returns:

Pointer to the Window at index position index in the tab control.

Exceptions:

InvalidRequestException

thrown if index is out of range.

DICEGUIWindow* DigitalSpaces::DICEGUITabControl::getTabContents

(

const char *

name

)

Return the Window which is the tab content with the given name.

Parameters:

name

Name of the Window which was attached as a tab content.

Returns:

Pointer to the named Window in the tab control.

Exceptions:

InvalidRequestException

thrown if content is not found.

DICEGUIWindow* DigitalSpaces::DICEGUITabControl::getTabContents

(

unsigned int

ID

)

Return the Window which is the tab content with the given ID.

Parameters:

ID

ID of the Window which was attached as a tab content.

Returns:

Pointer to the Window with the given ID in the tab control.

Exceptions:

InvalidRequestException

thrown if content is not found.

bool DigitalSpaces::DICEGUITabControl::isTabContentsSelected

(

DICEGUIWindow *

wnd

)

Return whether the tab contents window is currently selected.

Parameters:

wnd

The tab contents window to query.

Returns:

true if the tab is currently selected, false otherwise.

Exceptions:

InvalidRequestException

thrown if wnd is not a valid tab contents window.

unsigned long DigitalSpaces::DICEGUITabControl::getSelectedTabIndex

(

)

Return the index of the currently selected tab.

Returns:

index of the currently selected tab.

void DigitalSpaces::DICEGUITabControl::getTabHeight

(

out_Pairf *

height

)

Return the height of the tabs.

void DigitalSpaces::DICEGUITabControl::getTabTextPadding

(

out_Pairf *

padding

)

Return the amount of padding to add either side of the text in the tab.

void DigitalSpaces::DICEGUITabControl::initialiseComponents

(

)

Initialise the Window based object ready for use.

Note:

This must be called for every window created. Normally this is handled automatically by the WindowFactory for each Window type.

Returns:

Nothing

void DigitalSpaces::DICEGUITabControl::setTabHeight

(

in_Pairf *

height

)

Set the height of the tabs.

void DigitalSpaces::DICEGUITabControl::setTabTextPadding

(

in_Pairf *

padding

)

Set the amount of padding to add either side of the text in the tab.

void DigitalSpaces::DICEGUITabControl::addTab

(

DICEGUIWindow *

wnd

)

Add a new tab to the tab control.

The new tab will be added with the same text as the window passed in.

Parameters:

wnd

The Window which will be placed in the content area of this new tab.

void DigitalSpaces::DICEGUITabControl::removeTab

(

const char *

name

)

Remove the named tab from the tab control.

The tab content will be destroyed.

void DigitalSpaces::DICEGUITabControl::removeTab

(

unsigned int

ID

)

Remove the tab with the given ID from the tab control.

The tab content will be destroyed.

---

The documentation for this struct was generated from the following file:

• CEGUIInterfaces/CEGUIInterfaces.h