CGUITabControl Class Reference

Tab Control class. More...

#include <GUI.h>

Inheritance diagram for CGUITabControl:

List of all members.

Public Member Functions
virtual void	Initialize ()
virtual int	Create (CGUIElement *pParent, tRect WidgetRect, UINT uiNumTabs=0, CGUIButton *pTabButton=NULL, CCustomFont *pFont=NULL, CTexture *pTexture=NULL, CMaterial *pMaterial=NULL, bool bBorder=false)
virtual void	ProcessMessage (tGUIMessage &Message)
virtual void	Draw ()
virtual int	LoadXML (TiXmlNode *pDataNode, CString strFilename)
virtual int	SaveXML (TiXmlNode *pDataNode, CString strFilename)
virtual bool	PropertyChanging (const void *pvProperty, void *pvNewValue)
virtual void	GetProperties (EPropList &PropList)
virtual void	SetCurSel (int iSelection)
virtual bool	IsOfType (eEntityType eType)

---

Detailed Description

Tab Control class.

A tab control has a list of elements that in turn contain child elements/controls
and each element has an associated button that has to be clicked in order to turn the element
This button goes with name of "TabButton" and element goes with name of "TabElement". Simple.
When button is clicked, it's associated element' children are shown, while all others are hidden.

Definition at line 2070 of file GUI.h.

---

Member Function Documentation

int CGUITabControl::Create (  CGUIElement *  pParent, tRect  WidgetRect, UINT  uiNumTabs = 0, CGUIButton *  pTabButton = NULL, CCustomFont *  pFont = NULL, CTexture *  pTexture = NULL, CMaterial *  pMaterial = NULL, bool  bBorder = false )  [virtual]

Method details: Parameters: pParent  - Pointer to parent widget WidgetRect  - Rectangle for this widget uiNumTabs  - Number of tabs for this tab control pFont  - Pointer to CCustomFont derived font for the widget to draw the text pTexture  - Pointer to texture pMaterial  - Pointer to material bBorder  - does this widget has a border? Returns: 1 if sucessful, 0 if not Definition at line 20 of file GUITabControl.cpp. References CGUIStatic::Create(), CGUIElement::GetChild(), CGUIElement::IsChild(), CDoubleList< CGUIElement * >::push_back(), CGUIElement::RemoveChild(), CEntity::SetName(), CGUIElement::SetParent(), and CGUIElement::SetType().

void CGUITabControl::Draw (   )  [virtual]

Method details: Draws the widget Reimplemented from CGUIRadioGroup. Definition at line 114 of file GUITabControl.cpp. References CGUIStatic::Draw().

void CGUITabControl::GetProperties (  EPropList &  PropList  )  [virtual]

Method details: Parameters: PropList  - Const. reference to the property list Reimplemented from CGUIRadioGroup. Definition at line 258 of file GUITabControl.cpp. References CGUIRadioGroup::GetProperties().

void CGUITabControl::Initialize (   )  [virtual]

Method details: Initializes GUI Border' variables Reimplemented from CGUIRadioGroup. Definition at line 14 of file GUITabControl.cpp. References CGUIElement::SetType().

bool CGUITabControl::IsOfType (  eEntityType  eType  )  [virtual]

Method details: This is an implementation of Custom RTTI Reimplemented from CGUIRadioGroup. Definition at line 212 of file GUITabControl.cpp. References CGUIRadioGroup::IsOfType().

int CGUITabControl::LoadXML (  TiXmlNode *  pDataNode, CString  strFilename )  [virtual]

Method details: Parameters: pDataNode  - Pointer to XML Node that holds data for this widget strFilename  - String containing filename where the data for the widget is stored Reimplemented from CGUIRadioGroup. Definition at line 41 of file GUITabControl.cpp. References CDoubleList< CGUIElement * >::begin(), CGUIRadioGroup::GetCurSel(), CEntity::GetID(), CGUIElement::GetType(), CGUIElement::Hide(), CGUIRadioGroup::LoadXML(), CDoubleList< CGUIElement * >::next(), CDoubleList< CGUIElement * >::set_ptr(), CGUIElement::SetType(), and CGUIElement::Show().

void CGUITabControl::ProcessMessage (  tGUIMessage &  Message  )  [virtual]

Method details: Parameters: Message  - Const. Reference to the message structure that is to be processed. Reimplemented from CGUIRadioGroup. Definition at line 119 of file GUITabControl.cpp. References CDoubleList< CGUIElement * >::begin(), CGUIRadioGroup::GetCurSel(), CEntity::GetID(), CGUIElement::GetType(), CGUIElement::Hide(), CGUIElement::IsChild(), CDoubleList< CGUIElement * >::next(), tGUIMessage::pSender, CDoubleList< CGUIElement * >::set_ptr(), SetCurSel(), CGUIButton::SetState(), and CGUIElement::Show().

bool CGUITabControl::PropertyChanging (  const void *  pvProperty, void *  pvNewValue )  [virtual]

Method details: Parameters: pvProperty  - Pointer to the property pvNewValue  - Pointer to the new value Reimplemented from CGUIRadioGroup. Definition at line 221 of file GUITabControl.cpp. References CDoubleList< CGUIElement * >::begin(), CGUIElement::GetType(), CGUIRadioGroup::InsertItem(), CDoubleList< CGUIElement * >::next(), CGUIRadioGroup::PropertyChanging(), CDoubleList< CGUIElement * >::set_ptr(), SetCurSel(), and CGUIElement::SetType().

int CGUITabControl::SaveXML (  TiXmlNode *  pDataNode, CString  strFilename )  [virtual]

Method details: Parameters: pDataNode  - Pointer to XML Node that will be the parent hold the data for this widget strFilename  - String containing filename where the data for the widget is stored Reimplemented from CGUIRadioGroup. Definition at line 92 of file GUITabControl.cpp. References CGUIRadioGroup::SaveXML(), and TiXmlNode::ToElement().

void CGUITabControl::SetCurSel (  int  iSelection  )  [virtual]

Method details: Parameters: iSelection  - Sets current tab selection to the one specified by value (by index). Reimplemented from CGUIRadioGroup. Definition at line 183 of file GUITabControl.cpp. References CDoubleList< CGUIElement * >::begin(), CGUIElement::GetChildCount(), CGUIElement::GetType(), CDoubleList< CGUIElement * >::next(), and CDoubleList< CGUIElement * >::set_ptr(). Referenced by ProcessMessage(), and PropertyChanging().

---

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

• D:/Programming/GUI Editor (Source)/GUI.h
• D:/Programming/GUI Editor (Source)/GUITabControl.cpp

---