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
|
<!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::LibxmlParser 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 <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 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 List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class 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_1LibxmlParser.html">LibxmlParser</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::LibxmlParser Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::LibxmlParser" --><!-- doxytag: inherits="CEGUI::XMLParser" -->
<p>Implementation of <a class="el" href="classCEGUI_1_1XMLParser.html" title="This is an abstract class that is used by CEGUI to interface with XML parser libraries.">XMLParser</a> using libxml.
<a href="classCEGUI_1_1LibxmlParser.html#details">More...</a></p>
<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::LibxmlParser:</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_1LibxmlParser__inherit__graph.gif" border="0" usemap="#CEGUI_1_1LibxmlParser_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1LibxmlParser_inherit__map" id="CEGUI_1_1LibxmlParser_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1XMLParser.html" title="This is an abstract class that is used by CEGUI to interface with XML parser libraries." alt="" coords="11,83,149,112"/><area shape="rect" id="node4" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects." alt="" coords="9,5,151,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::LibxmlParser:</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_1LibxmlParser__coll__graph.gif" border="0" usemap="#CEGUI_1_1LibxmlParser_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1LibxmlParser_coll__map" id="CEGUI_1_1LibxmlParser_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1XMLParser.html" title="This is an abstract class that is used by CEGUI to interface with XML parser libraries." alt="" coords="80,101,219,131"/><area shape="rect" id="node4" href="classCEGUI_1_1PropertySet.html" title="Class that contains a collection of Property objects." alt="" coords="5,5,147,35"/><area shape="rect" id="node6" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="171,5,277,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1LibxmlParser-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LibxmlParser.html#a755b73e7a9e1a192585b073c2897a396">parseXMLFile</a> (<a class="el" href="classCEGUI_1_1XMLHandler.html">XMLHandler</a> &handler, const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, const <a class="el" href="classCEGUI_1_1String.html">String</a> &schemaName, const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">abstract method which initiates parsing of an XML file. <a href="#a755b73e7a9e1a192585b073c2897a396"></a><br/></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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LibxmlParser.html#a59855f0abd34f215e4df8a709cb47ba8">initialiseImpl</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">abstract method which initialises the <a class="el" href="classCEGUI_1_1XMLParser.html" title="This is an abstract class that is used by CEGUI to interface with XML parser libraries.">XMLParser</a> ready for use. <a href="#a59855f0abd34f215e4df8a709cb47ba8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1LibxmlParser.html#a5741083b1eaf4fddab2bb54bbdeb5ad2">cleanupImpl</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">abstract method which cleans up the <a class="el" href="classCEGUI_1_1XMLParser.html" title="This is an abstract class that is used by CEGUI to interface with XML parser libraries.">XMLParser</a> after use. <a href="#a5741083b1eaf4fddab2bb54bbdeb5ad2"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Implementation of <a class="el" href="classCEGUI_1_1XMLParser.html" title="This is an abstract class that is used by CEGUI to interface with XML parser libraries.">XMLParser</a> using libxml. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5741083b1eaf4fddab2bb54bbdeb5ad2"></a><!-- doxytag: member="CEGUI::LibxmlParser::cleanupImpl" ref="a5741083b1eaf4fddab2bb54bbdeb5ad2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LibxmlParser::cleanupImpl </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>abstract method which cleans up the <a class="el" href="classCEGUI_1_1XMLParser.html" title="This is an abstract class that is used by CEGUI to interface with XML parser libraries.">XMLParser</a> after use. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1XMLParser.html#aed35df1a5792551da4fb8b6297185db8">CEGUI::XMLParser</a>.</p>
</div>
</div>
<a class="anchor" id="a59855f0abd34f215e4df8a709cb47ba8"></a><!-- doxytag: member="CEGUI::LibxmlParser::initialiseImpl" ref="a59855f0abd34f215e4df8a709cb47ba8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::LibxmlParser::initialiseImpl </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>abstract method which initialises the <a class="el" href="classCEGUI_1_1XMLParser.html" title="This is an abstract class that is used by CEGUI to interface with XML parser libraries.">XMLParser</a> ready for use. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if the module initialised successfully.</li>
<li>false if the module initialisation failed. </li>
</ul>
</dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1XMLParser.html#ae0eb6627c82a52e1f5d234ce3dafc6ac">CEGUI::XMLParser</a>.</p>
</div>
</div>
<a class="anchor" id="a755b73e7a9e1a192585b073c2897a396"></a><!-- doxytag: member="CEGUI::LibxmlParser::parseXMLFile" ref="a755b73e7a9e1a192585b073c2897a396" args="(XMLHandler &handler, const String &filename, const String &schemaName, const String &resourceGroup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::LibxmlParser::parseXMLFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1XMLHandler.html">XMLHandler</a> & </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>schemaName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>resourceGroup</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>abstract method which initiates parsing of an XML file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td><a class="el" href="classCEGUI_1_1XMLHandler.html">XMLHandler</a> based object which will process the XML elements.</td></tr>
<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> object holding the filename of the XML file to be parsed.</td></tr>
<tr><td class="paramname">schemaName</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the name of the XML schema file to use for validating the XML. Note that whether this is used or not is dependant upon the <a class="el" href="classCEGUI_1_1XMLParser.html" title="This is an abstract class that is used by CEGUI to interface with XML parser libraries.">XMLParser</a> in use.</td></tr>
<tr><td class="paramname">resourceGroup</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding the resource group identifier which will be passed to the <a class="el" href="classCEGUI_1_1ResourceProvider.html" title="Abstract class that defines the required interface for all resource provider sub-classes.">ResourceProvider</a> when loading the XML and schema files.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1XMLParser.html#ad14588610a5b3e85284431c881012720">CEGUI::XMLParser</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 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>
|
