1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUIResourceProvider.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CEGUIResourceProvider.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/***********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> filename: CEGUIResourceProvider.h</span>
<a name="l00003"></a>00003 <span class="comment"> created: 8/7/2004</span>
<a name="l00004"></a>00004 <span class="comment"> author: James '_mental_' O'Sullivan</span>
<a name="l00005"></a>00005 <span class="comment"> </span>
<a name="l00006"></a>00006 <span class="comment"> purpose: Defines abstract base class for loading DataContainer objects</span>
<a name="l00007"></a>00007 <span class="comment">*************************************************************************/</span>
<a name="l00008"></a>00008 <span class="comment">/***************************************************************************</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining</span>
<a name="l00012"></a>00012 <span class="comment"> * a copy of this software and associated documentation files (the</span>
<a name="l00013"></a>00013 <span class="comment"> * "Software"), to deal in the Software without restriction, including</span>
<a name="l00014"></a>00014 <span class="comment"> * without limitation the rights to use, copy, modify, merge, publish,</span>
<a name="l00015"></a>00015 <span class="comment"> * distribute, sublicense, and/or sell copies of the Software, and to</span>
<a name="l00016"></a>00016 <span class="comment"> * permit persons to whom the Software is furnished to do so, subject to</span>
<a name="l00017"></a>00017 <span class="comment"> * the following conditions:</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * The above copyright notice and this permission notice shall be</span>
<a name="l00020"></a>00020 <span class="comment"> * included in all copies or substantial portions of the Software.</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</span>
<a name="l00023"></a>00023 <span class="comment"> * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span>
<a name="l00024"></a>00024 <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span>
<a name="l00025"></a>00025 <span class="comment"> * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR</span>
<a name="l00026"></a>00026 <span class="comment"> * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span>
<a name="l00027"></a>00027 <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span>
<a name="l00028"></a>00028 <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span>
<a name="l00029"></a>00029 <span class="comment"> ***************************************************************************/</span>
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef _CEGUIResourceProvider_h_</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define _CEGUIResourceProvider_h_</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "CEGUIBase.h"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "CEGUIDataContainer.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "CEGUIString.h"</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <vector></span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">// Start of CEGUI namespace section</span>
<a name="l00040"></a>00040 <span class="keyword">namespace </span>CEGUI
<a name="l00041"></a>00041 {
<a name="l00048"></a><a class="code" href="classCEGUI_1_1ResourceProvider.html">00048</a> <span class="keyword">class </span>CEGUIEXPORT <a class="code" href="classCEGUI_1_1ResourceProvider.html" title="Abstract class that defines the required interface for all resource provider sub-classes.">ResourceProvider</a>
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 <span class="keyword">public</span>:
<a name="l00051"></a>00051 <span class="comment">/*************************************************************************</span>
<a name="l00052"></a>00052 <span class="comment"> Construction and Destruction</span>
<a name="l00053"></a>00053 <span class="comment"> *************************************************************************/</span>
<a name="l00058"></a><a class="code" href="classCEGUI_1_1ResourceProvider.html#a7b1e766647acaddc7505b7a393b7b869">00058</a> <a class="code" href="classCEGUI_1_1ResourceProvider.html#a7b1e766647acaddc7505b7a393b7b869" title="Constructor for the ResourceProvider class.">ResourceProvider</a>() { }
<a name="l00059"></a>00059
<a name="l00064"></a><a class="code" href="classCEGUI_1_1ResourceProvider.html#ad45a5c0b896ee0b16222e2d7fc58b39e">00064</a> <span class="keyword">virtual</span> <a class="code" href="classCEGUI_1_1ResourceProvider.html#ad45a5c0b896ee0b16222e2d7fc58b39e" title="Destructor for the ResourceProvider class.">~ResourceProvider</a>(<span class="keywordtype">void</span>) { }
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="comment">/*************************************************************************</span>
<a name="l00067"></a>00067 <span class="comment"> Accessor functions</span>
<a name="l00068"></a>00068 <span class="comment"> *************************************************************************/</span>
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">// /*!</span>
<a name="l00071"></a>00071 <span class="comment">// \brief</span>
<a name="l00072"></a>00072 <span class="comment">// Load XML data using InputSource objects.</span>
<a name="l00073"></a>00073 <span class="comment">//</span>
<a name="l00074"></a>00074 <span class="comment">// \param filename</span>
<a name="l00075"></a>00075 <span class="comment">// String containing a filename of the resource to be loaded.</span>
<a name="l00076"></a>00076 <span class="comment">//</span>
<a name="l00077"></a>00077 <span class="comment">// \param output</span>
<a name="l00078"></a>00078 <span class="comment">// Reference to a InputSourceContainer object to load the data into.</span>
<a name="l00079"></a>00079 <span class="comment">// */</span>
<a name="l00080"></a>00080 <span class="comment">// virtual void loadInputSourceContainer(const String& filename, InputSourceContainer& output) = 0;</span>
<a name="l00081"></a>00081
<a name="l00096"></a>00096 <span class="keyword">virtual</span> <span class="keywordtype">void</span> loadRawDataContainer(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& filename, <a class="code" href="classCEGUI_1_1RawDataContainer.html" title="Class used as the databuffer for loading files throughout the library.">RawDataContainer</a>& output, <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& resourceGroup) = 0;
<a name="l00097"></a>00097
<a name="l00108"></a><a class="code" href="classCEGUI_1_1ResourceProvider.html#a811c29cfcd2ba43a05f719a800ec4781">00108</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1ResourceProvider.html#a811c29cfcd2ba43a05f719a800ec4781" title="Unload raw binary data. This gives the resource provider a change to unload the data in its own way b...">unloadRawDataContainer</a>(<a class="code" href="classCEGUI_1_1RawDataContainer.html" title="Class used as the databuffer for loading files throughout the library.">RawDataContainer</a>&) { }
<a name="l00109"></a>00109
<a name="l00117"></a><a class="code" href="classCEGUI_1_1ResourceProvider.html#a86b1a3b813a56e66adec660b1047d86b">00117</a> <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& <a class="code" href="classCEGUI_1_1ResourceProvider.html#a86b1a3b813a56e66adec660b1047d86b" title="Return the current default resource group identifier.">getDefaultResourceGroup</a>(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> d_defaultResourceGroup; }
<a name="l00118"></a>00118
<a name="l00129"></a><a class="code" href="classCEGUI_1_1ResourceProvider.html#ad641db3c7ea4434911c2488383e990d2">00129</a> <span class="keywordtype">void</span> <a class="code" href="classCEGUI_1_1ResourceProvider.html#ad641db3c7ea4434911c2488383e990d2" title="Set the default resource group identifier.">setDefaultResourceGroup</a>(<span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& resourceGroup) { d_defaultResourceGroup = resourceGroup; }
<a name="l00130"></a>00130
<a name="l00134"></a>00134 <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> getResourceGroupFileNames(std::vector<String>& out_vec,
<a name="l00135"></a>00135 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& file_pattern,
<a name="l00136"></a>00136 <span class="keyword">const</span> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a>& resource_group) = 0;
<a name="l00137"></a>00137 <span class="keyword">protected</span>:
<a name="l00138"></a><a class="code" href="classCEGUI_1_1ResourceProvider.html#a930aa1633100c5e02f9ba95e9d9fc255">00138</a> <a class="code" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> <a class="code" href="classCEGUI_1_1ResourceProvider.html#a930aa1633100c5e02f9ba95e9d9fc255" title="Default resource group identifier.">d_defaultResourceGroup</a>;
<a name="l00139"></a>00139 };
<a name="l00140"></a>00140
<a name="l00141"></a>00141 } <span class="comment">// End of CEGUI namespace section</span>
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="preprocessor">#endif // end of guard _CEGUIResourceProvider_h_</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:39 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
