GUI::Scheme Class Reference

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

List of all members.

Public Member Functions
void	loadResources ()
	Loads all resources for this scheme.
void	unloadResources ()
	Unloads all resources for this scheme. This should be used very carefully.
bool	resourcesLoaded ()
	Return whether the resources for this Scheme are all loaded.
string	getName ()
	Return the name of this Scheme.
string	getDefaultResourceGroup ()
	Returns the default resource group currently set for Schemes.
void	setDefaultResourceGroup (string resourceGroup)
	Sets the default resource group to be used when loading scheme xml data.

---

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

void GUI::Scheme::loadResources

(

)

Loads all resources for this scheme.

Returns:

Nothing.

void GUI::Scheme::unloadResources

(

)

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

Returns:

Nothing.

bool GUI::Scheme::resourcesLoaded

(

)

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.

string GUI::Scheme::getName

(

)

Return the name of this Scheme.

Returns:

String object containing the name of this Scheme.

string GUI::Scheme::getDefaultResourceGroup

(

)

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.

void GUI::Scheme::setDefaultResourceGroup

(

string

resourceGroup

)

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

Parameters:

resourceGroup

String describing the default resource group identifier to be used.

Returns:

Nothing.