OpenGUI: OpenGUI::FormManager Class Reference


Public Member Functions
void	DefineForm (const std::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 std::string &formName)
	Removes a previously defined Form by the given `formName`.
Widget *	CreateForm (const std::string &formName, WidgetCollection *container=0, const std::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 std::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 std::string &	formName,
		WidgetCollection *	container = `0`,
		const std::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 std::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 std::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 std::string & formName )

Removes a previously defined Form by the given formName.

OpenGUI::FormManager Class Reference