Crazy Eddie's GUI System  0.8.4
CEGUI::DefaultResourceProvider Class Reference
+ Inheritance diagram for CEGUI::DefaultResourceProvider:
+ Collaboration diagram for CEGUI::DefaultResourceProvider:

List of all members.

Public Member Functions

void setResourceGroupDirectory (const String &resourceGroup, const String &directory)
 Set the directory associated with a given resource group identifier.
const StringgetResourceGroupDirectory (const String &resourceGroup)
 Return the directory associated with the specified resource group identifier.
void clearResourceGroupDirectory (const String &resourceGroup)
 clears any currently set directory for the specified resource group identifier.
void loadRawDataContainer (const String &filename, RawDataContainer &output, const String &resourceGroup)
 Load XML data using InputSource objects.
void unloadRawDataContainer (RawDataContainer &data)
 Unload raw binary data. This gives the resource provider a change to unload the data in its own way before the data container object is destroyed. If it does nothing, then the object will release its memory.
size_t getResourceGroupFileNames (std::vector< String > &out_vec, const String &file_pattern, const String &resource_group)

Protected Types

typedef std::map< String,
String, StringFastLessCompare
ResourceGroupMap

Protected Member Functions

String getFinalFilename (const String &filename, const String &resourceGroup) const
 Return the final path and filename, taking into account the given resource group identifier that should be used when attempting to load the data.

Protected Attributes

ResourceGroupMap d_resourceGroups

Member Function Documentation

clears any currently set directory for the specified resource group identifier.

Parameters:
resourceGroupThe resource group identifier for which the associated directory is to be cleared.

Return the directory associated with the specified resource group identifier.

Parameters:
resourceGroupThe resource group identifier for which the associated directory is to be returned.
Returns:
String object describing the directory currently associated with resource group identifier resourceGroup.
Note:
This member is not defined as being const because it may cause creation of an 'empty' directory specification for the resourceGroup if the resourceGroup has not previously been accessed.
size_t CEGUI::DefaultResourceProvider::getResourceGroupFileNames ( std::vector< String > &  out_vec,
const String file_pattern,
const String resource_group 
) [virtual]

enumerate the files in resource_group that match file_pattern and append thier names to out_vec

Implements CEGUI::ResourceProvider.

Reimplemented in CEGUI::MinizipResourceProvider.

void CEGUI::DefaultResourceProvider::loadRawDataContainer ( const String filename,
RawDataContainer output,
const String resourceGroup 
) [virtual]

Load XML data using InputSource objects.

Parameters:
filenameString containing a filename of the resource to be loaded.
outputReference to a InputSourceContainer object to load the data into.

Load raw binary data.

Parameters:
filenameString containing a filename of the resource to be loaded.
outputReference to a RawDataContainer object to load the data into.
resourceGroupOptional String that may be used by implementations to identify the group from which the resource should be loaded.

Implements CEGUI::ResourceProvider.

Reimplemented in CEGUI::MinizipResourceProvider, and CEGUI::IrrlichtResourceProvider.

void CEGUI::DefaultResourceProvider::setResourceGroupDirectory ( const String resourceGroup,
const String directory 
)

Set the directory associated with a given resource group identifier.

Parameters:
resourceGroupThe resource group identifier whose directory is to be set.
directoryThe directory to be associated with resource group identifier resourceGroup
Returns:
Nothing.

Unload raw binary data. This gives the resource provider a change to unload the data in its own way before the data container object is destroyed. If it does nothing, then the object will release its memory.

Parameters:
dataReference to a RawDataContainer object that is about to be destroyed.

Reimplemented from CEGUI::ResourceProvider.

Reimplemented in CEGUI::IrrlichtResourceProvider.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends