OpenGUI::CursorManager Class Reference

#include <OpenGUI_CursorManager.h>

Detailed Description

Provides Cursor registration and definition functionality.

Public Types

typedef std::pair< String,
String > CursorRegPair

inner type of CursorRegPairList

typedef std::list< CursorRegPair > CursorRegPairList

return type of GetRegisteredCursors()

typedef std::list< String > CursorDefList

return type of GetDefinedCursors()

Public Member Functions

CursorPtr CreateRawCursor (const String &Name, const String &Library="")

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

CursorPtr CreateDefinedCursor (const String &Name)

Creates and initializes a cursor that was previously defined by DefineCursor().

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

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

void UndefineCursor (const String &Name)

Undefines an existing cursor definition by Name.

void RegisterCursorFactory (const String &Name, const String &Library, CursorFactoryCallback *factoryCallback)

Register a Cursor factory.

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

Unregister a Cursor factory.

CursorRegPairList GetRegisteredCursors ()

returns a pair list of all registered Cursors

CursorDefList GetDefinedCursors ()

returns a list of all defined Cursors

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 CursorManager & getSingleton (void)

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

static CursorManager * 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::CursorManager::CursorDefList

return type of GetDefinedCursors()

typedef std::pair<String, String> OpenGUI::CursorManager::CursorRegPair

inner type of CursorRegPairList

typedef std::list<CursorRegPair> OpenGUI::CursorManager::CursorRegPairList

return type of GetRegisteredCursors()

Member Function Documentation

CursorPtr OpenGUI::CursorManager::CreateDefinedCursor ( const String & Name )

Creates and initializes a cursor that was previously defined by DefineCursor().

CursorPtr OpenGUI::CursorManager::CreateRawCursor ( const String & Name,

const String & Library = ""

)

Create a Cursor 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::CursorManager::DefineCursor ( const String & Name,

const ValueList & propertyList,

const String & BaseName,

const String & BaseLibrary

)

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

CursorManager::CursorDefList OpenGUI::CursorManager::GetDefinedCursors ( )

returns a list of all defined Cursors

CursorManager::CursorRegPairList OpenGUI::CursorManager::GetRegisteredCursors ( )

returns a pair list of all registered Cursors

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

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

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

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

void OpenGUI::CursorManager::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::CursorManager::RegisterCursorFactory ( const String & Name,

const String & Library,

CursorFactoryCallback * factoryCallback

)

Register a Cursor factory.

void OpenGUI::CursorManager::UndefineCursor ( const String & Name )

Undefines an existing cursor definition by Name.

void OpenGUI::CursorManager::UnregisterCursorFactory ( const String & Name,

const String & Library

)

Unregister a Cursor factory.

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

OpenGUI_CursorManager.h
OpenGUI_CursorManager.cpp


Public Types
typedef std::pair< String, String >	CursorRegPair
	inner type of CursorRegPairList
typedef std::list< CursorRegPair >	CursorRegPairList
	return type of GetRegisteredCursors()
typedef std::list< String >	CursorDefList
	return type of GetDefinedCursors()
Public Member Functions
CursorPtr	CreateRawCursor (const String &Name, const String &Library="")
	Create a Cursor that was registered under the given `Name` and optionally `Library`.
CursorPtr	CreateDefinedCursor (const String &Name)
	Creates and initializes a cursor that was previously defined by DefineCursor().
void	DefineCursor (const String &Name, const ValueList &propertyList, const String &BaseName, const String &BaseLibrary)
	Defines a new cursor under the given `Name` with the given `propertyList`, using `BaseName` and `BaseLibrary` as the source.
void	UndefineCursor (const String &Name)
	Undefines an existing cursor definition by `Name`.
void	RegisterCursorFactory (const String &Name, const String &Library, CursorFactoryCallback *factoryCallback)
	Register a Cursor factory.
void	UnregisterCursorFactory (const String &Name, const String &Library)
	Unregister a Cursor factory.
CursorRegPairList	GetRegisteredCursors ()
	returns a pair list of all registered Cursors
CursorDefList	GetDefinedCursors ()
	returns a list of all defined Cursors
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 CursorManager &	getSingleton (void)
	Retrieve the current singleton, if one exists. If none exists, this will cause an error.
static CursorManager *	getSingletonPtr (void)
	Retrieve a pointer to the current singleton, if one exists. If none exists, this will return 0.