OpenGUI::WidgetManager Class Reference

#include <OpenGUI_WidgetManager.h>

Detailed Description

Provides Widget registration and definition functionality.

Public Types

typedef std::pair< String,
String > WidgetRegPair

inner type of WidgetRegPairList

typedef std::list< WidgetRegPair > WidgetRegPairList

return type of GetRegisteredWidgets()

typedef std::list< String > WidgetDefList

return type of GetDefinedWidgets()

Public Member Functions

Widget * CreateRawWidget (const String &Name, const String &Library="")

Create a Widget that was registered under the given Name and optionally Library.

Widget * CreateDefinedWidget (const String &Name)

Creates and initializes a Widget that was previously defined by DefineWidget().

void DefineWidget (const String &Name, const ValueList &propertyList, const String &BaseName, const String &BaseLibrary)

Defines a new Widget under the given Name with the given propertyList, using BaseName and BaseLibrary as the source.

void UndefineWidget (const String &Name)

Undefines an existing Widget definition by Name.

void RegisterWidgetFactory (const String &Name, const String &Library, WidgetFactoryCallback *factoryCallback)

Register a Widget factory.

void UnregisterWidgetFactory (const String &Name, const String &Library)

Unregister a Widget factory.

WidgetRegPairList GetRegisteredWidgets ()

returns a pair list of all registered widgets

WidgetDefList GetDefinedWidgets ()

returns a list of all defined widgets

void getStats (size_t &RegWidgets, size_t &RegLibs, size_t &DefWidgets)

returns the number of registered widgets across the number of libraries, as well as the number of widget definitions

Static Public Member Functions

static WidgetManager & getSingleton (void)

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

static WidgetManager * getSingletonPtr (void)

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

Member Typedef Documentation

typedef std::list<String> OpenGUI::WidgetManager::WidgetDefList

return type of GetDefinedWidgets()

typedef std::pair<String, String> OpenGUI::WidgetManager::WidgetRegPair

inner type of WidgetRegPairList

typedef std::list<WidgetRegPair> OpenGUI::WidgetManager::WidgetRegPairList

return type of GetRegisteredWidgets()

Member Function Documentation

Widget * OpenGUI::WidgetManager::CreateDefinedWidget ( const String & Name )

Creates and initializes a Widget that was previously defined by DefineWidget().

Widget * OpenGUI::WidgetManager::CreateRawWidget ( const String & Name,

const String & Library = ""

)

Create a Widget that was registered under the given Name and optionally Library.
If Library is not given or is "", the value of Name will be tested to see if it is in a packed Name:Library format. If so then the packed value will be exploded and used, otherwise the full list of registered cursors is walked and the first entry with a matching Name is used.

void OpenGUI::WidgetManager::DefineWidget ( const String & Name,

const ValueList & propertyList,

const String & BaseName,

const String & BaseLibrary

)

Defines a new Widget under the given Name with the given propertyList, using BaseName and BaseLibrary as the source.

WidgetManager::WidgetDefList OpenGUI::WidgetManager::GetDefinedWidgets ( )

returns a list of all defined widgets

WidgetManager::WidgetRegPairList OpenGUI::WidgetManager::GetRegisteredWidgets ( )

returns a pair list of all registered widgets

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

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

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

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

void OpenGUI::WidgetManager::getStats ( size_t & RegWidgets,

size_t & RegLibs,

size_t & DefWidgets

)

returns the number of registered widgets across the number of libraries, as well as the number of widget definitions

void OpenGUI::WidgetManager::RegisterWidgetFactory ( const String & Name,

const String & Library,

WidgetFactoryCallback * factoryCallback

)

Register a Widget factory.

void OpenGUI::WidgetManager::UndefineWidget ( const String & Name )

Undefines an existing Widget definition by Name.

void OpenGUI::WidgetManager::UnregisterWidgetFactory ( const String & Name,

const String & Library

)

Unregister a Widget factory.

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

OpenGUI_WidgetManager.h
OpenGUI_WidgetManager.cpp


Public Types
typedef std::pair< String, String >	WidgetRegPair
	inner type of WidgetRegPairList
typedef std::list< WidgetRegPair >	WidgetRegPairList
	return type of GetRegisteredWidgets()
typedef std::list< String >	WidgetDefList
	return type of GetDefinedWidgets()
Public Member Functions
Widget *	CreateRawWidget (const String &Name, const String &Library="")
	Create a Widget that was registered under the given `Name` and optionally `Library`.
Widget *	CreateDefinedWidget (const String &Name)
	Creates and initializes a Widget that was previously defined by DefineWidget().
void	DefineWidget (const String &Name, const ValueList &propertyList, const String &BaseName, const String &BaseLibrary)
	Defines a new Widget under the given `Name` with the given `propertyList`, using `BaseName` and `BaseLibrary` as the source.
void	UndefineWidget (const String &Name)
	Undefines an existing Widget definition by `Name`.
void	RegisterWidgetFactory (const String &Name, const String &Library, WidgetFactoryCallback *factoryCallback)
	Register a Widget factory.
void	UnregisterWidgetFactory (const String &Name, const String &Library)
	Unregister a Widget factory.
WidgetRegPairList	GetRegisteredWidgets ()
	returns a pair list of all registered widgets
WidgetDefList	GetDefinedWidgets ()
	returns a list of all defined widgets
void	getStats (size_t &RegWidgets, size_t &RegLibs, size_t &DefWidgets)
	returns the number of registered widgets across the number of libraries, as well as the number of widget definitions
Static Public Member Functions
static WidgetManager &	getSingleton (void)
	Retrieve the current singleton, if one exists. If none exists, this will cause an error.
static WidgetManager *	getSingletonPtr (void)
	Retrieve a pointer to the current singleton, if one exists. If none exists, this will return 0.