GUIMainMenu Class Reference

Represents the main menu (and in-game menu). More...

#include <Game/GUIMainMenu.h>

Inherits GUIPanel.

List of all members.

Public Member Functions
	GUIMainMenu (GameState *state, FontRef f, FontRef aboutFont, const Rectf &aboutArea, const std::string &aboutTxt, FontRef versionFont)
	Constructor.
virtual const char *	GetPanelTypeName () const
	Gets the string type identifier for the GUI element.
virtual bool	InActiveArea (const Point2f &p) const
	Returns true if the point 'p' is inside this panel.
bool	IsAboutMenuOpen () const
	Returns true if the about menu is open.
void	CloseAboutMenu ()
	Closes the about menu.

---

Detailed Description

Represents the main menu (and in-game menu).

---

Constructor & Destructor Documentation

GUIMainMenu::GUIMainMenu	(	GameState *	state,
		FontRef	f,
		FontRef	aboutFont,
		const Rectf &	aboutArea,
		const std::string &	aboutTxt,
		FontRef	versionFont
	)

Constructor.

Parameters:

[in]	state	the game state class that the menu buttons will alter.
[in]	f	the font to use for menu buttons.
[in]	aboutFont	the font used for drawing about text.
[in]	aboutArea	the size of the about box.
[in]	aboutTxt	the about text.
[in]	versionFont	the font used for the version text.

---

Member Function Documentation

virtual const char* GUIMainMenu::GetPanelTypeName

(

)

const [inline, virtual]

Gets the string type identifier for the GUI element.

Returns:

The string type identifier.

Reimplemented from GUIPanel.

---

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

• GUIMainMenu.h
• GUIMainMenu.cpp