Crazy Eddie's GUI System  ${CEGUI_VERSION}
System_wrapper Struct Reference
+ Inheritance diagram for System_wrapper:
+ Collaboration diagram for System_wrapper:

Public Member Functions

 System_wrapper (::CEGUI::Renderer &renderer, ::CEGUI::ResourceProvider *resourceProvider, ::CEGUI::XMLParser *xmlParser, ::CEGUI::ImageCodec *imageCodec, ::CEGUI::ScriptModule *scriptModule, ::CEGUI::String const &configFile, ::CEGUI::String const &logFile)
 
void cleanupImageCodec ()
 
void cleanupXMLParser ()
 
void createSingletons ()
 
void destroySingletons ()
 
void invalidateAllWindows ()
 
void outputLogHeader ()
 
void setupImageCodec (::CEGUI::String const &codecName)
 
void setupXMLParser ()
 
virtual void fireEvent (::CEGUI::String const &name, ::CEGUI::EventArgs &args, ::CEGUI::String const &eventNamespace="")
 
void default_fireEvent (::CEGUI::String const &name, ::CEGUI::EventArgs &args, ::CEGUI::String const &eventNamespace="")
 
void fireEvent_impl (::CEGUI::String const &name, ::CEGUI::EventArgs &args)
 
::CEGUI::ScriptModulegetScriptModule () const
 
virtual ::CEGUI::RefCounted< CEGUI::BoundSlotsubscribeScriptedEvent (::CEGUI::String const &name, ::CEGUI::String const &subscriber_name)
 
::CEGUI::RefCounted< CEGUI::BoundSlotdefault_subscribeScriptedEvent (::CEGUI::String const &name, ::CEGUI::String const &subscriber_name)
 
virtual ::CEGUI::RefCounted< CEGUI::BoundSlotsubscribeScriptedEvent (::CEGUI::String const &name, unsigned int group, ::CEGUI::String const &subscriber_name)
 
::CEGUI::RefCounted< CEGUI::BoundSlotdefault_subscribeScriptedEvent (::CEGUI::String const &name, unsigned int group, ::CEGUI::String const &subscriber_name)
 
- Public Member Functions inherited from CEGUI::System
RenderergetRenderer (void) const
 Return a pointer to the Renderer object being used by the system. More...
 
ClipboardgetClipboard () const
 Retrieves internal CEGUI clipboard, optionally synced with system wide clipboard.
 
GUIContextgetDefaultGUIContext () 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.
 
ScriptModulegetScriptingModule (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...
 
ResourceProvidergetResourceProvider (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...
 
XMLParsergetXMLParser (void) const
 Return the XMLParser object.
 
ImageCodecgetImageCodec () 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...
 
RenderedStringParsergetDefaultCustomRenderedStringParser () 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...
 
RegexMatchercreateRegexMatcher () 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.
 
GUIContextcreateGUIContext (RenderTarget &rt)
 
void destroyGUIContext (GUIContext &context)
 
void addStandardWindowFactories ()
 adds factories for all the basic window types More...
 
RenderergetRenderer (void) const
 Return a pointer to the Renderer object being used by the system. More...
 
ClipboardgetClipboard () const
 Retrieves internal CEGUI clipboard, optionally synced with system wide clipboard.
 
GUIContextgetDefaultGUIContext () 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.
 
ScriptModulegetScriptingModule (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...
 
ResourceProvidergetResourceProvider (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...
 
XMLParsergetXMLParser (void) const
 Return the XMLParser object.
 
ImageCodecgetImageCodec () 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...
 
RenderedStringParsergetDefaultCustomRenderedStringParser () 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...
 
RegexMatchercreateRegexMatcher () 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.
 
GUIContextcreateGUIContext (RenderTarget &rt)
 
void destroyGUIContext (GUIContext &context)
 
void addStandardWindowFactories ()
 adds factories for all the basic window types More...
 
- Public Member Functions inherited from CEGUI::EventSet
 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...
 
EventgetEventObject (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.
 
 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...
 
EventgetEventObject (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.
 

Additional Inherited Members

- Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator< EventMap > EventIterator
 
typedef ConstMapIterator< EventMap > EventIterator
 
- Static Public Member Functions inherited from CEGUI::System
static Systemcreate (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 StringgetVersion ()
 Retrieves CEGUI's "short" version ("1.2.3" for example) More...
 
static const StringgetVerboseVersion ()
 Retrieves CEGUI's "verbose" version, includes info about compiler, platform, etc... More...
 
static SystemgetSingleton (void)
 Return singleton System object. More...
 
static SystemgetSingletonPtr (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 StringgetDefaultImageCodecName ()
 Get the name of the default image codec.
 
static const StringTranscodergetStringTranscoder ()
 Return the system StringTranscoder object.
 
static void performVersionTest (const int expected, const int received, const String &func)
 Internal CEGUI version validation function.
 
static Systemcreate (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 StringgetVersion ()
 Retrieves CEGUI's "short" version ("1.2.3" for example) More...
 
static const StringgetVerboseVersion ()
 Retrieves CEGUI's "verbose" version, includes info about compiler, platform, etc... More...
 
static SystemgetSingleton (void)
 Return singleton System object. More...
 
static SystemgetSingletonPtr (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 StringgetDefaultImageCodecName ()
 Get the name of the default image codec.
 
static const StringTranscodergetStringTranscoder ()
 Return the system StringTranscoder object.
 
static void performVersionTest (const int expected, const int received, const String &func)
 Internal CEGUI version validation function.
 
- Static Public Member Functions inherited from CEGUI::Singleton< System >
static SystemgetSingleton (void)
 
static SystemgetSingleton (void)
 
static SystemgetSingletonPtr (void)
 
static SystemgetSingletonPtr (void)
 
- Static Public Attributes inherited from CEGUI::System
static const String EventNamespace
 Namespace for global events.
 
static const String EventDisplaySizeChanged
 
static const String EventRenderedStringParserChanged
 
- Protected Types inherited from CEGUI::System
typedef std::vector< GUIContext *CEGUI_VECTOR_ALLOC(GUIContext *)> GUIContextCollection
 
typedef std::vector< GUIContext *CEGUI_VECTOR_ALLOC(GUIContext *)> GUIContextCollection
 
- Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event *, StringFastLessCompare CEGUI_MAP_ALLOC(String, Event *)> EventMap
 
typedef std::map< String, Event *, StringFastLessCompare CEGUI_MAP_ALLOC(String, Event *)> EventMap
 
- Protected Member Functions inherited from CEGUI::System
 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.
 
 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.
 
- Protected Member Functions inherited from CEGUI::Singleton< System >
AnimationManagerms_Singleton
 
WidgetLookManagerms_Singleton
 
FontManagerms_Singleton
 
GlobalEventSetms_Singleton
 
ImageManagerms_Singleton
 
Loggerms_Singleton
 
RenderEffectManagerms_Singleton
 
SchemeManagerms_Singleton
 
Systemms_Singleton
 
WindowFactoryManagerms_Singleton
 
WindowManagerms_Singleton
 
WindowRendererManagerms_Singleton
 
- Protected Member Functions inherited from CEGUI::EventSet
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
 EventSet (const EventSet &)
 
EventSetoperator= (EventSet &)
 
EventSetoperator= (const EventSet &)
 
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
 EventSet (const EventSet &)
 
EventSetoperator= (EventSet &)
 
EventSetoperator= (const EventSet &)
 
- Protected Attributes inherited from CEGUI::System
Rendererd_renderer
 Holds the pointer to the Renderer object given to us in the constructor.
 
ResourceProviderd_resourceProvider
 Holds the pointer to the ResourceProvider object given to us by the renderer or the System constructor.
 
bool d_ourResourceProvider
 
Clipboardd_clipboard
 Internal clipboard with optional sync with native clipboard.
 
ScriptModuled_scriptModule
 Points to the scripting support module.
 
String d_termScriptName
 Name of the script to run upon system shutdown.
 
XMLParserd_xmlParser
 XMLParser object we use to process xml files.
 
bool d_ourXmlParser
 true when we created the xml parser.
 
DynamicModuled_parserModule
 
ImageCodecd_imageCodec
 Holds a pointer to the image codec to use.
 
bool d_ourImageCodec
 true when we created the image codec.
 
DynamicModuled_imageCodecModule
 
bool d_ourLogger
 true when we created the CEGUI::Logger based object.
 
RenderedStringParserd_customRenderedStringParser
 currently set global RenderedStringParser.
 
GUIContextCollection d_guiContexts
 
- Protected Attributes inherited from CEGUI::EventSet
EventMap d_events
 
bool d_muted
 true if events for this EventSet have been muted.
 
- Static Protected Attributes inherited from CEGUI::System
static String d_defaultXMLParserName
 pointer to parser module. More...
 
static String d_defaultImageCodecName
 Holds the name of the default codec to use.
 
static const IconvStringTranscoder d_stringTranscoder
 instance of class that can convert string encodings
 
- Static Protected Attributes inherited from CEGUI::Singleton< System >
static Systemms_Singleton