Crazy Eddie's GUI System 0.8.7
CEGUI::MinizipResourceProvider Class Reference
+ Inheritance diagram for CEGUI::MinizipResourceProvider:
+ Collaboration diagram for CEGUI::MinizipResourceProvider:

Public Member Functions

 MinizipResourceProvider (const String &archive, bool loadLocal=true)
 
void setArchive (const String &archive)
 sets the archive from which files are retrieved. More...
 
void setPassword (const String &password)
 
void setLoadLocal (bool load=true)
 
void loadRawDataContainer (const String &filename, RawDataContainer &output, const String &resourceGroup)
 Load XML data using InputSource objects. More...
 
size_t getResourceGroupFileNames (std::vector< String > &out_vec, const String &file_pattern, const String &resource_group)
 
- Public Member Functions inherited from CEGUI::DefaultResourceProvider
void setResourceGroupDirectory (const String &resourceGroup, const String &directory)
 Set the directory associated with a given resource group identifier. More...
 
const StringgetResourceGroupDirectory (const String &resourceGroup)
 Return the directory associated with the specified resource group identifier. More...
 
void clearResourceGroupDirectory (const String &resourceGroup)
 clears any currently set directory for the specified resource group identifier. More...
 
void loadRawDataContainer (const String &filename, RawDataContainer &output, const String &resourceGroup)
 Load XML data using InputSource objects. More...
 
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. More...
 
size_t getResourceGroupFileNames (std::vector< String > &out_vec, const String &file_pattern, const String &resource_group)
 
- Public Member Functions inherited from CEGUI::ResourceProvider
 ResourceProvider ()
 Constructor for the ResourceProvider class.
 
virtual ~ResourceProvider (void)
 Destructor for the ResourceProvider class.
 
virtual void loadRawDataContainer (const String &filename, RawDataContainer &output, const String &resourceGroup)=0
 Load XML data using InputSource objects. More...
 
virtual void unloadRawDataContainer (RawDataContainer &)
 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. More...
 
const StringgetDefaultResourceGroup (void) const
 Return the current default resource group identifier. More...
 
void setDefaultResourceGroup (const String &resourceGroup)
 Set the default resource group identifier. More...
 
virtual size_t getResourceGroupFileNames (std::vector< String > &out_vec, const String &file_pattern, const String &resource_group)=0
 

Protected Member Functions

bool doesFileExist (const String &filename)
 
void openArchive ()
 
void closeArchive ()
 
- Protected Member Functions inherited from CEGUI::DefaultResourceProvider
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

Impl * d_pimpl
 
- Protected Attributes inherited from CEGUI::DefaultResourceProvider
ResourceGroupMap d_resourceGroups
 
- Protected Attributes inherited from CEGUI::ResourceProvider
String d_defaultResourceGroup
 Default resource group identifier.
 

Additional Inherited Members

- Protected Types inherited from CEGUI::DefaultResourceProvider
typedef std::map< String, String, StringFastLessCompare CEGUI_MAP_ALLOC(String, String)> ResourceGroupMap
 

Member Function Documentation

◆ getResourceGroupFileNames()

size_t CEGUI::MinizipResourceProvider::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

Reimplemented from CEGUI::DefaultResourceProvider.

◆ loadRawDataContainer()

void CEGUI::MinizipResourceProvider::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. ‍/ virtual void loadInputSourceContainer(const String& filename, InputSourceContainer& output) = 0;
/*!
\brief
    Load raw binary data.

\param filename
    String containing a filename of the resource to be loaded.

    \param output
    Reference to a RawDataContainer object to load the data into.

\param resourceGroup
    Optional String that may be used by implementations to identify the group from
    which the resource should be loaded.

Reimplemented from CEGUI::DefaultResourceProvider.

◆ setArchive()

void CEGUI::MinizipResourceProvider::setArchive ( const String archive)

sets the archive from which files are retrieved.

Parameters
archiveThe filepath to the archive