CEGUI::Scheme Class Reference

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

#include <CEGUIScheme.h>

Collaboration diagram for CEGUI::Scheme:

[legend]List of all members.

Public Member Functions
void	loadResources (void)
	Loads all resources for this scheme.
void	unloadResources (void)
	Unloads all resources for this scheme. This should be used very carefully.
bool	resourcesLoaded (void) const
	Return whether the resources for this Scheme are all loaded.
const String &	getName (void) const
	Return the name of this Scheme.
	~Scheme (void)
	Destroys a Scheme object.
Friends
class	Scheme_xmlHandler
Scheme *	SchemeManager::loadScheme (const String &scheme_filename, const String &resourceGroup)
void	SchemeManager::unloadScheme (const String &scheme_name)

---

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.

Definition at line 54 of file CEGUIScheme.h.

---

Constructor & Destructor Documentation

CEGUI::Scheme::~Scheme (  void   )

Destroys a Scheme object. Returns: Nothing Definition at line 158 of file CEGUIScheme.cpp. References CEGUI::Informative, unloadResources(), and CEGUI::utf8.

---

Member Function Documentation

const String& CEGUI::Scheme::getName (  void   )  const [inline]

Return the name of this Scheme. Returns: String object containing the name of this Scheme. Definition at line 95 of file CEGUIScheme.h. Referenced by CEGUI::SchemeManager::loadScheme().

void CEGUI::Scheme::loadResources (  void   )

Loads all resources for this scheme. Returns: Nothing. Definition at line 169 of file CEGUIScheme.cpp. References CEGUI::WindowFactoryManager::addWindowTypeAlias(), CEGUI::FontManager::createFont(), CEGUI::ImagesetManager::createImageset(), CEGUI::FontManager::destroyFont(), CEGUI::ImagesetManager::destroyImageset(), CEGUI::WindowFactoryManager::getAliasIterator(), CEGUI::ConstBaseIterator< T >::getCurrentKey(), CEGUI::ConstBaseIterator< T >::getCurrentValue(), CEGUI::Font::getName(), CEGUI::Imageset::getName(), CEGUI::Informative, CEGUI::ConstBaseIterator< T >::isAtEnd(), CEGUI::WindowFactoryManager::isFactoryPresent(), CEGUI::FontManager::isFontPresent(), CEGUI::ImagesetManager::isImagesetPresent(), CEGUI::WindowFactoryManager::TypeAliasIterator, and CEGUI::utf8.

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. Definition at line 345 of file CEGUIScheme.cpp. References CEGUI::WindowFactoryManager::getAliasIterator(), CEGUI::ConstBaseIterator< T >::getCurrentKey(), CEGUI::ConstBaseIterator< T >::getCurrentValue(), CEGUI::ConstBaseIterator< T >::isAtEnd(), CEGUI::WindowFactoryManager::isFactoryPresent(), CEGUI::FontManager::isFontPresent(), CEGUI::ImagesetManager::isImagesetPresent(), and CEGUI::WindowFactoryManager::TypeAliasIterator.

void CEGUI::Scheme::unloadResources (  void   )

Unloads all resources for this scheme. This should be used very carefully. Returns: Nothing. Definition at line 277 of file CEGUIScheme.cpp. References CEGUI::FontManager::destroyFont(), CEGUI::ImagesetManager::destroyImageset(), CEGUI::WindowFactoryManager::getAliasIterator(), CEGUI::ConstBaseIterator< T >::getCurrentKey(), CEGUI::Informative, CEGUI::ConstBaseIterator< T >::isAtEnd(), CEGUI::WindowFactoryManager::removeFactory(), CEGUI::WindowFactoryManager::removeWindowTypeAlias(), CEGUI::WindowFactoryManager::TypeAliasIterator, and CEGUI::utf8. Referenced by ~Scheme().

---

Friends And Related Function Documentation

friend class Scheme_xmlHandler [friend]

Definition at line 56 of file CEGUIScheme.h.

Scheme* SchemeManager::loadScheme (  const String &  scheme_filename, const String &  resourceGroup )  [friend]

void SchemeManager::unloadScheme (  const String &  scheme_name  )  [friend]

---

The documentation for this class was generated from the following files:

• CEGUIScheme.h
• CEGUIScheme.cpp

---