/usr/share/doc/libjuce/apiref/classXmlDocument.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: XmlDocument Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classXmlDocument-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XmlDocument Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Parses a text-based XML document and creates an <a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> object from it.
<a href="classXmlDocument.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a87ad794c62c8ee9ac78961af99b2f30d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXmlDocument.html#a87ad794c62c8ee9ac78961af99b2f30d">XmlDocument</a> (const <a class="el" href="classString.html">String</a> &documentText)</td></tr>
<tr class="memdesc:a87ad794c62c8ee9ac78961af99b2f30d"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classXmlDocument.html" title="Parses a text-based XML document and creates an XmlElement object from it. ">XmlDocument</a> from the xml text. <a href="#a87ad794c62c8ee9ac78961af99b2f30d">More...</a><br /></td></tr>
<tr class="separator:a87ad794c62c8ee9ac78961af99b2f30d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bb84c6d5a591e3ab53199b081766901"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXmlDocument.html#a0bb84c6d5a591e3ab53199b081766901">XmlDocument</a> (const <a class="el" href="classFile.html">File</a> &file)</td></tr>
<tr class="memdesc:a0bb84c6d5a591e3ab53199b081766901"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classXmlDocument.html" title="Parses a text-based XML document and creates an XmlElement object from it. ">XmlDocument</a> from a file. <a href="#a0bb84c6d5a591e3ab53199b081766901">More...</a><br /></td></tr>
<tr class="separator:a0bb84c6d5a591e3ab53199b081766901"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab18742228f580a5e4ec87e4b39c8a68c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXmlDocument.html#ab18742228f580a5e4ec87e4b39c8a68c">~XmlDocument</a> ()</td></tr>
<tr class="memdesc:ab18742228f580a5e4ec87e4b39c8a68c"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab18742228f580a5e4ec87e4b39c8a68c">More...</a><br /></td></tr>
<tr class="separator:ab18742228f580a5e4ec87e4b39c8a68c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95252ae0d6c2f228065d5503507b0131"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXmlElement.html">XmlElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXmlDocument.html#a95252ae0d6c2f228065d5503507b0131">getDocumentElement</a> (bool onlyReadOuterDocumentElement=false)</td></tr>
<tr class="memdesc:a95252ae0d6c2f228065d5503507b0131"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> object to represent the main document node. <a href="#a95252ae0d6c2f228065d5503507b0131">More...</a><br /></td></tr>
<tr class="separator:a95252ae0d6c2f228065d5503507b0131"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54a186bd3e51c86b7c9a7edbcfe97bc7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classXmlDocument.html#a54a186bd3e51c86b7c9a7edbcfe97bc7">getLastParseError</a> () const noexcept</td></tr>
<tr class="memdesc:a54a186bd3e51c86b7c9a7edbcfe97bc7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parsing error that occurred the last time getDocumentElement was called. <a href="#a54a186bd3e51c86b7c9a7edbcfe97bc7">More...</a><br /></td></tr>
<tr class="separator:a54a186bd3e51c86b7c9a7edbcfe97bc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa89d5cf6602e6d3d1506f36fd17e3c3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXmlDocument.html#aa89d5cf6602e6d3d1506f36fd17e3c3c">setInputSource</a> (<a class="el" href="classInputSource.html">InputSource</a> *newSource) noexcept</td></tr>
<tr class="memdesc:aa89d5cf6602e6d3d1506f36fd17e3c3c"><td class="mdescLeft"> </td><td class="mdescRight">Sets an input source object to use for parsing documents that reference external entities. <a href="#aa89d5cf6602e6d3d1506f36fd17e3c3c">More...</a><br /></td></tr>
<tr class="separator:aa89d5cf6602e6d3d1506f36fd17e3c3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96421df16677c4e4c838383516d37f28"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXmlDocument.html#a96421df16677c4e4c838383516d37f28">setEmptyTextElementsIgnored</a> (bool shouldBeIgnored) noexcept</td></tr>
<tr class="memdesc:a96421df16677c4e4c838383516d37f28"><td class="mdescLeft"> </td><td class="mdescRight">Sets a flag to change the treatment of empty text elements. <a href="#a96421df16677c4e4c838383516d37f28">More...</a><br /></td></tr>
<tr class="separator:a96421df16677c4e4c838383516d37f28"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ae14f9fc62e978ce7246922a84a568f20"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classXmlElement.html">XmlElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXmlDocument.html#ae14f9fc62e978ce7246922a84a568f20">parse</a> (const <a class="el" href="classFile.html">File</a> &file)</td></tr>
<tr class="memdesc:ae14f9fc62e978ce7246922a84a568f20"><td class="mdescLeft"> </td><td class="mdescRight">A handy static method that parses a file. <a href="#ae14f9fc62e978ce7246922a84a568f20">More...</a><br /></td></tr>
<tr class="separator:ae14f9fc62e978ce7246922a84a568f20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a359a74301cbb56b9cbbaa635a4bf66bf"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classXmlElement.html">XmlElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXmlDocument.html#a359a74301cbb56b9cbbaa635a4bf66bf">parse</a> (const <a class="el" href="classString.html">String</a> &xmlData)</td></tr>
<tr class="memdesc:a359a74301cbb56b9cbbaa635a4bf66bf"><td class="mdescLeft"> </td><td class="mdescRight">A handy static method that parses some XML data. <a href="#a359a74301cbb56b9cbbaa635a4bf66bf">More...</a><br /></td></tr>
<tr class="separator:a359a74301cbb56b9cbbaa635a4bf66bf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parses a text-based XML document and creates an <a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> object from it. </p>
<p>The parser will parse DTDs to load external entities but won't check the document for validity against the DTD.</p>
<p>e.g. </p><div class="fragment"><div class="line"><a class="code" href="classXmlDocument.html">XmlDocument</a> myDocument (<a class="code" href="classFile.html">File</a> (<span class="stringliteral">"myfile.xml"</span>));</div><div class="line"><a class="code" href="classScopedPointer.html">ScopedPointer<XmlElement></a> mainElement (myDocument.getDocumentElement());</div><div class="line"></div><div class="line"><span class="keywordflow">if</span> (mainElement == <span class="keyword">nullptr</span>)</div><div class="line">{</div><div class="line"> <a class="code" href="classString.html">String</a> error = myDocument.getLastParseError();</div><div class="line">}</div><div class="line"><span class="keywordflow">else</span></div><div class="line">{</div><div class="line"> ..use the element</div><div class="line">}</div></div><!-- fragment --><p>Or you can use the static helper methods for quick parsing..</p>
<div class="fragment"><div class="line"><a class="code" href="classScopedPointer.html">ScopedPointer<XmlElement></a> xml (<a class="code" href="classXmlDocument.html#ae14f9fc62e978ce7246922a84a568f20">XmlDocument::parse</a> (myXmlFile));</div><div class="line"></div><div class="line"><span class="keywordflow">if</span> (xml != <span class="keyword">nullptr</span> && xml->hasTagName (<span class="stringliteral">"foobar"</span>))</div><div class="line">{</div><div class="line"> ...etc</div></div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a87ad794c62c8ee9ac78961af99b2f30d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87ad794c62c8ee9ac78961af99b2f30d">§ </a></span>XmlDocument() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XmlDocument::XmlDocument </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>documentText</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <a class="el" href="classXmlDocument.html" title="Parses a text-based XML document and creates an XmlElement object from it. ">XmlDocument</a> from the xml text. </p>
<p>The text doesn't actually get parsed until the <a class="el" href="classXmlDocument.html#a95252ae0d6c2f228065d5503507b0131" title="Creates an XmlElement object to represent the main document node. ">getDocumentElement()</a> method is called. </p>
</div>
</div>
<a id="a0bb84c6d5a591e3ab53199b081766901"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bb84c6d5a591e3ab53199b081766901">§ </a></span>XmlDocument() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XmlDocument::XmlDocument </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <a class="el" href="classXmlDocument.html" title="Parses a text-based XML document and creates an XmlElement object from it. ">XmlDocument</a> from a file. </p>
<p>The text doesn't actually get parsed until the <a class="el" href="classXmlDocument.html#a95252ae0d6c2f228065d5503507b0131" title="Creates an XmlElement object to represent the main document node. ">getDocumentElement()</a> method is called. </p>
</div>
</div>
<a id="ab18742228f580a5e4ec87e4b39c8a68c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab18742228f580a5e4ec87e4b39c8a68c">§ </a></span>~XmlDocument()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XmlDocument::~XmlDocument </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a95252ae0d6c2f228065d5503507b0131"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95252ae0d6c2f228065d5503507b0131">§ </a></span>getDocumentElement()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXmlElement.html">XmlElement</a>* XmlDocument::getDocumentElement </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>onlyReadOuterDocumentElement</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> object to represent the main document node. </p>
<p>This method will do the actual parsing of the text, and if there's a parse error, it may returns nullptr (and you can find out the error using the <a class="el" href="classXmlDocument.html#a54a186bd3e51c86b7c9a7edbcfe97bc7" title="Returns the parsing error that occurred the last time getDocumentElement was called. ">getLastParseError()</a> method).</p>
<p>See also the <a class="el" href="classXmlDocument.html#ae14f9fc62e978ce7246922a84a568f20" title="A handy static method that parses a file. ">parse()</a> methods, which provide a shorthand way to quickly parse a file or string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">onlyReadOuterDocumentElement</td><td>if true, the parser will only read the first section of the file, and will only return the outer document element - this allows quick checking of large files to see if they contain the correct type of tag, without having to parse the entire file </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new <a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> which the caller will need to delete, or null if there was an error. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classXmlDocument.html#a54a186bd3e51c86b7c9a7edbcfe97bc7" title="Returns the parsing error that occurred the last time getDocumentElement was called. ">getLastParseError</a> </dd></dl>
</div>
</div>
<a id="a54a186bd3e51c86b7c9a7edbcfe97bc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54a186bd3e51c86b7c9a7edbcfe97bc7">§ </a></span>getLastParseError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classString.html">String</a>& XmlDocument::getLastParseError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the parsing error that occurred the last time getDocumentElement was called. </p>
<dl class="section return"><dt>Returns</dt><dd>the error, or an empty string if there was no error. </dd></dl>
</div>
</div>
<a id="aa89d5cf6602e6d3d1506f36fd17e3c3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa89d5cf6602e6d3d1506f36fd17e3c3c">§ </a></span>setInputSource()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XmlDocument::setInputSource </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classInputSource.html">InputSource</a> * </td>
<td class="paramname"><em>newSource</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets an input source object to use for parsing documents that reference external entities. </p>
<p>If the document has been created from a file, this probably won't be needed, but if you're parsing some text and there might be a DTD that references external files, you may need to create a custom input source that can retrieve the other files it needs.</p>
<p>The object that is passed-in will be deleted automatically when no longer needed.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classInputSource.html" title="A lightweight object that can create a stream to read some kind of resource. ">InputSource</a> </dd></dl>
</div>
</div>
<a id="a96421df16677c4e4c838383516d37f28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96421df16677c4e4c838383516d37f28">§ </a></span>setEmptyTextElementsIgnored()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void XmlDocument::setEmptyTextElementsIgnored </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shouldBeIgnored</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a flag to change the treatment of empty text elements. </p>
<p>If this is true (the default state), then any text elements that contain only whitespace characters will be ingored during parsing. If you need to catch whitespace-only text, then you should set this to false before calling the <a class="el" href="classXmlDocument.html#a95252ae0d6c2f228065d5503507b0131" title="Creates an XmlElement object to represent the main document node. ">getDocumentElement()</a> method. </p>
</div>
</div>
<a id="ae14f9fc62e978ce7246922a84a568f20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae14f9fc62e978ce7246922a84a568f20">§ </a></span>parse() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classXmlElement.html">XmlElement</a>* XmlDocument::parse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A handy static method that parses a file. </p>
<p>This is a shortcut for creating an <a class="el" href="classXmlDocument.html" title="Parses a text-based XML document and creates an XmlElement object from it. ">XmlDocument</a> object and calling <a class="el" href="classXmlDocument.html#a95252ae0d6c2f228065d5503507b0131" title="Creates an XmlElement object to represent the main document node. ">getDocumentElement()</a> on it. </p><dl class="section return"><dt>Returns</dt><dd>a new <a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> which the caller will need to delete, or null if there was an error. </dd></dl>
</div>
</div>
<a id="a359a74301cbb56b9cbbaa635a4bf66bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a359a74301cbb56b9cbbaa635a4bf66bf">§ </a></span>parse() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classXmlElement.html">XmlElement</a>* XmlDocument::parse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>xmlData</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A handy static method that parses some XML data. </p>
<p>This is a shortcut for creating an <a class="el" href="classXmlDocument.html" title="Parses a text-based XML document and creates an XmlElement object from it. ">XmlDocument</a> object and calling <a class="el" href="classXmlDocument.html#a95252ae0d6c2f228065d5503507b0131" title="Creates an XmlElement object to represent the main document node. ">getDocumentElement()</a> on it. </p><dl class="section return"><dt>Returns</dt><dd>a new <a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> which the caller will need to delete, or null if there was an error. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__XmlDocument_8h.html">juce_XmlDocument.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|