~ubuntu-branches/ubuntu/natty/libxml++2.6/natty

« back to all changes in this revision

Viewing changes to docs/reference/2.20/html/classxmlpp_1_1Parser.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-09-18 11:32:24 UTC
  • mfrom: (1.1.10 upstream)
  • Revision ID: james.westby@ubuntu.com-20070918113224-7x031mzf1shoozxx
Tags: 2.20.0-0ubuntu1
* New upstream release:
  - Element: Added get_attribute_value(), to get a simple text value for an
    attribute.
  - Added an experimental --enable-api-exceptions configure option, to allow
    libxml++ to build without exceptions.
* debian/libxml++2.6-doc.docs: 2.18 -> 2.20.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
3
<title>libxml++: xmlpp::Parser Class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
5
<link href="tabs.css" rel="stylesheet" type="text/css">
 
6
</head><body>
 
7
<!-- Generated by Doxygen 1.5.1 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
12
    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
 
13
    <li><a href="files.html"><span>Files</span></a></li>
 
14
    <li><a href="dirs.html"><span>Directories</span></a></li>
 
15
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
16
  </ul></div>
 
17
<div class="tabs">
 
18
  <ul>
 
19
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
 
20
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
 
21
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
22
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
 
23
  </ul></div>
 
24
<div class="nav">
 
25
<a class="el" href="namespacexmlpp.html">xmlpp</a>::<a class="el" href="classxmlpp_1_1Parser.html">Parser</a></div>
 
26
<h1>xmlpp::Parser Class Reference</h1><!-- doxytag: class="xmlpp::Parser" --><!-- doxytag: inherits="xmlpp::NonCopyable" -->XML parser.  
 
27
<a href="#_details">More...</a>
 
28
<p>
 
29
Inheritance diagram for xmlpp::Parser:<p><center><img src="classxmlpp_1_1Parser__inherit__graph.jpg" border="0" usemap="#xmlpp_1_1Parser__inherit__map" alt="Inheritance graph"></center>
 
30
<map name="xmlpp_1_1Parser__inherit__map">
 
31
<area href="classxmlpp_1_1DomParser.html" shape="rect" coords="5,161,149,188" alt="">
 
32
<area href="classxmlpp_1_1SaxParser.html" shape="rect" coords="173,161,309,188" alt="">
 
33
<area href="classxmlpp_1_1NonCopyable.html" shape="rect" coords="80,7,237,33" alt="">
 
34
</map>
 
35
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classxmlpp_1_1Parser-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
 
36
<tr><td></td></tr>
 
37
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
 
38
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#8e7c797006bb5398629cf98f4141e3e6">size_type</a></td></tr>
 
39
 
 
40
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
 
41
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#b2990f22147cb2163eda6e773fb2eb68">Parser</a> ()</td></tr>
 
42
 
 
43
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#cf64cbff6b9cf4010226fc1c803d56f9">~Parser</a> ()</td></tr>
 
44
 
 
45
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#39332721610231ca8c5114e245121cc1">set_validate</a> (<a class="el" href="classbool.html">bool</a> val=true)</td></tr>
 
46
 
 
47
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">By default, the parser will not validate the XML file.  <a href="#39332721610231ca8c5114e245121cc1"></a><br></td></tr>
 
48
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classbool.html">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#f1744fadd0d32cae6e292bbea1cc5024">get_validate</a> () const</td></tr>
 
49
 
 
50
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See <a class="el" href="classxmlpp_1_1Parser.html#39332721610231ca8c5114e245121cc1">set_validate()</a>.  <a href="#f1744fadd0d32cae6e292bbea1cc5024"></a><br></td></tr>
 
51
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#960e9ee12df9b631c694ca002932cf7f">set_substitute_entities</a> (<a class="el" href="classbool.html">bool</a> val=true)</td></tr>
 
52
 
 
53
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set whether the parser will automatically substitute entity references with the text of the entities' definitions.  <a href="#960e9ee12df9b631c694ca002932cf7f"></a><br></td></tr>
 
54
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classbool.html">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#24dad02bf853a54af041b87ddb9adb20">get_substitute_entities</a> () const</td></tr>
 
55
 
 
56
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See <a class="el" href="classxmlpp_1_1Parser.html#960e9ee12df9b631c694ca002932cf7f">set_substitute_entities()</a>.  <a href="#24dad02bf853a54af041b87ddb9adb20"></a><br></td></tr>
 
57
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#d0855eff9a35a9160800ad58ad19fd7e">parse_file</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;filename)=0</td></tr>
 
58
 
 
59
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse an XML document from a file.  <a href="#d0855eff9a35a9160800ad58ad19fd7e"></a><br></td></tr>
 
60
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#bbbf646035570f1aa5366558dfc2ae01">parse_memory</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;contents)=0</td></tr>
 
61
 
 
62
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse an XML document from a string.  <a href="#bbbf646035570f1aa5366558dfc2ae01"></a><br></td></tr>
 
63
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#d7134b1c68308351785acb0302aa54db">parse_stream</a> (<a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__istream.html">std::istream</a> &amp;in)=0</td></tr>
 
64
 
 
65
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse an XML document from a stream.  <a href="#d7134b1c68308351785acb0302aa54db"></a><br></td></tr>
 
66
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
 
67
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#25f92d0a820d96accfe316a066bade49">initialize_context</a> ()</td></tr>
 
68
 
 
69
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#346ebfb1219e1c0d3acbd017a07706e6">release_underlying</a> ()</td></tr>
 
70
 
 
71
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#36860900bd7f118adfd7b7887278e4fb">on_validity_error</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;message)</td></tr>
 
72
 
 
73
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#d0876425a0d687f24bc54b44d950ab2c">on_validity_warning</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;message)</td></tr>
 
74
 
 
75
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#860e1cff3da52a4bbb0b17a06475399f">handleException</a> (const <a class="el" href="classxmlpp_1_1exception.html">exception</a> &amp;e)</td></tr>
 
76
 
 
77
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#9daba11c6746d91153329a9dbd8decc5">check_for_exception</a> ()</td></tr>
 
78
 
 
79
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#ad45390ab3d30d1dea26001f2d6a9a2f">check_for_validity_messages</a> ()</td></tr>
 
80
 
 
81
<tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr>
 
82
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#7ec91483923a6023e7ac56eeaf16b1e3">callback_validity_error</a> (void *ctx, const char *msg,...)</td></tr>
 
83
 
 
84
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#a573fc538688db238714cef413944567">callback_validity_warning</a> (void *ctx, const char *msg,...)</td></tr>
 
85
 
 
86
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
 
87
<tr><td class="memItemLeft" nowrap align="right" valign="top">_xmlParserCtxt *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#2b49a51f1a8fce897dffcb1e81f87907">context_</a></td></tr>
 
88
 
 
89
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classxmlpp_1_1exception.html">exception</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#7b2a100f91d2ead57de5ef640ebf91a9">exception_</a></td></tr>
 
90
 
 
91
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#367b4132d663f1c1adf1515c4a6e959f">validate_error_</a></td></tr>
 
92
 
 
93
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#ac64f7a377ae85c848dbb8008a43f555">validate_warning_</a></td></tr>
 
94
 
 
95
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classbool.html">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#2d21ddd4fdd34f845937649eb4fb8814">validate_</a></td></tr>
 
96
 
 
97
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classbool.html">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxmlpp_1_1Parser.html#969bc262133a8310cfbfc097f925c00c">substitute_entities_</a></td></tr>
 
98
 
 
99
</table>
 
100
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
101
XML parser. 
 
102
<p>
 
103
<hr><h2>Member Typedef Documentation</h2>
 
104
<a class="anchor" name="8e7c797006bb5398629cf98f4141e3e6"></a><!-- doxytag: member="xmlpp::Parser::size_type" ref="8e7c797006bb5398629cf98f4141e3e6" args="" -->
 
105
<div class="memitem">
 
106
<div class="memproto">
 
107
      <table class="memname">
 
108
        <tr>
 
109
          <td class="memname">typedef unsigned int <a class="el" href="classxmlpp_1_1Parser.html#8e7c797006bb5398629cf98f4141e3e6">xmlpp::Parser::size_type</a>          </td>
 
110
        </tr>
 
111
      </table>
 
112
</div>
 
113
<div class="memdoc">
 
114
 
 
115
<p>
 
116
 
 
117
</div>
 
118
</div><p>
 
119
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
120
<a class="anchor" name="b2990f22147cb2163eda6e773fb2eb68"></a><!-- doxytag: member="xmlpp::Parser::Parser" ref="b2990f22147cb2163eda6e773fb2eb68" args="()" -->
 
121
<div class="memitem">
 
122
<div class="memproto">
 
123
      <table class="memname">
 
124
        <tr>
 
125
          <td class="memname">xmlpp::Parser::Parser           </td>
 
126
          <td>(</td>
 
127
          <td class="paramname">          </td>
 
128
          <td>&nbsp;)&nbsp;</td>
 
129
          <td width="100%"></td>
 
130
        </tr>
 
131
      </table>
 
132
</div>
 
133
<div class="memdoc">
 
134
 
 
135
<p>
 
136
 
 
137
</div>
 
138
</div><p>
 
139
<a class="anchor" name="cf64cbff6b9cf4010226fc1c803d56f9"></a><!-- doxytag: member="xmlpp::Parser::~Parser" ref="cf64cbff6b9cf4010226fc1c803d56f9" args="()" -->
 
140
<div class="memitem">
 
141
<div class="memproto">
 
142
      <table class="memname">
 
143
        <tr>
 
144
          <td class="memname">virtual xmlpp::Parser::~Parser           </td>
 
145
          <td>(</td>
 
146
          <td class="paramname">          </td>
 
147
          <td>&nbsp;)&nbsp;</td>
 
148
          <td width="100%"><code> [virtual]</code></td>
 
149
        </tr>
 
150
      </table>
 
151
</div>
 
152
<div class="memdoc">
 
153
 
 
154
<p>
 
155
 
 
156
</div>
 
157
</div><p>
 
158
<hr><h2>Member Function Documentation</h2>
 
159
<a class="anchor" name="39332721610231ca8c5114e245121cc1"></a><!-- doxytag: member="xmlpp::Parser::set_validate" ref="39332721610231ca8c5114e245121cc1" args="(bool val=true)" -->
 
160
<div class="memitem">
 
161
<div class="memproto">
 
162
      <table class="memname">
 
163
        <tr>
 
164
          <td class="memname">virtual void xmlpp::Parser::set_validate           </td>
 
165
          <td>(</td>
 
166
          <td class="paramtype"><a class="el" href="classbool.html">bool</a>&nbsp;</td>
 
167
          <td class="paramname"> <em>val</em> = <code>true</code>          </td>
 
168
          <td>&nbsp;)&nbsp;</td>
 
169
          <td width="100%"><code> [virtual]</code></td>
 
170
        </tr>
 
171
      </table>
 
172
</div>
 
173
<div class="memdoc">
 
174
 
 
175
<p>
 
176
By default, the parser will not validate the XML file. 
 
177
<p>
 
178
<dl compact><dt><b>Parameters:</b></dt><dd>
 
179
  <table border="0" cellspacing="2" cellpadding="0">
 
180
    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>Whether the document should be validated. </td></tr>
 
181
  </table>
 
182
</dl>
 
183
 
 
184
</div>
 
185
</div><p>
 
186
<a class="anchor" name="f1744fadd0d32cae6e292bbea1cc5024"></a><!-- doxytag: member="xmlpp::Parser::get_validate" ref="f1744fadd0d32cae6e292bbea1cc5024" args="() const" -->
 
187
<div class="memitem">
 
188
<div class="memproto">
 
189
      <table class="memname">
 
190
        <tr>
 
191
          <td class="memname">virtual <a class="el" href="classbool.html">bool</a> xmlpp::Parser::get_validate           </td>
 
192
          <td>(</td>
 
193
          <td class="paramname">          </td>
 
194
          <td>&nbsp;)&nbsp;</td>
 
195
          <td width="100%"> const<code> [virtual]</code></td>
 
196
        </tr>
 
197
      </table>
 
198
</div>
 
199
<div class="memdoc">
 
200
 
 
201
<p>
 
202
See <a class="el" href="classxmlpp_1_1Parser.html#39332721610231ca8c5114e245121cc1">set_validate()</a>. 
 
203
<p>
 
204
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Whether the parser will validate the XML file. </dd></dl>
 
205
 
 
206
</div>
 
207
</div><p>
 
208
<a class="anchor" name="960e9ee12df9b631c694ca002932cf7f"></a><!-- doxytag: member="xmlpp::Parser::set_substitute_entities" ref="960e9ee12df9b631c694ca002932cf7f" args="(bool val=true)" -->
 
209
<div class="memitem">
 
210
<div class="memproto">
 
211
      <table class="memname">
 
212
        <tr>
 
213
          <td class="memname">virtual void xmlpp::Parser::set_substitute_entities           </td>
 
214
          <td>(</td>
 
215
          <td class="paramtype"><a class="el" href="classbool.html">bool</a>&nbsp;</td>
 
216
          <td class="paramname"> <em>val</em> = <code>true</code>          </td>
 
217
          <td>&nbsp;)&nbsp;</td>
 
218
          <td width="100%"><code> [virtual]</code></td>
 
219
        </tr>
 
220
      </table>
 
221
</div>
 
222
<div class="memdoc">
 
223
 
 
224
<p>
 
225
Set whether the parser will automatically substitute entity references with the text of the entities' definitions. 
 
226
<p>
 
227
For instance, this affects the text returned by <a class="el" href="classxmlpp_1_1ContentNode.html#ae72ec9dc2b4e9cff3a3403e08678b45">ContentNode::get_content()</a>. By default, the parser will not substitute entities, so that you do not lose the entity reference information. <dl compact><dt><b>Parameters:</b></dt><dd>
 
228
  <table border="0" cellspacing="2" cellpadding="0">
 
229
    <tr><td valign="top"></td><td valign="top"><em>val</em>&nbsp;</td><td>Whether entities will be substitued. </td></tr>
 
230
  </table>
 
231
</dl>
 
232
 
 
233
</div>
 
234
</div><p>
 
235
<a class="anchor" name="24dad02bf853a54af041b87ddb9adb20"></a><!-- doxytag: member="xmlpp::Parser::get_substitute_entities" ref="24dad02bf853a54af041b87ddb9adb20" args="() const" -->
 
236
<div class="memitem">
 
237
<div class="memproto">
 
238
      <table class="memname">
 
239
        <tr>
 
240
          <td class="memname">virtual <a class="el" href="classbool.html">bool</a> xmlpp::Parser::get_substitute_entities           </td>
 
241
          <td>(</td>
 
242
          <td class="paramname">          </td>
 
243
          <td>&nbsp;)&nbsp;</td>
 
244
          <td width="100%"> const<code> [virtual]</code></td>
 
245
        </tr>
 
246
      </table>
 
247
</div>
 
248
<div class="memdoc">
 
249
 
 
250
<p>
 
251
See <a class="el" href="classxmlpp_1_1Parser.html#960e9ee12df9b631c694ca002932cf7f">set_substitute_entities()</a>. 
 
252
<p>
 
253
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Whether entities will be substituted during parsing. </dd></dl>
 
254
 
 
255
</div>
 
256
</div><p>
 
257
<a class="anchor" name="d0855eff9a35a9160800ad58ad19fd7e"></a><!-- doxytag: member="xmlpp::Parser::parse_file" ref="d0855eff9a35a9160800ad58ad19fd7e" args="(const Glib::ustring &amp;filename)=0" -->
 
258
<div class="memitem">
 
259
<div class="memproto">
 
260
      <table class="memname">
 
261
        <tr>
 
262
          <td class="memname">virtual void xmlpp::Parser::parse_file           </td>
 
263
          <td>(</td>
 
264
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&nbsp;</td>
 
265
          <td class="paramname"> <em>filename</em>          </td>
 
266
          <td>&nbsp;)&nbsp;</td>
 
267
          <td width="100%"><code> [pure virtual]</code></td>
 
268
        </tr>
 
269
      </table>
 
270
</div>
 
271
<div class="memdoc">
 
272
 
 
273
<p>
 
274
Parse an XML document from a file. 
 
275
<p>
 
276
<dl compact><dt><b>Exceptions:</b></dt><dd>
 
277
  <table border="0" cellspacing="2" cellpadding="0">
 
278
    <tr><td valign="top"></td><td valign="top"><em>exception</em>&nbsp;</td><td></td></tr>
 
279
  </table>
 
280
</dl>
 
281
<dl compact><dt><b>Parameters:</b></dt><dd>
 
282
  <table border="0" cellspacing="2" cellpadding="0">
 
283
    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The path to the file. </td></tr>
 
284
  </table>
 
285
</dl>
 
286
 
 
287
<p>
 
288
Implemented in <a class="el" href="classxmlpp_1_1DomParser.html#437c91bb64033669649d91f28ecc7dc9">xmlpp::DomParser</a>, and <a class="el" href="classxmlpp_1_1SaxParser.html#c2b0cf0069a73fa92c80f6d455923698">xmlpp::SaxParser</a>.
 
289
</div>
 
290
</div><p>
 
291
<a class="anchor" name="bbbf646035570f1aa5366558dfc2ae01"></a><!-- doxytag: member="xmlpp::Parser::parse_memory" ref="bbbf646035570f1aa5366558dfc2ae01" args="(const Glib::ustring &amp;contents)=0" -->
 
292
<div class="memitem">
 
293
<div class="memproto">
 
294
      <table class="memname">
 
295
        <tr>
 
296
          <td class="memname">virtual void xmlpp::Parser::parse_memory           </td>
 
297
          <td>(</td>
 
298
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&nbsp;</td>
 
299
          <td class="paramname"> <em>contents</em>          </td>
 
300
          <td>&nbsp;)&nbsp;</td>
 
301
          <td width="100%"><code> [pure virtual]</code></td>
 
302
        </tr>
 
303
      </table>
 
304
</div>
 
305
<div class="memdoc">
 
306
 
 
307
<p>
 
308
Parse an XML document from a string. 
 
309
<p>
 
310
<dl compact><dt><b>Exceptions:</b></dt><dd>
 
311
  <table border="0" cellspacing="2" cellpadding="0">
 
312
    <tr><td valign="top"></td><td valign="top"><em>exception</em>&nbsp;</td><td></td></tr>
 
313
  </table>
 
314
</dl>
 
315
<dl compact><dt><b>Parameters:</b></dt><dd>
 
316
  <table border="0" cellspacing="2" cellpadding="0">
 
317
    <tr><td valign="top"></td><td valign="top"><em>contents</em>&nbsp;</td><td>The XML document as a string. </td></tr>
 
318
  </table>
 
319
</dl>
 
320
 
 
321
<p>
 
322
Implemented in <a class="el" href="classxmlpp_1_1DomParser.html#2110398d5a19320e7bbe65e0edb2ab9c">xmlpp::DomParser</a>, and <a class="el" href="classxmlpp_1_1SaxParser.html#b9367c59f02e0db5a2b17cd48ddf74f9">xmlpp::SaxParser</a>.
 
323
</div>
 
324
</div><p>
 
325
<a class="anchor" name="d7134b1c68308351785acb0302aa54db"></a><!-- doxytag: member="xmlpp::Parser::parse_stream" ref="d7134b1c68308351785acb0302aa54db" args="(std::istream &amp;in)=0" -->
 
326
<div class="memitem">
 
327
<div class="memproto">
 
328
      <table class="memname">
 
329
        <tr>
 
330
          <td class="memname">virtual void xmlpp::Parser::parse_stream           </td>
 
331
          <td>(</td>
 
332
          <td class="paramtype"><a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__istream.html">std::istream</a> &amp;&nbsp;</td>
 
333
          <td class="paramname"> <em>in</em>          </td>
 
334
          <td>&nbsp;)&nbsp;</td>
 
335
          <td width="100%"><code> [pure virtual]</code></td>
 
336
        </tr>
 
337
      </table>
 
338
</div>
 
339
<div class="memdoc">
 
340
 
 
341
<p>
 
342
Parse an XML document from a stream. 
 
343
<p>
 
344
<dl compact><dt><b>Exceptions:</b></dt><dd>
 
345
  <table border="0" cellspacing="2" cellpadding="0">
 
346
    <tr><td valign="top"></td><td valign="top"><em>exception</em>&nbsp;</td><td></td></tr>
 
347
  </table>
 
348
</dl>
 
349
<dl compact><dt><b>Parameters:</b></dt><dd>
 
350
  <table border="0" cellspacing="2" cellpadding="0">
 
351
    <tr><td valign="top"></td><td valign="top"><em>in</em>&nbsp;</td><td>The stream. </td></tr>
 
352
  </table>
 
353
</dl>
 
354
 
 
355
<p>
 
356
Implemented in <a class="el" href="classxmlpp_1_1DomParser.html#3d02d6c5b4194b47118e92a8e258743c">xmlpp::DomParser</a>, and <a class="el" href="classxmlpp_1_1SaxParser.html#aa731e56f99aa7f8313a1f096389f723">xmlpp::SaxParser</a>.
 
357
</div>
 
358
</div><p>
 
359
<a class="anchor" name="25f92d0a820d96accfe316a066bade49"></a><!-- doxytag: member="xmlpp::Parser::initialize_context" ref="25f92d0a820d96accfe316a066bade49" args="()" -->
 
360
<div class="memitem">
 
361
<div class="memproto">
 
362
      <table class="memname">
 
363
        <tr>
 
364
          <td class="memname">virtual void xmlpp::Parser::initialize_context           </td>
 
365
          <td>(</td>
 
366
          <td class="paramname">          </td>
 
367
          <td>&nbsp;)&nbsp;</td>
 
368
          <td width="100%"><code> [protected, virtual]</code></td>
 
369
        </tr>
 
370
      </table>
 
371
</div>
 
372
<div class="memdoc">
 
373
 
 
374
<p>
 
375
 
 
376
</div>
 
377
</div><p>
 
378
<a class="anchor" name="346ebfb1219e1c0d3acbd017a07706e6"></a><!-- doxytag: member="xmlpp::Parser::release_underlying" ref="346ebfb1219e1c0d3acbd017a07706e6" args="()" -->
 
379
<div class="memitem">
 
380
<div class="memproto">
 
381
      <table class="memname">
 
382
        <tr>
 
383
          <td class="memname">virtual void xmlpp::Parser::release_underlying           </td>
 
384
          <td>(</td>
 
385
          <td class="paramname">          </td>
 
386
          <td>&nbsp;)&nbsp;</td>
 
387
          <td width="100%"><code> [protected, virtual]</code></td>
 
388
        </tr>
 
389
      </table>
 
390
</div>
 
391
<div class="memdoc">
 
392
 
 
393
<p>
 
394
 
 
395
<p>
 
396
Reimplemented in <a class="el" href="classxmlpp_1_1DomParser.html#58a312db2834a41a77ca290dc6dc48fe">xmlpp::DomParser</a>, and <a class="el" href="classxmlpp_1_1SaxParser.html#839554028d8bad81774040eb67d23103">xmlpp::SaxParser</a>.
 
397
</div>
 
398
</div><p>
 
399
<a class="anchor" name="36860900bd7f118adfd7b7887278e4fb"></a><!-- doxytag: member="xmlpp::Parser::on_validity_error" ref="36860900bd7f118adfd7b7887278e4fb" args="(const Glib::ustring &amp;message)" -->
 
400
<div class="memitem">
 
401
<div class="memproto">
 
402
      <table class="memname">
 
403
        <tr>
 
404
          <td class="memname">virtual void xmlpp::Parser::on_validity_error           </td>
 
405
          <td>(</td>
 
406
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&nbsp;</td>
 
407
          <td class="paramname"> <em>message</em>          </td>
 
408
          <td>&nbsp;)&nbsp;</td>
 
409
          <td width="100%"><code> [protected, virtual]</code></td>
 
410
        </tr>
 
411
      </table>
 
412
</div>
 
413
<div class="memdoc">
 
414
 
 
415
<p>
 
416
 
 
417
</div>
 
418
</div><p>
 
419
<a class="anchor" name="d0876425a0d687f24bc54b44d950ab2c"></a><!-- doxytag: member="xmlpp::Parser::on_validity_warning" ref="d0876425a0d687f24bc54b44d950ab2c" args="(const Glib::ustring &amp;message)" -->
 
420
<div class="memitem">
 
421
<div class="memproto">
 
422
      <table class="memname">
 
423
        <tr>
 
424
          <td class="memname">virtual void xmlpp::Parser::on_validity_warning           </td>
 
425
          <td>(</td>
 
426
          <td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> &amp;&nbsp;</td>
 
427
          <td class="paramname"> <em>message</em>          </td>
 
428
          <td>&nbsp;)&nbsp;</td>
 
429
          <td width="100%"><code> [protected, virtual]</code></td>
 
430
        </tr>
 
431
      </table>
 
432
</div>
 
433
<div class="memdoc">
 
434
 
 
435
<p>
 
436
 
 
437
</div>
 
438
</div><p>
 
439
<a class="anchor" name="860e1cff3da52a4bbb0b17a06475399f"></a><!-- doxytag: member="xmlpp::Parser::handleException" ref="860e1cff3da52a4bbb0b17a06475399f" args="(const exception &amp;e)" -->
 
440
<div class="memitem">
 
441
<div class="memproto">
 
442
      <table class="memname">
 
443
        <tr>
 
444
          <td class="memname">virtual void xmlpp::Parser::handleException           </td>
 
445
          <td>(</td>
 
446
          <td class="paramtype">const <a class="el" href="classxmlpp_1_1exception.html">exception</a> &amp;&nbsp;</td>
 
447
          <td class="paramname"> <em>e</em>          </td>
 
448
          <td>&nbsp;)&nbsp;</td>
 
449
          <td width="100%"><code> [protected, virtual]</code></td>
 
450
        </tr>
 
451
      </table>
 
452
</div>
 
453
<div class="memdoc">
 
454
 
 
455
<p>
 
456
 
 
457
</div>
 
458
</div><p>
 
459
<a class="anchor" name="9daba11c6746d91153329a9dbd8decc5"></a><!-- doxytag: member="xmlpp::Parser::check_for_exception" ref="9daba11c6746d91153329a9dbd8decc5" args="()" -->
 
460
<div class="memitem">
 
461
<div class="memproto">
 
462
      <table class="memname">
 
463
        <tr>
 
464
          <td class="memname">virtual void xmlpp::Parser::check_for_exception           </td>
 
465
          <td>(</td>
 
466
          <td class="paramname">          </td>
 
467
          <td>&nbsp;)&nbsp;</td>
 
468
          <td width="100%"><code> [protected, virtual]</code></td>
 
469
        </tr>
 
470
      </table>
 
471
</div>
 
472
<div class="memdoc">
 
473
 
 
474
<p>
 
475
 
 
476
</div>
 
477
</div><p>
 
478
<a class="anchor" name="ad45390ab3d30d1dea26001f2d6a9a2f"></a><!-- doxytag: member="xmlpp::Parser::check_for_validity_messages" ref="ad45390ab3d30d1dea26001f2d6a9a2f" args="()" -->
 
479
<div class="memitem">
 
480
<div class="memproto">
 
481
      <table class="memname">
 
482
        <tr>
 
483
          <td class="memname">virtual void xmlpp::Parser::check_for_validity_messages           </td>
 
484
          <td>(</td>
 
485
          <td class="paramname">          </td>
 
486
          <td>&nbsp;)&nbsp;</td>
 
487
          <td width="100%"><code> [protected, virtual]</code></td>
 
488
        </tr>
 
489
      </table>
 
490
</div>
 
491
<div class="memdoc">
 
492
 
 
493
<p>
 
494
 
 
495
</div>
 
496
</div><p>
 
497
<a class="anchor" name="7ec91483923a6023e7ac56eeaf16b1e3"></a><!-- doxytag: member="xmlpp::Parser::callback_validity_error" ref="7ec91483923a6023e7ac56eeaf16b1e3" args="(void *ctx, const char *msg,...)" -->
 
498
<div class="memitem">
 
499
<div class="memproto">
 
500
      <table class="memname">
 
501
        <tr>
 
502
          <td class="memname">static void xmlpp::Parser::callback_validity_error           </td>
 
503
          <td>(</td>
 
504
          <td class="paramtype">void *&nbsp;</td>
 
505
          <td class="paramname"> <em>ctx</em>, </td>
 
506
        </tr>
 
507
        <tr>
 
508
          <td class="paramkey"></td>
 
509
          <td></td>
 
510
          <td class="paramtype">const char *&nbsp;</td>
 
511
          <td class="paramname"> <em>msg</em>, </td>
 
512
        </tr>
 
513
        <tr>
 
514
          <td class="paramkey"></td>
 
515
          <td></td>
 
516
          <td class="paramtype">&nbsp;</td>
 
517
          <td class="paramname"> <em>...</em></td><td>&nbsp;</td>
 
518
        </tr>
 
519
        <tr>
 
520
          <td></td>
 
521
          <td>)</td>
 
522
          <td></td><td></td><td width="100%"><code> [static, protected]</code></td>
 
523
        </tr>
 
524
      </table>
 
525
</div>
 
526
<div class="memdoc">
 
527
 
 
528
<p>
 
529
 
 
530
</div>
 
531
</div><p>
 
532
<a class="anchor" name="a573fc538688db238714cef413944567"></a><!-- doxytag: member="xmlpp::Parser::callback_validity_warning" ref="a573fc538688db238714cef413944567" args="(void *ctx, const char *msg,...)" -->
 
533
<div class="memitem">
 
534
<div class="memproto">
 
535
      <table class="memname">
 
536
        <tr>
 
537
          <td class="memname">static void xmlpp::Parser::callback_validity_warning           </td>
 
538
          <td>(</td>
 
539
          <td class="paramtype">void *&nbsp;</td>
 
540
          <td class="paramname"> <em>ctx</em>, </td>
 
541
        </tr>
 
542
        <tr>
 
543
          <td class="paramkey"></td>
 
544
          <td></td>
 
545
          <td class="paramtype">const char *&nbsp;</td>
 
546
          <td class="paramname"> <em>msg</em>, </td>
 
547
        </tr>
 
548
        <tr>
 
549
          <td class="paramkey"></td>
 
550
          <td></td>
 
551
          <td class="paramtype">&nbsp;</td>
 
552
          <td class="paramname"> <em>...</em></td><td>&nbsp;</td>
 
553
        </tr>
 
554
        <tr>
 
555
          <td></td>
 
556
          <td>)</td>
 
557
          <td></td><td></td><td width="100%"><code> [static, protected]</code></td>
 
558
        </tr>
 
559
      </table>
 
560
</div>
 
561
<div class="memdoc">
 
562
 
 
563
<p>
 
564
 
 
565
</div>
 
566
</div><p>
 
567
<hr><h2>Member Data Documentation</h2>
 
568
<a class="anchor" name="2b49a51f1a8fce897dffcb1e81f87907"></a><!-- doxytag: member="xmlpp::Parser::context_" ref="2b49a51f1a8fce897dffcb1e81f87907" args="" -->
 
569
<div class="memitem">
 
570
<div class="memproto">
 
571
      <table class="memname">
 
572
        <tr>
 
573
          <td class="memname">_xmlParserCtxt* <a class="el" href="classxmlpp_1_1Parser.html#2b49a51f1a8fce897dffcb1e81f87907">xmlpp::Parser::context_</a><code> [protected]</code>          </td>
 
574
        </tr>
 
575
      </table>
 
576
</div>
 
577
<div class="memdoc">
 
578
 
 
579
<p>
 
580
 
 
581
</div>
 
582
</div><p>
 
583
<a class="anchor" name="7b2a100f91d2ead57de5ef640ebf91a9"></a><!-- doxytag: member="xmlpp::Parser::exception_" ref="7b2a100f91d2ead57de5ef640ebf91a9" args="" -->
 
584
<div class="memitem">
 
585
<div class="memproto">
 
586
      <table class="memname">
 
587
        <tr>
 
588
          <td class="memname"><a class="el" href="classxmlpp_1_1exception.html">exception</a>* <a class="el" href="classxmlpp_1_1Parser.html#7b2a100f91d2ead57de5ef640ebf91a9">xmlpp::Parser::exception_</a><code> [protected]</code>          </td>
 
589
        </tr>
 
590
      </table>
 
591
</div>
 
592
<div class="memdoc">
 
593
 
 
594
<p>
 
595
 
 
596
</div>
 
597
</div><p>
 
598
<a class="anchor" name="367b4132d663f1c1adf1515c4a6e959f"></a><!-- doxytag: member="xmlpp::Parser::validate_error_" ref="367b4132d663f1c1adf1515c4a6e959f" args="" -->
 
599
<div class="memitem">
 
600
<div class="memproto">
 
601
      <table class="memname">
 
602
        <tr>
 
603
          <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> <a class="el" href="classxmlpp_1_1Parser.html#367b4132d663f1c1adf1515c4a6e959f">xmlpp::Parser::validate_error_</a><code> [protected]</code>          </td>
 
604
        </tr>
 
605
      </table>
 
606
</div>
 
607
<div class="memdoc">
 
608
 
 
609
<p>
 
610
 
 
611
</div>
 
612
</div><p>
 
613
<a class="anchor" name="ac64f7a377ae85c848dbb8008a43f555"></a><!-- doxytag: member="xmlpp::Parser::validate_warning_" ref="ac64f7a377ae85c848dbb8008a43f555" args="" -->
 
614
<div class="memitem">
 
615
<div class="memproto">
 
616
      <table class="memname">
 
617
        <tr>
 
618
          <td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/" href="http://www.gtkmm.org/docs/glibmm-2.4/docs/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> <a class="el" href="classxmlpp_1_1Parser.html#ac64f7a377ae85c848dbb8008a43f555">xmlpp::Parser::validate_warning_</a><code> [protected]</code>          </td>
 
619
        </tr>
 
620
      </table>
 
621
</div>
 
622
<div class="memdoc">
 
623
 
 
624
<p>
 
625
 
 
626
</div>
 
627
</div><p>
 
628
<a class="anchor" name="2d21ddd4fdd34f845937649eb4fb8814"></a><!-- doxytag: member="xmlpp::Parser::validate_" ref="2d21ddd4fdd34f845937649eb4fb8814" args="" -->
 
629
<div class="memitem">
 
630
<div class="memproto">
 
631
      <table class="memname">
 
632
        <tr>
 
633
          <td class="memname"><a class="el" href="classbool.html">bool</a> <a class="el" href="classxmlpp_1_1Parser.html#2d21ddd4fdd34f845937649eb4fb8814">xmlpp::Parser::validate_</a><code> [protected]</code>          </td>
 
634
        </tr>
 
635
      </table>
 
636
</div>
 
637
<div class="memdoc">
 
638
 
 
639
<p>
 
640
 
 
641
</div>
 
642
</div><p>
 
643
<a class="anchor" name="969bc262133a8310cfbfc097f925c00c"></a><!-- doxytag: member="xmlpp::Parser::substitute_entities_" ref="969bc262133a8310cfbfc097f925c00c" args="" -->
 
644
<div class="memitem">
 
645
<div class="memproto">
 
646
      <table class="memname">
 
647
        <tr>
 
648
          <td class="memname"><a class="el" href="classbool.html">bool</a> <a class="el" href="classxmlpp_1_1Parser.html#969bc262133a8310cfbfc097f925c00c">xmlpp::Parser::substitute_entities_</a><code> [protected]</code>          </td>
 
649
        </tr>
 
650
      </table>
 
651
</div>
 
652
<div class="memdoc">
 
653
 
 
654
<p>
 
655
 
 
656
</div>
 
657
</div><p>
 
658
<hr>The documentation for this class was generated from the following file:<ul>
 
659
<li><a class="el" href="parser_8h.html">parser.h</a></ul>
 
660
<hr size="1"><address style="align: right;"><small>Generated on Tue Sep 18 10:36:27 2007 for libxml++ by&nbsp;
 
661
<a href="http://www.doxygen.org/index.html">
 
662
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
 
663
</body>
 
664
</html>