File: classCEGUI_1_1MinizipResourceProvider.html

package info (click to toggle)
cegui-mk2 0.7.6-3.3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 105,388 kB
  • ctags: 82,178
  • sloc: cpp: 142,729; ansic: 27,984; sh: 11,010; makefile: 2,275; python: 916; xml: 17
file content (258 lines) | stat: -rw-r--r-- 15,939 bytes parent folder | download | duplicates (2) 
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
<!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: CEGUI::MinizipResourceProvider Class Reference</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&#160;<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
      <li class="navelem"><a class="el" href="classCEGUI_1_1MinizipResourceProvider.html">MinizipResourceProvider</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">CEGUI::MinizipResourceProvider Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::MinizipResourceProvider" --><!-- doxytag: inherits="CEGUI::DefaultResourceProvider" --><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::MinizipResourceProvider:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1MinizipResourceProvider__inherit__graph.gif" border="0" usemap="#CEGUI_1_1MinizipResourceProvider_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1MinizipResourceProvider_inherit__map" id="CEGUI_1_1MinizipResourceProvider_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1DefaultResourceProvider.html" title="CEGUI::DefaultResourceProvider" alt="" coords="5,83,224,112"/><area shape="rect" id="node4" href="classCEGUI_1_1ResourceProvider.html" title="Abstract class that defines the required interface for all resource provider sub&#45;classes." alt="" coords="27,5,203,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::MinizipResourceProvider:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1MinizipResourceProvider__coll__graph.gif" border="0" usemap="#CEGUI_1_1MinizipResourceProvider_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1MinizipResourceProvider_coll__map" id="CEGUI_1_1MinizipResourceProvider_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1DefaultResourceProvider.html" title="CEGUI::DefaultResourceProvider" alt="" coords="5,181,224,211"/><area shape="rect" id="node4" href="classCEGUI_1_1ResourceProvider.html" title="Abstract class that defines the required interface for all resource provider sub&#45;classes." alt="" coords="27,101,203,131"/><area shape="rect" id="node6" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="61,5,168,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classCEGUI_1_1MinizipResourceProvider-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a399c240165e3824d23a437c985219afe"></a><!-- doxytag: member="CEGUI::MinizipResourceProvider::MinizipResourceProvider" ref="a399c240165e3824d23a437c985219afe" args="(const String &amp;archive, bool loadLocal=true)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>MinizipResourceProvider</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;archive, bool loadLocal=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MinizipResourceProvider.html#a38d793fe7b7830bdf04bea706cb46438">setArchive</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;archive)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">sets the archive from which files are retrieved.  <a href="#a38d793fe7b7830bdf04bea706cb46438"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a670e68808489cb3a098d555335dc01a1"></a><!-- doxytag: member="CEGUI::MinizipResourceProvider::setLoadLocal" ref="a670e68808489cb3a098d555335dc01a1" args="(bool load=true)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setLoadLocal</b> (bool load=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MinizipResourceProvider.html#a9f9b07679cbd33620907f6aad03a956e">loadRawDataContainer</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;filename, <a class="el" href="classCEGUI_1_1RawDataContainer.html">RawDataContainer</a> &amp;output, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;resourceGroup)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Load XML data using InputSource objects.  <a href="#a9f9b07679cbd33620907f6aad03a956e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MinizipResourceProvider.html#a484ea2129c877a5a7405ad2281984e80">getResourceGroupFileNames</a> (std::vector&lt; <a class="el" href="classCEGUI_1_1String.html">String</a> &gt; &amp;out_vec, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;file_pattern, const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;resource_group)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4eee2b27ea4350cd5a2d8c248c418c7"></a><!-- doxytag: member="CEGUI::MinizipResourceProvider::doesFileExist" ref="ab4eee2b27ea4350cd5a2d8c248c418c7" args="(const String &amp;filename)" -->
bool&#160;</td><td class="memItemRight" valign="bottom"><b>doesFileExist</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;filename)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39632f3d43993b24400b82d1b2c80e7e"></a><!-- doxytag: member="CEGUI::MinizipResourceProvider::openArchive" ref="a39632f3d43993b24400b82d1b2c80e7e" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>openArchive</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a952695b8ecc78052636b14b2e5501afc"></a><!-- doxytag: member="CEGUI::MinizipResourceProvider::closeArchive" ref="a952695b8ecc78052636b14b2e5501afc" args="()" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>closeArchive</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac044e68bc28d00042202f088c99b8c17"></a><!-- doxytag: member="CEGUI::MinizipResourceProvider::d_pimpl" ref="ac044e68bc28d00042202f088c99b8c17" args="" -->
Impl *&#160;</td><td class="memItemRight" valign="bottom"><b>d_pimpl</b></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a484ea2129c877a5a7405ad2281984e80"></a><!-- doxytag: member="CEGUI::MinizipResourceProvider::getResourceGroupFileNames" ref="a484ea2129c877a5a7405ad2281984e80" args="(std::vector&lt; String &gt; &amp;out_vec, const String &amp;file_pattern, const String &amp;resource_group)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t CEGUI::MinizipResourceProvider::getResourceGroupFileNames </td>
          <td>(</td>
          <td class="paramtype">std::vector&lt; <a class="el" href="classCEGUI_1_1String.html">String</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>out_vec</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>file_pattern</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>resource_group</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>enumerate the files in <em>resource_group</em> that match <em>file_pattern</em> and append thier names to <em>out_vec</em> </p>

<p>Reimplemented from <a class="el" href="classCEGUI_1_1DefaultResourceProvider.html#a848b1cb719e9a4492cce165c54b9e11d">CEGUI::DefaultResourceProvider</a>.</p>

</div>
</div>
<a class="anchor" id="a9f9b07679cbd33620907f6aad03a956e"></a><!-- doxytag: member="CEGUI::MinizipResourceProvider::loadRawDataContainer" ref="a9f9b07679cbd33620907f6aad03a956e" args="(const String &amp;filename, RawDataContainer &amp;output, const String &amp;resourceGroup)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::MinizipResourceProvider::loadRawDataContainer </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classCEGUI_1_1RawDataContainer.html">RawDataContainer</a> &amp;&#160;</td>
          <td class="paramname"><em>output</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>resourceGroup</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Load XML data using InputSource objects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing a filename of the resource to be loaded.</td></tr>
    <tr><td class="paramname">output</td><td>Reference to a InputSourceContainer object to load the data into.</td></tr>
  </table>
  </dd>
</dl>
<p>Load raw binary data.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> containing a filename of the resource to be loaded.</td></tr>
    <tr><td class="paramname">output</td><td>Reference to a <a class="el" href="classCEGUI_1_1RawDataContainer.html" title="Class used as the databuffer for loading files throughout the library.">RawDataContainer</a> object to load the data into.</td></tr>
    <tr><td class="paramname">resourceGroup</td><td>Optional <a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> that may be used by implementations to identify the group from which the resource should be loaded. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classCEGUI_1_1DefaultResourceProvider.html#ad20525fb4a3d06b9c2abff417ce3f783">CEGUI::DefaultResourceProvider</a>.</p>

</div>
</div>
<a class="anchor" id="a38d793fe7b7830bdf04bea706cb46438"></a><!-- doxytag: member="CEGUI::MinizipResourceProvider::setArchive" ref="a38d793fe7b7830bdf04bea706cb46438" args="(const String &amp;archive)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CEGUI::MinizipResourceProvider::setArchive </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>archive</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>sets the archive from which files are retrieved. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">archive</td><td>The filepath to the archive </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 for Crazy Eddies GUI System by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>