Crazy Eddie's GUI System  0.8.7
CEGUI::Scheme Class Reference

A class that groups a set of GUI elements and initialises the system to access those elements. More...

+ Inheritance diagram for CEGUI::Scheme:
+ Collaboration diagram for CEGUI::Scheme:

Classes

struct  LoadableUIElement
 A single file reference to a font, imageset or so to be loaded as part of this Scheme. More...
 

Public Types

typedef ConstVectorIterator< LoadableUIElementList > LoadableUIElementIterator
 

Public Member Functions

 ~Scheme (void)
 Destroys a Scheme object.
 
void loadResources (void)
 Loads all resources for this scheme. More...
 
void unloadResources (void)
 Unloads all resources for this scheme. This should be used very carefully. More...
 
bool resourcesLoaded (void) const
 Return whether the resources for this Scheme are all loaded. More...
 
const StringgetName (void) const
 Return the name of this Scheme. More...
 
void loadXMLImagesets ()
 Load all XML based imagesets required by the scheme.
 
void loadImageFileImagesets ()
 Load all image file based imagesets required by the scheme.
 
void loadFonts ()
 Load all xml based fonts required by the scheme.
 
void loadLookNFeels ()
 Load all xml looknfeel files required by the scheme.
 
void loadWindowFactories ()
 Register all window factories required by the scheme.
 
void loadWindowRendererFactories ()
 Register all window renderer factories required by the scheme.
 
void loadFactoryAliases ()
 Register all factory aliases required by the scheme.
 
void loadFalagardMappings ()
 Create all falagard mappings required by the scheme.
 
void unloadXMLImagesets ()
 Unload all XML based imagesets created by the scheme.
 
void unloadImageFileImagesets ()
 Unload all image file based imagesets created by the scheme.
 
void unloadFonts ()
 Unload all xml based fonts created by the scheme.
 
void unloadLookNFeels ()
 Unload all xml looknfeel files loaded by the scheme.
 
void unloadWindowFactories ()
 Unregister all window factories registered by the scheme.
 
void unloadWindowRendererFactories ()
 Unregister all window renderer factories registered by the scheme.
 
void unloadFactoryAliases ()
 Unregister all factory aliases created by the scheme.
 
void unloadFalagardMappings ()
 Unregister all falagard mappings created by the scheme.
 
bool areXMLImagesetsLoaded () const
 Check state of all XML based imagesets created by the scheme.
 
bool areImageFileImagesetsLoaded () const
 Check state of all image file based imagesets created by the scheme.
 
bool areFontsLoaded () const
 Check state of all xml based fonts created by the scheme.
 
bool areLookNFeelsLoaded () const
 Check state of all looknfeel files loaded by the scheme.
 
bool areWindowFactoriesLoaded () const
 Check state of all window factories registered by the scheme.
 
bool areWindowRendererFactoriesLoaded () const
 Check state of all window renderer factories registered by the scheme.
 
bool areFactoryAliasesLoaded () const
 Check state of all factory aliases created by the scheme.
 
bool areFalagardMappingsLoaded () const
 Check state of all falagard mappings created by the scheme.
 
LoadableUIElementIterator getXMLImagesets () const
 Retrieves iterator for all references to XML imagesets that are to be loaded with this Scheme.
 
LoadableUIElementIterator getImageFileImagesets () const
 Retrieves iterator for all references to image file imagesets that are to be loaded with this Scheme.
 
LoadableUIElementIterator getFonts () const
 Retrieves iterator for all references to font files that are to be loaded with this Scheme.
 
LoadableUIElementIterator getLookNFeels () const
 Retrieves iterator for all references to LookNFeels files that are to be loaded with this Scheme.
 

Static Public Member Functions

static const StringgetDefaultResourceGroup ()
 Returns the default resource group currently set for Schemes. More...
 
static void setDefaultResourceGroup (const String &resourceGroup)
 Sets the default resource group to be used when loading scheme xml data. More...
 

Friends

class Scheme_xmlHandler
 

Detailed Description

A class that groups a set of GUI elements and initialises the system to access those elements.

A GUI Scheme is a high-level construct that loads and initialises various lower-level objects and registers them within the system for usage. So, for example, a Scheme might create some Imageset objects, some Font objects, and register a collection of WindowFactory objects within the system which would then be in a state to serve those elements to client code.

Member Function Documentation

static const String& CEGUI::Scheme::getDefaultResourceGroup ( void  )
inlinestatic

Returns the default resource group currently set for Schemes.

Returns
String describing the default resource group identifier that will be used when loading Scheme xml file data.
const String& CEGUI::Scheme::getName ( void  ) const
inline

Return the name of this Scheme.

Returns
String object containing the name of this Scheme.
void CEGUI::Scheme::loadResources ( void  )

Loads all resources for this scheme.

Returns
Nothing.
bool CEGUI::Scheme::resourcesLoaded ( void  ) const

Return whether the resources for this Scheme are all loaded.

Returns
true if all resources for the Scheme are loaded and available, or false of one or more resource is not currently loaded.
static void CEGUI::Scheme::setDefaultResourceGroup ( const String resourceGroup)
inlinestatic

Sets the default resource group to be used when loading scheme xml data.

Parameters
resourceGroupString describing the default resource group identifier to be used.
Returns
Nothing.
void CEGUI::Scheme::unloadResources ( void  )

Unloads all resources for this scheme. This should be used very carefully.

Returns
Nothing.