Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

CEGUI::SchemeManager Class Reference

A class that manages the creation of, access to, and destruction of GUI Scheme objects. More...

#include <CEGUISchemeManager.h>

Inheritance diagram for CEGUI::SchemeManager:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::SchemeManager:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ConstBaseIterator<
SchemeRegistry > 
SchemeIterator

Public Member Functions

 SchemeManager (void)
 Constructor for SchemeManager objects.
 ~SchemeManager (void)
 Destructor for SchemeManager objects.
SchemeloadScheme (const String &scheme_filename, const String &resourceGroup="")
 Loads a scheme.
void unloadScheme (const String &scheme_name)
 Unloads all data referenced in a scheme. If any object is using some resource which is listed in the scheme, this function will effectively pull the rug out from under those objects. This should be used with extreme caution, or not at all.
bool isSchemePresent (const String &scheme_name) const
 Returns true if the named Scheme is present in the system (though the resources for the scheme may or may not be loaded).
SchemegetScheme (const String &name) const
 Returns a pointer to the Scheme object with the specified name.
void unloadAllSchemes (void)
 Unload all schemes currently defined within the system.
SchemeIterator getIterator (void) const
 Return a SchemeManager::SchemeIterator object to iterate over the available schemes.

Static Public Member Functions

SchemeManagergetSingleton (void)
 Return singleton SchemeManager object.
SchemeManagergetSingletonPtr (void)
 Return pointer to singleton SchemeManager object.

Static Protected Attributes

SchemeManagerms_Singleton = NULL

Detailed Description

A class that manages the creation of, access to, and destruction of GUI Scheme objects.

Definition at line 50 of file CEGUISchemeManager.h.


Member Typedef Documentation

typedef ConstBaseIterator<SchemeRegistry> CEGUI::SchemeManager::SchemeIterator
 

Definition at line 170 of file CEGUISchemeManager.h.

Referenced by getIterator().


Constructor & Destructor Documentation

CEGUI::SchemeManager::SchemeManager void   ) 
 

Constructor for SchemeManager objects.

Definition at line 45 of file CEGUISchemeManager.cpp.

References CEGUI::utf8.

CEGUI::SchemeManager::~SchemeManager void   ) 
 

Destructor for SchemeManager objects.

Definition at line 54 of file CEGUISchemeManager.cpp.

References unloadAllSchemes(), and CEGUI::utf8.


Member Function Documentation

SchemeManager::SchemeIterator CEGUI::SchemeManager::getIterator void   )  const
 

Return a SchemeManager::SchemeIterator object to iterate over the available schemes.

Definition at line 130 of file CEGUISchemeManager.cpp.

References SchemeIterator.

Scheme * CEGUI::SchemeManager::getScheme const String name  )  const
 

Returns a pointer to the Scheme object with the specified name.

Parameters:
name String object holding the name of the Scheme to be returned.
Returns:
Pointer to the Scheme named name.
Exceptions:
UnknownObjectException thrown if no Scheme named name is present in the system

Definition at line 101 of file CEGUISchemeManager.cpp.

SchemeManager & CEGUI::SchemeManager::getSingleton void   )  [static]
 

Return singleton SchemeManager object.

Returns:
Singleton SchemeManager object

Reimplemented from CEGUI::Singleton< SchemeManager >.

Definition at line 114 of file CEGUISchemeManager.cpp.

SchemeManager * CEGUI::SchemeManager::getSingletonPtr void   )  [static]
 

Return pointer to singleton SchemeManager object.

Returns:
Pointer to singleton SchemeManager object

Reimplemented from CEGUI::Singleton< SchemeManager >.

Definition at line 120 of file CEGUISchemeManager.cpp.

bool CEGUI::SchemeManager::isSchemePresent const String scheme_name  )  const [inline]
 

Returns true if the named Scheme is present in the system (though the resources for the scheme may or may not be loaded).

Parameters:
scheme_name String object specifying the name of the Scheme to check for.
Returns:
true if the scheme is loaded, false if it is not.

Definition at line 126 of file CEGUISchemeManager.h.

Scheme * CEGUI::SchemeManager::loadScheme const String scheme_filename,
const String resourceGroup = ""
 

Loads a scheme.

Parameters:
scheme_filename String object that holds the filename of the scheme to be loaded
resourceGroup Resource group identifier to be passed to the resource manager. NB: This affects loading of the scheme xml file only, scheme resources may specify their own groups.
Returns:
Pointer to an object representing the loaded Scheme.

Definition at line 67 of file CEGUISchemeManager.cpp.

References CEGUI::Scheme::getName(), and CEGUI::utf8.

void CEGUI::SchemeManager::unloadAllSchemes void   ) 
 

Unload all schemes currently defined within the system.

Note:
Calling this method has the potential to be very dangerous; if any of the data that forms part of the scheme is still in use, you can expect fireworks shortly after!
Returns:
Nothing.

Definition at line 139 of file CEGUISchemeManager.cpp.

References unloadScheme().

Referenced by ~SchemeManager().

void CEGUI::SchemeManager::unloadScheme const String scheme_name  ) 
 

Unloads all data referenced in a scheme. If any object is using some resource which is listed in the scheme, this function will effectively pull the rug out from under those objects. This should be used with extreme caution, or not at all.

Parameters:
scheme_name String object specifying the name of the Scheme to be unloaded.

Definition at line 81 of file CEGUISchemeManager.cpp.

References CEGUI::utf8.

Referenced by unloadAllSchemes().


Member Data Documentation

SchemeManager * CEGUI::Singleton< SchemeManager >::ms_Singleton = NULL [static, protected, inherited]
 

Definition at line 38 of file CEGUISchemeManager.cpp.


The documentation for this class was generated from the following files:
Generated on Wed Feb 16 12:41:11 2005 for Crazy Eddies GUI System by  doxygen 1.3.9.1