#include <OpenGUI_CursorManager.h>
Public Types | |
| typedef std::pair< std::string, std::string > | CursorRegPair |
| inner type of CursorRegPairList | |
| typedef std::list< CursorRegPair > | CursorRegPairList |
| return type of GetRegisteredCursors() | |
| typedef std::list< std::string > | CursorDefList |
| return type of GetDefinedCursors() | |
Public Member Functions | |
| CursorPtr | CreateRawCursor (const std::string &Name, const std::string &Library="") |
Create a Cursor that was registered under the given Name and optionally Library. | |
| CursorPtr | CreateDefinedCursor (const std::string &Name) |
| Creates and initializes a cursor that was previously defined by DefineCursor(). | |
| void | DefineCursor (const std::string &Name, const ValueList &propertyList, const std::string &BaseName, const std::string &BaseLibrary) |
Defines a new cursor under the given Name with the given propertyList, using BaseName and BaseLibrary as the source. | |
| void | UndefineCursor (const std::string &Name) |
Undefines an existing cursor definition by Name. | |
| void | RegisterCursorFactory (const std::string &Name, const std::string &Library, CursorFactoryCallback *factoryCallback) |
| Register a Cursor factory. | |
| void | UnregisterCursorFactory (const std::string &Name, const std::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. | |
| typedef std::list<std::string> OpenGUI::CursorManager::CursorDefList |
return type of GetDefinedCursors()
| typedef std::pair<std::string, std::string> OpenGUI::CursorManager::CursorRegPair |
inner type of CursorRegPairList
| typedef std::list<CursorRegPair> OpenGUI::CursorManager::CursorRegPairList |
return type of GetRegisteredCursors()
| CursorPtr OpenGUI::CursorManager::CreateDefinedCursor | ( | const std::string & | Name | ) |
Creates and initializes a cursor that was previously defined by DefineCursor().
| CursorPtr OpenGUI::CursorManager::CreateRawCursor | ( | const std::string & | Name, | |
| const std::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 std::string & | Name, | |
| const ValueList & | propertyList, | |||
| const std::string & | BaseName, | |||
| const std::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 std::string & | Name, | |
| const std::string & | Library, | |||
| CursorFactoryCallback * | factoryCallback | |||
| ) |
Register a Cursor factory.
| void OpenGUI::CursorManager::UndefineCursor | ( | const std::string & | Name | ) |
Undefines an existing cursor definition by Name.
| void OpenGUI::CursorManager::UnregisterCursorFactory | ( | const std::string & | Name, | |
| const std::string & | Library | |||
| ) |
Unregister a Cursor factory.