Rocket::Controls::ElementTabSet Class Reference

#include <ElementTabSet.h>

Inheritance diagram for Rocket::Controls::ElementTabSet:

Collaboration diagram for Rocket::Controls::ElementTabSet:


Public Member Functions
	ElementTabSet (const Rocket::Core::String &tag)
void	SetTab (int tab_index, const Rocket::Core::String &rml)
void	SetPanel (int tab_index, const Rocket::Core::String &rml)
void	SetTab (int tab_index, Core::Element *element)
void	SetPanel (int tab_index, Core::Element *element)
void	RemoveTab (int tab_index)
int	GetNumTabs ()
void	SetActiveTab (int tab_index)
int	GetActiveTab () const
void	ProcessEvent (Core::Event &event)
	Process the incoming event.
Protected Member Functions
virtual void	OnChildAdd (Core::Element *child)
	Called when a child node has been added somewhere in the hierarchy.
virtual void	OnChildRemove (Core::Element *child)
	Called when a child node has been removed somewhere in the hierarchy.

Detailed Description

A tabulated set of panels.

void Rocket::Controls::ElementTabSet::SetTab	(	int	tab_index,
		const Rocket::Core::String &	rml
	)

Sets the specifed tab index's tab title RML.

Parameters:

`[in]`	tab_index	The tab index to set. If it doesn't already exist, it will be created.
`[in]`	rml	The RML to set on the tab title.

void Rocket::Controls::ElementTabSet::SetPanel	(	int	tab_index,
		const Rocket::Core::String &	rml
	)

Sets the specifed tab index's tab panel RML.

Parameters:

`[in]`	tab_index	The tab index to set. If it doesn't already exist, it will be created.
`[in]`	rml	The RML to set on the tab panel.

void Rocket::Controls::ElementTabSet::SetTab	(	int	tab_index,
		Core::Element *	element
	)

Set the specifed tab index's title element.

Parameters:

`[in]`	tab_index	The tab index to set. If it doesn't already exist, it will be created.
`[in]`	element	The root of the element tree to set as the tab title.

void Rocket::Controls::ElementTabSet::SetPanel	(	int	tab_index,
		Core::Element *	element
	)

Set the specified tab index's body element.

Parameters:

`[in]`	tab_index	The tab index to set. If it doesn't already exist, it will be created.
`[in]`	element	The root of the element tree to set as the window.

void Rocket::Controls::ElementTabSet::RemoveTab ( int tab_index )

Remove one of the tab set's panels and its corresponding tab.

Parameters:

[in] tab_index The tab index to remove. If no tab matches this index, nothing will be removed.

int Rocket::Controls::ElementTabSet::GetNumTabs ( )

Retrieve the number of tabs in the tabset.

void Rocket::Controls::ElementTabSet::SetActiveTab ( int tab_index )

Sets the currently active (visible) tab index.

Parameters:

[in] tab_index Index of the tab to display.

int Rocket::Controls::ElementTabSet::GetActiveTab ( ) const

Get the current active tab index.

The documentation for this class was generated from the following files: