CUi Class Reference

Base class for all User Interface objects. More...

#include <ui.h>

Inheritance diagram for CUi:

List of all members.

Public Member Functions
Info methods
eUI	type () const
	Returns: The type of component this is.
Virtual methods
These will be overridden by derived UIs.
virtual void	update ()=0
	Update this UI for a single frame.
Static Public Member Functions
Creation methods
static CUi *	create_ui (eUI type)
	Factory used to creates a UI.
static bool	load (CGame *pGame, const std::string &filepath)
	Load animation descriptions from a file.
static bool	load (CGame *pGame, CXMLNode node)
	Load animation descriptions from a file.
static bool	load (CGame *pGame, const std::string &filename, const std::string &path)
	Load animation descriptions from a file.
Static Public Attributes
static const char *	m_kStrElmUI = "UI"
	XML element strings.
Protected Member Functions
	CUi (eUI type)
	Protected constructor (called from CUi::create_ui factory).
Protected Attributes
eUI	m_eType
	type of UI

---

Detailed Description

Base class for all User Interface objects.

(c) 2007-2008 oP group Germany GbR. All rights reserved.
This source code is provided "as is" with no warranty and must not be distributed without written permission.

Author:

Doug Poston

Version:

1.3

Date:

12/28/2007

---

Member Function Documentation

CUi * CUi::create_ui

(

eUI

type

)

[static]

Factory used to creates a UI.

Parameters:

type

Type of UI we want to create.

Returns:

Pointer to the CUi created (NULL on error).

bool CUi::load	(	CGame *	pGame,
		const std::string &	filepath
	)			[static]

Load animation descriptions from a file.

Parameters:

	pGame	Pointer to the Game we're adding to
	filepath	Full path to xml data file.

Returns:

true if the load succeeds

bool CUi::load	(	CGame *	pGame,
		CXMLNode	node
	)			[static]

Load animation descriptions from a file.

Parameters:

	pGame	Pointer to the Game we're adding to
	node	XML node

Returns:

true if the load succeeds

bool CUi::load	(	CGame *	pGame,
		const std::string &	filename,
		const std::string &	path
	)			[static]

Load animation descriptions from a file.

Parameters:

	pGame	Pointer to the Game we're adding to
	filename	Filename of data file.
	path	Filepath of data file.

Returns:

true if the load succeeds

---

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

• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/ui.h
• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/ui.cpp

---