Main Page | Class Hierarchy | Class List | File List | Class Members | Related Pages

CGUIMenu Class Reference

Menu Control. More...

#include <GUI.h>

Inheritance diagram for CGUIMenu:

CGUIMenuEntry CGUIButton CGUIStatic CGUIElement CXMLResource CDoubleList< CGUIElement * > CResource CEntity List of all members.

Public Member Functions

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

Detailed Description

Menu Control.

This control represents an fully featured menu control. It can expand to anywhere you want it to (up/down, left/right, or a combination of those). NOTE: All of its entries MUST be CGUIMenuEntry (or CGUIMenuEntry-derived) widgets.

Definition at line 1910 of file GUI.h.


Member Function Documentation

int CGUIMenu::Create CGUIElement pParent,
tRect  WidgetRect,
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
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?
pDefaultEntryBtn - Pointer to the default DropList entry CGUIButton (or -derived) widget
Returns:
1 if sucessful, 0 if not

Reimplemented from CGUIMenuEntry.

Definition at line 20 of file GUIMenu.cpp.

References CGUIMenuEntry::Create().

void CGUIMenu::Draw  )  [virtual]
 

Method details: Draws the widget

Reimplemented from CGUIMenuEntry.

Definition at line 62 of file GUIMenu.cpp.

References CGUIMenuEntry::Draw(), CGUIElement::GetChild(), CGUIElement::Show(), and CGUIElement::ShowSiblings().

void CGUIMenu::GetProperties EPropList &  PropList  )  [virtual]
 

Method details:

Parameters:
PropList - Const. reference to the property list

Reimplemented from CGUIMenuEntry.

Definition at line 120 of file GUIMenu.cpp.

References CGUIMenuEntry::GetProperties().

void CGUIMenu::Initialize  )  [virtual]
 

Method details: Initializes GUI DropList' variables

Reimplemented from CGUIMenuEntry.

Definition at line 14 of file GUIMenu.cpp.

References CGUIElement::SetType().

bool CGUIMenu::IsOfType eEntityType  eType  )  [virtual]
 

Method details: This is an implementation of Custom RTTI

Reimplemented from CGUIMenuEntry.

Definition at line 105 of file GUIMenu.cpp.

References CGUIMenuEntry::IsOfType().

int CGUIMenu::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 CGUIMenuEntry.

Definition at line 25 of file GUIMenu.cpp.

References CGUIElement::GetRect(), CGUIMenuEntry::LoadXML(), and CGUIMenuEntry::Resize().

void CGUIMenu::ProcessMessage tGUIMessage Message  )  [virtual]
 

Method details:

Parameters:
Message - Const. Reference to the message structure that is to be processed.

Reimplemented from CGUIMenuEntry.

Definition at line 73 of file GUIMenu.cpp.

References CGUIMenuEntry::Collapse(), CGUIMenuEntry::Expand(), CGUIElement::GetChild(), CGUIElement::GetChildCount(), CGUIElement::GetRect(), tGUIMessage::pSender, CGUIMenuEntry::Resize(), and CGUIElement::Visible().

bool CGUIMenu::PropertyChanging const void *  pvProperty,
void *  pvNewValue
[virtual]
 

Method details:

Parameters:
pvProperty - Pointer to the property
pvNewValue - Pointer to the new value

Reimplemented from CGUIMenuEntry.

Definition at line 113 of file GUIMenu.cpp.

References CGUIMenuEntry::PropertyChanging().

int CGUIMenu::SaveXML TiXmlNode pDataNode,
CString  strFilename
[virtual]
 

Method details:

Parameters:
pDataNode - Pointer to XML Node that will be the parent hold the data for this element
strFilename - String containing filename where the data for the widget is stored

Reimplemented from CGUIMenuEntry.

Definition at line 39 of file GUIMenu.cpp.

References CGUIMenuEntry::SaveXML(), and TiXmlNode::ToElement().


The documentation for this class was generated from the following files:
Generated on Sun Jul 17 21:34:29 2005 for OpenGL GUI by doxygen 1.3.8