<!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>libxml++: xmlpp::DomParser 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.2 -->
<div class="navigation" id="top">
<div 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>
</ul>
</div>
<div 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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespacexmlpp.html">xmlpp</a> </li>
<li><a class="el" href="classxmlpp_1_1DomParser.html">DomParser</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> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>xmlpp::DomParser Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="xmlpp::DomParser" --><!-- doxytag: inherits="xmlpp::Parser" -->
<p>DOM XML parser. <a href="#_details">More...</a></p>
<p><code>#include <libxml++/parsers/domparser.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for xmlpp::DomParser:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classxmlpp_1_1DomParser__inherit__graph.png" border="0" usemap="#xmlpp_1_1DomParser_inherit__map" alt="Inheritance graph"/></div>
<map name="xmlpp_1_1DomParser_inherit__map" id="xmlpp_1_1DomParser_inherit__map">
<area shape="rect" id="node2" href="classxmlpp_1_1Parser.html" title="XML parser." alt="" coords="25,86,127,117"/><area shape="rect" id="node4" href="classxmlpp_1_1NonCopyable.html" title="Herited by classes which cannot be copied." alt="" coords="5,6,147,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<!-- startSectionHeader --><div class="dynheader">
Collaboration diagram for xmlpp::DomParser:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classxmlpp_1_1DomParser__coll__graph.png" border="0" usemap="#xmlpp_1_1DomParser_coll__map" alt="Collaboration graph"/></div>
<map name="xmlpp_1_1DomParser_coll__map" id="xmlpp_1_1DomParser_coll__map">
<area shape="rect" id="node2" href="classxmlpp_1_1Parser.html" title="XML parser." alt="" coords="152,209,253,239"/><area shape="rect" id="node4" href="classxmlpp_1_1NonCopyable.html" title="Herited by classes which cannot be copied." alt="" coords="7,107,148,138"/><area shape="rect" id="node13" href="classxmlpp_1_1Document.html" title="Represents an XML document in the DOM model." alt="" coords="5,209,128,239"/><area shape="rect" id="node6" href="classxmlpp_1_1exception.html" title="Base class for all xmlpp exceptions." alt="" coords="328,107,448,138"/><area shape="rect" id="node8" href="classstd_1_1exception.html" title="std::exception" alt="" coords="336,6,440,37"/><area shape="rect" id="node10" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html" title="Glib::ustring" alt="" coords="188,6,279,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classxmlpp_1_1DomParser-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#abeab430d4863459b6d03fc7e97363df5">DomParser</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#a9538baed354098e8ac73f69e1d4f55e5">DomParser</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& filename, bool validate=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate the parser and parse a document immediately. <a href="#a9538baed354098e8ac73f69e1d4f55e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#a3a18958b3980fb3ff44441868da7cb6a">~DomParser</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#a437c91bb64033669649d91f28ecc7dc9">parse_file</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse an XML document from a file. <a href="#a437c91bb64033669649d91f28ecc7dc9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#a2110398d5a19320e7bbe65e0edb2ab9c">parse_memory</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& contents)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse an XML document from a string. <a href="#a2110398d5a19320e7bbe65e0edb2ab9c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#aae7bd491f8aae685900bec03ec43d855">parse_memory_raw</a> (const unsigned char* contents, <a class="el" href="classxmlpp_1_1Parser.html#a8e7c797006bb5398629cf98f4141e3e6">size_type</a> bytes_count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse an XML document from raw memory. <a href="#aae7bd491f8aae685900bec03ec43d855"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#a3d02d6c5b4194b47118e92a8e258743c">parse_stream</a> (std::istream& in)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse an XML document from a stream. <a href="#a3d02d6c5b4194b47118e92a8e258743c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#af6455076d91fc65e39f82e9a6c7ad764">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test whether a document has been parsed. <a href="#af6455076d91fc65e39f82e9a6c7ad764"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classxmlpp_1_1Document.html">Document</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#ad10907d495f9e1e2b63638a9c69f78a8">get_document</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classxmlpp_1_1Document.html">Document</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#a4a3452e46cf656998d8752ed949239de">get_document</a> () const </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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#a0f77c8ab0a9ab2d7abd809846ae75d6f">parse_context</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#a58a312db2834a41a77ca290dc6dc48fe">release_underlying</a> ()</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="el" href="classxmlpp_1_1Document.html">Document</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1DomParser.html#ab95c1209f2311df8fe1f1f34651d2d28">doc_</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>DOM XML parser. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abeab430d4863459b6d03fc7e97363df5"></a><!-- doxytag: member="xmlpp::DomParser::DomParser" ref="abeab430d4863459b6d03fc7e97363df5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlpp::DomParser::DomParser </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9538baed354098e8ac73f69e1d4f55e5"></a><!-- doxytag: member="xmlpp::DomParser::DomParser" ref="a9538baed354098e8ac73f69e1d4f55e5" args="(const Glib::ustring &filename, bool validate=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlpp::DomParser::DomParser </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>validate</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instantiate the parser and parse a document immediately. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">exception</td><td></td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>The path to the file. </td></tr>
<tr><td class="paramname">validate</td><td>Whether the parser should validate the XML. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3a18958b3980fb3ff44441868da7cb6a"></a><!-- doxytag: member="xmlpp::DomParser::~DomParser" ref="a3a18958b3980fb3ff44441868da7cb6a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xmlpp::DomParser::~DomParser </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad10907d495f9e1e2b63638a9c69f78a8"></a><!-- doxytag: member="xmlpp::DomParser::get_document" ref="ad10907d495f9e1e2b63638a9c69f78a8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classxmlpp_1_1Document.html">Document</a>* xmlpp::DomParser::get_document </td>
<td>(</td>
<td class="paramname"> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4a3452e46cf656998d8752ed949239de"></a><!-- doxytag: member="xmlpp::DomParser::get_document" ref="a4a3452e46cf656998d8752ed949239de" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classxmlpp_1_1Document.html">Document</a>* xmlpp::DomParser::get_document </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af6455076d91fc65e39f82e9a6c7ad764"></a><!-- doxytag: member="xmlpp::DomParser::operator bool" ref="af6455076d91fc65e39f82e9a6c7ad764" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlpp::DomParser::operator bool </td>
<td>(</td>
<td class="paramname"> )</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test whether a document has been parsed. </p>
</div>
</div>
<a class="anchor" id="a0f77c8ab0a9ab2d7abd809846ae75d6f"></a><!-- doxytag: member="xmlpp::DomParser::parse_context" ref="a0f77c8ab0a9ab2d7abd809846ae75d6f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::DomParser::parse_context </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a437c91bb64033669649d91f28ecc7dc9"></a><!-- doxytag: member="xmlpp::DomParser::parse_file" ref="a437c91bb64033669649d91f28ecc7dc9" args="(const Glib::ustring &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::DomParser::parse_file </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>filename</em> )</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse an XML document from a file. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">exception</td><td></td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>The path to the file. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classxmlpp_1_1Parser.html#ad0855eff9a35a9160800ad58ad19fd7e">xmlpp::Parser</a>.</p>
</div>
</div>
<a class="anchor" id="a2110398d5a19320e7bbe65e0edb2ab9c"></a><!-- doxytag: member="xmlpp::DomParser::parse_memory" ref="a2110398d5a19320e7bbe65e0edb2ab9c" args="(const Glib::ustring &contents)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::DomParser::parse_memory </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>contents</em> )</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse an XML document from a string. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">exception</td><td></td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">contents</td><td>The XML document as a string. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classxmlpp_1_1Parser.html#abbbf646035570f1aa5366558dfc2ae01">xmlpp::Parser</a>.</p>
</div>
</div>
<a class="anchor" id="aae7bd491f8aae685900bec03ec43d855"></a><!-- doxytag: member="xmlpp::DomParser::parse_memory_raw" ref="aae7bd491f8aae685900bec03ec43d855" args="(const unsigned char *contents, size_type bytes_count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xmlpp::DomParser::parse_memory_raw </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"> <em>contents</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxmlpp_1_1Parser.html#a8e7c797006bb5398629cf98f4141e3e6">size_type</a> </td>
<td class="paramname"> <em>bytes_count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse an XML document from raw memory. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">exception</td><td></td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">contents</td><td>The XML document as an array of bytes. </td></tr>
<tr><td class="paramname">bytes_count</td><td>The number of bytes in the <em>contents</em> array. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3d02d6c5b4194b47118e92a8e258743c"></a><!-- doxytag: member="xmlpp::DomParser::parse_stream" ref="a3d02d6c5b4194b47118e92a8e258743c" args="(std::istream &in)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::DomParser::parse_stream </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"> <em>in</em> )</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse an XML document from a stream. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">exception</td><td></td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>The stream. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classxmlpp_1_1Parser.html#ad7134b1c68308351785acb0302aa54db">xmlpp::Parser</a>.</p>
</div>
</div>
<a class="anchor" id="a58a312db2834a41a77ca290dc6dc48fe"></a><!-- doxytag: member="xmlpp::DomParser::release_underlying" ref="a58a312db2834a41a77ca290dc6dc48fe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::DomParser::release_underlying </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classxmlpp_1_1Parser.html#a346ebfb1219e1c0d3acbd017a07706e6">xmlpp::Parser</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab95c1209f2311df8fe1f1f34651d2d28"></a><!-- doxytag: member="xmlpp::DomParser::doc_" ref="ab95c1209f2311df8fe1f1f34651d2d28" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classxmlpp_1_1Document.html">Document</a>* <a class="el" href="classxmlpp_1_1DomParser.html#ab95c1209f2311df8fe1f1f34651d2d28">xmlpp::DomParser::doc_</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>parsers/domparser.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Feb 11 2011 16:08:50 for libxml++ by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
