Crazy Eddie's GUI System 0.8.7
DefaultResourceProvider.h
1/***********************************************************************
2 created: 8/7/2004
3 author: James '_mental_' O'Sullivan
4
5 purpose: Defines abstract base class for CEGUIData objects
6*************************************************************************/
7/***************************************************************************
8 * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining
11 * a copy of this software and associated documentation files (the
12 * "Software"), to deal in the Software without restriction, including
13 * without limitation the rights to use, copy, modify, merge, publish,
14 * distribute, sublicense, and/or sell copies of the Software, and to
15 * permit persons to whom the Software is furnished to do so, subject to
16 * the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be
19 * included in all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
24 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
25 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
26 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27 * OTHER DEALINGS IN THE SOFTWARE.
28 ***************************************************************************/
29#ifndef _CEGUIDefaultResourceProvider_h_
30#define _CEGUIDefaultResourceProvider_h_
31
32#include "CEGUI/Base.h"
33#include "CEGUI/ResourceProvider.h"
34
35#include <map>
36
37#if defined(_MSC_VER)
38# pragma warning(push)
39# pragma warning(disable : 4251)
40#endif
41
42// Start of CEGUI namespace section
43namespace CEGUI
44{
45class CEGUIEXPORT DefaultResourceProvider : public ResourceProvider
46{
47public:
48 /*************************************************************************
49 Construction and Destruction
50 *************************************************************************/
53
68 void setResourceGroupDirectory(const String& resourceGroup, const String& directory);
69
88 const String& getResourceGroupDirectory(const String& resourceGroup);
89
99 void clearResourceGroupDirectory(const String& resourceGroup);
100
101 void loadRawDataContainer(const String& filename, RawDataContainer& output, const String& resourceGroup);
103 size_t getResourceGroupFileNames(std::vector<String>& out_vec,
104 const String& file_pattern,
105 const String& resource_group);
106
107protected:
114 String getFinalFilename(const String& filename, const String& resourceGroup) const;
115
116 typedef std::map<String, String, StringFastLessCompare> ResourceGroupMap;
117 ResourceGroupMap d_resourceGroups;
118};
119
120} // End of CEGUI namespace section
121
122#if defined(_MSC_VER)
123# pragma warning(pop)
124#endif
125
126#endif // end of guard _CEGUIDefaultResourceProvider_h_
Definition: DefaultResourceProvider.h:46
void setResourceGroupDirectory(const String &resourceGroup, const String &directory)
Set the directory associated with a given resource group identifier.
String getFinalFilename(const String &filename, const String &resourceGroup) const
Return the final path and filename, taking into account the given resource group identifier that shou...
size_t getResourceGroupFileNames(std::vector< String > &out_vec, const String &file_pattern, const String &resource_group)
const String & getResourceGroupDirectory(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 unloadRawDataContainer(RawDataContainer &data)
Unload raw binary data. This gives the resource provider a change to unload the data in its own way b...
void loadRawDataContainer(const String &filename, RawDataContainer &output, const String &resourceGroup)
Load XML data using InputSource objects.
Class used as the databuffer for loading files throughout the library.
Definition: DataContainer.h:44
Abstract class that defines the required interface for all resource provider sub-classes.
Definition: ResourceProvider.h:49
String class used within the GUI system.
Definition: String.h:64
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1