OpenGUI::FormManager Class Reference

#include <OpenGUI_FormManager.h>

Detailed Description

Manages creating, destroying, and lookup of FormDefinition objects.

Public Member Functions

void DefineForm (const String &formName, FormEntry &formRoot)

Defines a Form for later use according to the provided formDefinition, which can be recalled by the given formName.

void UndefineForm (const String &formName)

Removes a previously defined Form by the given formName.

Widget * CreateForm (const String &formName, WidgetCollection *container=0, const String &widgetName="")

Creates a predefined form, signified by formName, within the given container, assigning the given widgetName to the form's root widget.

Static Public Member Functions

static FormManager & getSingleton (void)

Retrieve the current singleton, if one exists. If none exists, this will cause an error.

static FormManager * getSingletonPtr (void)

Retrieve a pointer to the current singleton, if one exists. If none exists, this will return 0.

Protected Member Functions

void DefineForm (const String &formName, FormEntry *formRoot)

Same as other DefineForm, except that this does not duplicate the given formRoot, and instead stored the pointer and assumes ownership.

Member Function Documentation

Widget * OpenGUI::FormManager::CreateForm ( const String & formName,

WidgetCollection * container = 0,

const String & widgetName = ""

)

Creates a predefined form, signified by formName, within the given container, assigning the given widgetName to the form's root widget.

void OpenGUI::FormManager::DefineForm ( const String & formName,

FormEntry * formRoot

) [protected]

Same as other DefineForm, except that this does not duplicate the given formRoot, and instead stored the pointer and assumes ownership.

void OpenGUI::FormManager::DefineForm ( const String & formName,

FormEntry & formRoot

)

Defines a Form for later use according to the provided formDefinition, which can be recalled by the given formName.

FormManager & OpenGUI::FormManager::getSingleton ( void ) [static]

Retrieve the current singleton, if one exists. If none exists, this will cause an error.

FormManager * OpenGUI::FormManager::getSingletonPtr ( void ) [static]

Retrieve a pointer to the current singleton, if one exists. If none exists, this will return 0.

void OpenGUI::FormManager::UndefineForm ( const String & formName )

Removes a previously defined Form by the given formName.

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

OpenGUI_FormManager.h
OpenGUI_FormManager.cpp


Public Member Functions
void	DefineForm (const String &formName, FormEntry &formRoot)
	Defines a Form for later use according to the provided `formDefinition`, which can be recalled by the given `formName`.
void	UndefineForm (const String &formName)
	Removes a previously defined Form by the given `formName`.
Widget *	CreateForm (const String &formName, WidgetCollection *container=0, const String &widgetName="")
	Creates a predefined form, signified by `formName`, within the given `container`, assigning the given `widgetName` to the form's root widget.
Static Public Member Functions
static FormManager &	getSingleton (void)
	Retrieve the current singleton, if one exists. If none exists, this will cause an error.
static FormManager *	getSingletonPtr (void)
	Retrieve a pointer to the current singleton, if one exists. If none exists, this will return 0.
Protected Member Functions
void	DefineForm (const String &formName, FormEntry *formRoot)
	Same as other DefineForm, except that this does not duplicate the given `formRoot`, and instead stored the pointer and assumes ownership.