|
Renderer * | getRenderer (void) const |
| Return a pointer to the Renderer object being used by the system. More...
|
|
Clipboard * | getClipboard () const |
| Retrieves internal CEGUI clipboard, optionally synced with system wide clipboard.
|
|
GUIContext & | getDefaultGUIContext () const |
|
void | renderAllGUIContexts () |
| Depending upon the internal state, for each GUIContext this may either re-use cached rendering from last time or trigger a full re-draw of all elements.
|
|
ScriptModule * | getScriptingModule (void) const |
| Return a pointer to the ScriptModule being used for scripting within the GUI system. More...
|
|
void | setScriptingModule (ScriptModule *scriptModule) |
| Set the ScriptModule to be used for scripting within the GUI system. More...
|
|
ResourceProvider * | getResourceProvider (void) const |
| Return a pointer to the ResourceProvider being used within the GUI system. More...
|
|
void | executeScriptFile (const String &filename, const String &resourceGroup="") const |
| Execute a script file if possible. More...
|
|
int | executeScriptGlobal (const String &function_name) const |
| Execute a scripted global function if possible. The function should not take any parameters and should return an integer. More...
|
|
void | executeScriptString (const String &str) const |
| If possible, execute script code contained in the given CEGUI::String object. More...
|
|
void | setXMLParser (const String &parserName) |
| Set a new XML parser module to be used. More...
|
|
void | setXMLParser (XMLParser *parser) |
| Sets the XMLParser object to be used by the system. More...
|
|
XMLParser * | getXMLParser (void) const |
| Return the XMLParser object.
|
|
ImageCodec & | getImageCodec () const |
| Retrieve the image codec to be used by the system.
|
|
void | setImageCodec (const String &codecName) |
| Set the image codec to be used by the system.
|
|
void | setImageCodec (ImageCodec &codec) |
| Set the image codec to use from an existing image codec. More...
|
|
void | notifyDisplaySizeChanged (const Sizef &new_size) |
| Notification function to be called when the main display changes size. Client code should call this function when the host window changes size, or if the display resolution is changed in full-screen mode. More...
|
|
RenderedStringParser * | getDefaultCustomRenderedStringParser () const |
| Return pointer to the currently set global default custom RenderedStringParser object. More...
|
|
void | setDefaultCustomRenderedStringParser (RenderedStringParser *parser) |
| Set the global default custom RenderedStringParser object. This change is reflected the next time an affected window reparses it's text. This may be set to 0 for no system wide custom parser (which is the default). More...
|
|
void | invalidateAllCachedRendering () |
| Invalidate all imagery and geometry caches for CEGUI managed elements. More...
|
|
RegexMatcher * | createRegexMatcher () const |
| Create a RegexMatcher instance if support is available. More...
|
|
void | destroyRegexMatcher (RegexMatcher *rm) const |
| destroy a RegexMatcher instance returned by System::createRegexMatcher.
|
|
bool | injectTimePulse (float timeElapsed) |
| call this to ensure system-level time based updates occur.
|
|
GUIContext & | createGUIContext (RenderTarget &rt) |
|
void | destroyGUIContext (GUIContext &context) |
|
void | addStandardWindowFactories () |
| adds factories for all the basic window types More...
|
|
| EventSet () |
| Constructor for EventSet objects.
|
|
virtual | ~EventSet (void) |
| Destructor for EventSet objects.
|
|
void | addEvent (const String &name) |
| Creates a new Event object with the given name and adds it to the EventSet. More...
|
|
void | addEvent (Event &event) |
| Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...
|
|
void | removeEvent (const String &name) |
| Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...
|
|
void | removeEvent (Event &event) |
| Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...
|
|
void | removeAllEvents (void) |
| Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.
|
|
bool | isEventPresent (const String &name) |
| Checks to see if an Event with the given name is present in this EventSet. More...
|
|
virtual Event::Connection | subscribeEvent (const String &name, Event::Subscriber subscriber) |
| Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
|
|
virtual Event::Connection | subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber) |
| Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
|
|
template<typename Arg1 , typename Arg2 > |
Event::Connection | subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2) |
| Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
|
|
template<typename Arg1 , typename Arg2 > |
Event::Connection | subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2) |
| Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
|
|
virtual Event::Connection | subscribeScriptedEvent (const String &name, const String &subscriber_name) |
| Subscribes the named Event to a scripted funtion. More...
|
|
virtual Event::Connection | subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name) |
| Subscribes the specified group of the named Event to a scripted funtion. More...
|
|
virtual void | fireEvent (const String &name, EventArgs &args, const String &eventNamespace="") |
| Fires the named event passing the given EventArgs object. More...
|
|
bool | isMuted (void) const |
| Return whether the EventSet is muted or not. More...
|
|
void | setMutedState (bool setting) |
| Set the mute state for this EventSet. More...
|
|
Event * | getEventObject (const String &name, bool autoAdd=false) |
| Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...
|
|
EventIterator | getEventIterator (void) const |
| Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.
|
|
|
static System & | create (Renderer &renderer, ResourceProvider *resourceProvider=0, XMLParser *xmlParser=0, ImageCodec *imageCodec=0, ScriptModule *scriptModule=0, const String &configFile="", const String &logFile="CEGUI.log", const int abi=CEGUI_VERSION_ABI) |
| Create the System object and return a reference to it. More...
|
|
static void | destroy () |
| Destroy the System object.
|
|
static unsigned int | getMajorVersion () |
| Retrieves CEGUI's major version as an integer. More...
|
|
static unsigned int | getMinorVersion () |
| Retrieves CEGUI's minor version as an integer. More...
|
|
static unsigned int | getPatchVersion () |
| Retrieves CEGUI's patch version as an integer. More...
|
|
static const String & | getVersion () |
| Retrieves CEGUI's "short" version ("1.2.3" for example) More...
|
|
static const String & | getVerboseVersion () |
| Retrieves CEGUI's "verbose" version, includes info about compiler, platform, etc... More...
|
|
static System & | getSingleton (void) |
| Return singleton System object. More...
|
|
static System * | getSingletonPtr (void) |
| Return pointer to singleton System object. More...
|
|
static void | setDefaultXMLParserName (const String &parserName) |
| Static member to set the name of the default XML parser module that should be used. More...
|
|
static const String | getDefaultXMLParserName () |
| Return the name of the currently set default xml parser module. More...
|
|
static void | setDefaultImageCodecName (const String &codecName) |
| Set the name of the default image codec to be used.
|
|
static const String & | getDefaultImageCodecName () |
| Get the name of the default image codec.
|
|
static const StringTranscoder & | getStringTranscoder () |
| Return the system StringTranscoder object.
|
|
static void | performVersionTest (const int expected, const int received, const String &func) |
| Internal CEGUI version validation function.
|
|
static System & | getSingleton (void) |
|
static System * | getSingletonPtr (void) |
|
|
| System (Renderer &renderer, ResourceProvider *resourceProvider, XMLParser *xmlParser, ImageCodec *imageCodec, ScriptModule *scriptModule, const String &configFile, const String &logFile) |
| Construct a new System object. More...
|
|
| ~System (void) |
| Destructor for System objects.
|
|
void | outputLogHeader () |
| output the standard log header
|
|
void | createSingletons () |
| create the other core system singleton objects (except the logger)
|
|
void | destroySingletons () |
| cleanup the core system singleton objects
|
|
void | setupXMLParser () |
| handle creation and initialisation of the XML parser.
|
|
void | cleanupXMLParser () |
| handle cleanup of the XML parser
|
|
void | setupImageCodec (const String &codecName) |
| setup image codec
|
|
void | cleanupImageCodec () |
| cleanup image codec
|
|
void | invalidateAllWindows () |
| invalidate all windows and any rendering surfaces they may be using.
|
|
void | fireEvent_impl (const String &name, EventArgs &args) |
| Implementation event firing member.
|
|
ScriptModule * | getScriptModule () const |
| Helper to return the script module pointer or throw.
|
|
| EventSet (EventSet &) |
|
| EventSet (const EventSet &) |
|
EventSet & | operator= (EventSet &) |
|
EventSet & | operator= (const EventSet &) |
|
The System class is the CEGUI class that provides access to all other elements in this system.
This object must be created by the client application. The System object requires that you pass it an initialised Renderer object which it can use to interface to whatever rendering system will be used to display the GUI imagery.
static void CEGUI::System::setDefaultXMLParserName |
( |
const String & |
parserName | ) |
|
|
static |
Static member to set the name of the default XML parser module that should be used.
If you want to modify the default parser from the one compiled in, you need to call this static member prior to instantiating the main CEGUI::System object.
Note that calling this member to change the name of the default module after CEGUI::System, and therefore the default xml parser, has been created will have no real effect - the default parser name will be updated, though no actual changes to the xml parser module will occur.
The built-in options for this are:
Whether these are actually available, depends upon how you built the system. If you have some custom parser, you can provide the name of that here to have it used as the default, though note that the final filename of the parser module should be of the form:
[prefix]CEGUI[parserName][suffix]
where:
- [prefix] is some optional prefix; like 'lib' on linux.
- CEGUI is a required prefix.
- [parserName] is the name of the parser, as supplied to this function.
- [suffix] is the filename suffix, like .dll or .so
Final module filenames are, thus, of the form:
- CEGUIXercesParser.dll
- libCEGUIXercesParser.so
- Parameters
-
parserName | String describing the name of the xml parser module to be used as the default. |
- Returns
- Nothing.