<!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::SaxParser 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_1SaxParser.html">SaxParser</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>xmlpp::SaxParser Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="xmlpp::SaxParser" --><!-- doxytag: inherits="xmlpp::Parser" -->
<p>SAX XML parser. <a href="#_details">More...</a></p>
<p><code>#include <libxml++/parsers/saxparser.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for xmlpp::SaxParser:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classxmlpp_1_1SaxParser__inherit__graph.png" border="0" usemap="#xmlpp_1_1SaxParser_inherit__map" alt="Inheritance graph"/></div>
<map name="xmlpp_1_1SaxParser_inherit__map" id="xmlpp_1_1SaxParser_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::SaxParser:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classxmlpp_1_1SaxParser__coll__graph.png" border="0" usemap="#xmlpp_1_1SaxParser_coll__map" alt="Collaboration graph"/></div>
<map name="xmlpp_1_1SaxParser_coll__map" id="xmlpp_1_1SaxParser_coll__map">
<area shape="rect" id="node2" href="classxmlpp_1_1Parser.html" title="XML parser." alt="" coords="155,209,256,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_1SaxParser-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxmlpp_1_1SaxParser_1_1Attribute.html">Attribute</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Simple structure used in the start_element callback, in which the attributes are a list of name/value pairs. <a href="structxmlpp_1_1SaxParser_1_1Attribute.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structxmlpp_1_1SaxParser_1_1AttributeHasName.html">AttributeHasName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This functor is a helper to find an attribute by name in an AttributeList using the standard algorithm std::find_if. <a href="structxmlpp_1_1SaxParser_1_1AttributeHasName.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef std::deque< <a class="el" href="structxmlpp_1_1SaxParser_1_1Attribute.html">Attribute</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#a1cb4e32dd3adf2460f2836bddb59633c">AttributeList</a></td></tr>
<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_1SaxParser.html#a66bfaafc79c00197010f8d22b2a39df8">SaxParser</a> (bool use_get_entity=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#a3f69d5fe3472240225dd46f8c70a4e79">~SaxParser</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_1SaxParser.html#ac2b0cf0069a73fa92c80f6d455923698">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="#ac2b0cf0069a73fa92c80f6d455923698"></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_1SaxParser.html#ab9367c59f02e0db5a2b17cd48ddf74f9">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="#ab9367c59f02e0db5a2b17cd48ddf74f9"></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_1SaxParser.html#aff9643a2764f6d8caee0307abbfcca25">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="#aff9643a2764f6d8caee0307abbfcca25"></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_1SaxParser.html#aaa731e56f99aa7f8313a1f096389f723">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="#aaa731e56f99aa7f8313a1f096389f723"></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_1SaxParser.html#a24b4440b0539a0015890182b35396b5d">parse_chunk</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& chunk)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse a chunk of data. <a href="#a24b4440b0539a0015890182b35396b5d"></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_1SaxParser.html#a501a19205773ac1c843d6007b189860e">parse_chunk_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 a chunk of data. <a href="#a501a19205773ac1c843d6007b189860e"></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_1SaxParser.html#ac540859149b064cfce87931ba736f3c5">finish_chunk_parsing</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finish a chunk-wise parse. <a href="#ac540859149b064cfce87931ba736f3c5"></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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#a0a33932c84e245284414003f668b829f">on_start_document</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_1SaxParser.html#aa7b3090025892829af91f8c51a06ef7b">on_end_document</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_1SaxParser.html#a1496022dd6b58d9af6a4a7a703830a84">on_start_element</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, const <a class="el" href="classxmlpp_1_1SaxParser.html#a1cb4e32dd3adf2460f2836bddb59633c">AttributeList</a>& attributes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#a5c1c00b47c020e3cd8d623361c6909fa">on_end_element</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#a359b48ea1c15cb39837f680a1f2fb2c2">on_characters</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& characters)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#acccf558fc47549bdad076201193739f3">on_comment</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#ab951160501bf3e78901691a79e3d11e8">on_warning</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#a38c3c5f9bad26030acee20d7ddf4936a">on_error</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#ad951cc2b1fe314805c5d735a0d7f467c">on_fatal_error</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#af6671ab7dbda78730a65dcbb58aa0ec1">on_cdata_block</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#a4b453817ac37ea307c2ba023cc938794">on_internal_subset</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& publicId, const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& systemId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Override this to receive information about the document's DTD and any entity declarations. <a href="#a4b453817ac37ea307c2ba023cc938794"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual _xmlEntity* </td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1SaxParser.html#aeb20c4424f325655ebd787c2b2268137">on_get_entity</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Override this method to resolve entities references in your derived parser, instead of using the default entity resolution, or to be informed when entity references are encountered. <a href="#aeb20c4424f325655ebd787c2b2268137"></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_1SaxParser.html#ab0985199cbdbd9a7ab31b024acf3c2c8">on_entity_declaration</a> (const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name, <a class="el" href="namespacexmlpp.html#a0fa47f0fb103cf9ea460a2fef3f5be49">XmlEntityType</a> type, const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& publicId, const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& systemId, const <a class="elRef" href="file:///usr/share/doc/glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& content)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Override this to receive information about every entity declaration. <a href="#ab0985199cbdbd9a7ab31b024acf3c2c8"></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_1SaxParser.html#a839554028d8bad81774040eb67d23103">release_underlying</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>SAX XML parser. </p>
<p>Derive your own class and override the on_*() methods. </p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a1cb4e32dd3adf2460f2836bddb59633c"></a><!-- doxytag: member="xmlpp::SaxParser::AttributeList" ref="a1cb4e32dd3adf2460f2836bddb59633c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::deque< <a class="el" href="structxmlpp_1_1SaxParser_1_1Attribute.html">Attribute</a> > <a class="el" href="classxmlpp_1_1SaxParser.html#a1cb4e32dd3adf2460f2836bddb59633c">xmlpp::SaxParser::AttributeList</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a66bfaafc79c00197010f8d22b2a39df8"></a><!-- doxytag: member="xmlpp::SaxParser::SaxParser" ref="a66bfaafc79c00197010f8d22b2a39df8" args="(bool use_get_entity=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlpp::SaxParser::SaxParser </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>use_get_entity</em> = <code>false</code> )</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">use_get_entity</td><td>Set this to true if you will override <a class="el" href="classxmlpp_1_1SaxParser.html#aeb20c4424f325655ebd787c2b2268137" title="Override this method to resolve entities references in your derived parser, instead of using the defa...">on_get_entity()</a>. In theory, if you do not override <a class="el" href="classxmlpp_1_1SaxParser.html#aeb20c4424f325655ebd787c2b2268137" title="Override this method to resolve entities references in your derived parser, instead of using the defa...">on_get_entity()</a> the parser should behave exactly the same whether you use true or false here. But the default implementation of <a class="el" href="classxmlpp_1_1SaxParser.html#aeb20c4424f325655ebd787c2b2268137" title="Override this method to resolve entities references in your derived parser, instead of using the defa...">on_get_entity()</a>, needed if you override <a class="el" href="classxmlpp_1_1SaxParser.html#aeb20c4424f325655ebd787c2b2268137" title="Override this method to resolve entities references in your derived parser, instead of using the defa...">on_get_entity()</a> might not have the same behaviour as the underlying default behaviour of libxml, so the libxml implementation is the default here. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3f69d5fe3472240225dd46f8c70a4e79"></a><!-- doxytag: member="xmlpp::SaxParser::~SaxParser" ref="a3f69d5fe3472240225dd46f8c70a4e79" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual xmlpp::SaxParser::~SaxParser </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="ac540859149b064cfce87931ba736f3c5"></a><!-- doxytag: member="xmlpp::SaxParser::finish_chunk_parsing" ref="ac540859149b064cfce87931ba736f3c5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::finish_chunk_parsing </td>
<td>(</td>
<td class="paramname"> )</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finish a chunk-wise parse. </p>
<p>Call this after the last call to <a class="el" href="classxmlpp_1_1SaxParser.html#a24b4440b0539a0015890182b35396b5d" title="Parse a chunk of data.">parse_chunk()</a>. Don't use this function with the other parsing methods. </p>
</div>
</div>
<a class="anchor" id="af6671ab7dbda78730a65dcbb58aa0ec1"></a><!-- doxytag: member="xmlpp::SaxParser::on_cdata_block" ref="af6671ab7dbda78730a65dcbb58aa0ec1" args="(const Glib::ustring &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_cdata_block </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>text</em> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a359b48ea1c15cb39837f680a1f2fb2c2"></a><!-- doxytag: member="xmlpp::SaxParser::on_characters" ref="a359b48ea1c15cb39837f680a1f2fb2c2" args="(const Glib::ustring &characters)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_characters </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>characters</em> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acccf558fc47549bdad076201193739f3"></a><!-- doxytag: member="xmlpp::SaxParser::on_comment" ref="acccf558fc47549bdad076201193739f3" args="(const Glib::ustring &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_comment </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>text</em> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa7b3090025892829af91f8c51a06ef7b"></a><!-- doxytag: member="xmlpp::SaxParser::on_end_document" ref="aa7b3090025892829af91f8c51a06ef7b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_end_document </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="a5c1c00b47c020e3cd8d623361c6909fa"></a><!-- doxytag: member="xmlpp::SaxParser::on_end_element" ref="a5c1c00b47c020e3cd8d623361c6909fa" args="(const Glib::ustring &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_end_element </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>name</em> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab0985199cbdbd9a7ab31b024acf3c2c8"></a><!-- doxytag: member="xmlpp::SaxParser::on_entity_declaration" ref="ab0985199cbdbd9a7ab31b024acf3c2c8" args="(const Glib::ustring &name, XmlEntityType type, const Glib::ustring &publicId, const Glib::ustring &systemId, const Glib::ustring &content)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_entity_declaration </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>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacexmlpp.html#a0fa47f0fb103cf9ea460a2fef3f5be49">XmlEntityType</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>publicId</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>systemId</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>content</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Override this to receive information about every entity declaration. </p>
<p>If you override this function, and you want normal entity substitution to work, then you must call the base class in your override.</p>
<p>This would be useful when overriding <a class="el" href="classxmlpp_1_1SaxParser.html#aeb20c4424f325655ebd787c2b2268137" title="Override this method to resolve entities references in your derived parser, instead of using the defa...">on_get_entity()</a>. </p>
</div>
</div>
<a class="anchor" id="a38c3c5f9bad26030acee20d7ddf4936a"></a><!-- doxytag: member="xmlpp::SaxParser::on_error" ref="a38c3c5f9bad26030acee20d7ddf4936a" args="(const Glib::ustring &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_error </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>text</em> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad951cc2b1fe314805c5d735a0d7f467c"></a><!-- doxytag: member="xmlpp::SaxParser::on_fatal_error" ref="ad951cc2b1fe314805c5d735a0d7f467c" args="(const Glib::ustring &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_fatal_error </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>text</em> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aeb20c4424f325655ebd787c2b2268137"></a><!-- doxytag: member="xmlpp::SaxParser::on_get_entity" ref="aeb20c4424f325655ebd787c2b2268137" args="(const Glib::ustring &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual _xmlEntity* xmlpp::SaxParser::on_get_entity </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>name</em> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Override this method to resolve entities references in your derived parser, instead of using the default entity resolution, or to be informed when entity references are encountered. </p>
<p>If you override this function then you must also specify true for use_get_entity constructor parameter. You will probably need to override <a class="el" href="classxmlpp_1_1SaxParser.html#ab0985199cbdbd9a7ab31b024acf3c2c8" title="Override this to receive information about every entity declaration.">on_entity_declaration()</a> as well so that you can use that information when resolving the entity reference.</p>
<p>This is known to be difficult, because it requires both an understanding of the W3C specifications and knowledge of the libxml internals. Entity resolution is easier with the <a class="el" href="classxmlpp_1_1DomParser.html" title="DOM XML parser.">DomParser</a>.</p>
<p>Call this method in this base class for default processing. For instance, if you just want to know about the existence of an entity reference, without affecting the normal substitution, just override and call the base class.</p>
<p>Unlike the <a class="el" href="classxmlpp_1_1DomParser.html" title="DOM XML parser.">DomParser</a>, the <a class="el" href="classxmlpp_1_1SaxParser.html" title="SAX XML parser.">SaxParser</a> will also tell you about entity references for the 5 predefined entities.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>The entity reference name. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The resolved xmlEntity for the entity reference. You must include libxml/parser.h in order to use this C struct. This instance will not be freed by the caller. </dd></dl>
</div>
</div>
<a class="anchor" id="a4b453817ac37ea307c2ba023cc938794"></a><!-- doxytag: member="xmlpp::SaxParser::on_internal_subset" ref="a4b453817ac37ea307c2ba023cc938794" args="(const Glib::ustring &name, const Glib::ustring &publicId, const Glib::ustring &systemId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_internal_subset </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>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>publicId</em>, </td>
</tr>
<tr>
<td class="paramkey"></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>systemId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Override this to receive information about the document's DTD and any entity declarations. </p>
</div>
</div>
<a class="anchor" id="a0a33932c84e245284414003f668b829f"></a><!-- doxytag: member="xmlpp::SaxParser::on_start_document" ref="a0a33932c84e245284414003f668b829f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_start_document </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="a1496022dd6b58d9af6a4a7a703830a84"></a><!-- doxytag: member="xmlpp::SaxParser::on_start_element" ref="a1496022dd6b58d9af6a4a7a703830a84" args="(const Glib::ustring &name, const AttributeList &attributes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_start_element </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>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classxmlpp_1_1SaxParser.html#a1cb4e32dd3adf2460f2836bddb59633c">AttributeList</a>& </td>
<td class="paramname"> <em>attributes</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab951160501bf3e78901691a79e3d11e8"></a><!-- doxytag: member="xmlpp::SaxParser::on_warning" ref="ab951160501bf3e78901691a79e3d11e8" args="(const Glib::ustring &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::on_warning </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>text</em> )</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a24b4440b0539a0015890182b35396b5d"></a><!-- doxytag: member="xmlpp::SaxParser::parse_chunk" ref="a24b4440b0539a0015890182b35396b5d" args="(const Glib::ustring &chunk)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::parse_chunk </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>chunk</em> )</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse a chunk of data. </p>
<p>This lets you pass a document in small chunks, e.g. from a network connection. The on_* virtual functions are called each time the chunks provide enough information to advance the parser.</p>
<p>The first call to parse_chunk will setup the parser. When the last chunk has been parsed, call <a class="el" href="classxmlpp_1_1SaxParser.html#ac540859149b064cfce87931ba736f3c5" title="Finish a chunk-wise parse.">finish_chunk_parsing()</a> to finish the parse.</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">chunk</td><td>The next piece of the XML document. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a501a19205773ac1c843d6007b189860e"></a><!-- doxytag: member="xmlpp::SaxParser::parse_chunk_raw" ref="a501a19205773ac1c843d6007b189860e" args="(const unsigned char *contents, size_type bytes_count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xmlpp::SaxParser::parse_chunk_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 a chunk of data. </p>
<dl class="since_2_24"><dt><b><a class="el" href="since_2_24.html#_since_2_24000006">Since libxml++ 2.24:</a></b></dt><dd></dd></dl>
<p>This lets you pass a document in small chunks, e.g. from a network connection. The on_* virtual functions are called each time the chunks provide enough information to advance the parser.</p>
<p>The first call to parse_chunk will setup the parser. When the last chunk has been parsed, call <a class="el" href="classxmlpp_1_1SaxParser.html#ac540859149b064cfce87931ba736f3c5" title="Finish a chunk-wise parse.">finish_chunk_parsing()</a> to finish the parse.</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 next piece of 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="ac2b0cf0069a73fa92c80f6d455923698"></a><!-- doxytag: member="xmlpp::SaxParser::parse_file" ref="ac2b0cf0069a73fa92c80f6d455923698" args="(const Glib::ustring &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::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="ab9367c59f02e0db5a2b17cd48ddf74f9"></a><!-- doxytag: member="xmlpp::SaxParser::parse_memory" ref="ab9367c59f02e0db5a2b17cd48ddf74f9" args="(const Glib::ustring &contents)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::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="aff9643a2764f6d8caee0307abbfcca25"></a><!-- doxytag: member="xmlpp::SaxParser::parse_memory_raw" ref="aff9643a2764f6d8caee0307abbfcca25" args="(const unsigned char *contents, size_type bytes_count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xmlpp::SaxParser::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="aaa731e56f99aa7f8313a1f096389f723"></a><!-- doxytag: member="xmlpp::SaxParser::parse_stream" ref="aaa731e56f99aa7f8313a1f096389f723" args="(std::istream &in)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::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="a839554028d8bad81774040eb67d23103"></a><!-- doxytag: member="xmlpp::SaxParser::release_underlying" ref="a839554028d8bad81774040eb67d23103" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void xmlpp::SaxParser::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/>The documentation for this class was generated from the following file:<ul>
<li>parsers/saxparser.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>
