~kklimonda/ubuntu/natty/glibmm2.4/update

« back to all changes in this revision

Viewing changes to docs/reference/html/classGlib_1_1Markup_1_1ParseContext.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-03-16 14:26:05 UTC
  • mfrom: (1.2.35 upstream)
  • Revision ID: james.westby@ubuntu.com-20090316142605-gj2oyabw69a9b9li
Tags: 2.20.0-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
 
20
20
<!-- begin main content -->
21
21
<div id="content">
22
 
<!-- Generated by Doxygen 1.5.6 -->
 
22
<!-- Generated by Doxygen 1.5.8 -->
23
23
  <div class="navpath"><a class="el" href="namespaceGlib.html">Glib</a>::<a class="el" href="namespaceGlib_1_1Markup.html">Markup</a>::<a class="el" href="classGlib_1_1Markup_1_1ParseContext.html">ParseContext</a>
24
24
  </div>
25
25
<div class="contents">
32
32
<div class="dynheader">
33
33
Inheritance diagram for Glib::Markup::ParseContext:</div>
34
34
<div class="dynsection">
35
 
<p><center><img src="classGlib_1_1Markup_1_1ParseContext__inherit__graph.png" border="0" usemap="#Glib_1_1Markup_1_1ParseContext__inherit__map" alt="Inheritance graph"></center>
36
 
<map name="Glib_1_1Markup_1_1ParseContext__inherit__map">
37
 
<area shape="rect" href="classsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="43,5,149,32"></map>
38
35
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
39
36
 
40
37
<p>
130
127
</div>
131
128
</div><p>
132
129
<hr><h2>Member Function Documentation</h2>
133
 
<a class="anchor" name="1158f306b9d7211d97fa02fdfbfddf50"></a><!-- doxytag: member="Glib::Markup::ParseContext::parse" ref="1158f306b9d7211d97fa02fdfbfddf50" args="(const Glib::ustring &amp;text)" -->
134
 
<div class="memitem">
135
 
<div class="memproto">
136
 
      <table class="memname">
137
 
        <tr>
138
 
          <td class="memname">void Glib::Markup::ParseContext::parse           </td>
139
 
          <td>(</td>
140
 
          <td class="paramtype">const <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a>&amp;&nbsp;</td>
141
 
          <td class="paramname"> <em>text</em>          </td>
142
 
          <td>&nbsp;)&nbsp;</td>
143
 
          <td></td>
144
 
        </tr>
145
 
      </table>
146
 
</div>
147
 
<div class="memdoc">
148
 
 
149
 
<p>
150
 
Feed some data to the <a class="el" href="classGlib_1_1Markup_1_1ParseContext.html" title="A parse context is used to parse marked-up documents.">ParseContext</a>. 
151
 
<p>
152
 
The data need not be valid UTF-8; an error will be signalled if it's invalid. The data need not be an entire document; you can feed a document into the parser incrementally, via multiple calls to this function. Typically, as you receive data from a network connection or file, you feed each received chunk of data into this function, aborting the process if an error occurs. Once an error is reported, no further data may be fed to the <a class="el" href="classGlib_1_1Markup_1_1ParseContext.html" title="A parse context is used to parse marked-up documents.">ParseContext</a>; all errors are fatal. <dl compact><dt><b>Parameters:</b></dt><dd>
153
 
  <table border="0" cellspacing="2" cellpadding="0">
154
 
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>Chunk of text to parse. </td></tr>
155
 
  </table>
156
 
</dl>
157
 
<dl compact><dt><b>Exceptions:</b></dt><dd>
158
 
  <table border="0" cellspacing="2" cellpadding="0">
159
 
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classGlib_1_1MarkupError.html" title="Exception class for markup parsing errors.">Glib::MarkupError</a></em>&nbsp;</td><td></td></tr>
160
 
  </table>
161
 
</dl>
162
 
 
163
 
</div>
164
 
</div><p>
165
 
<a class="anchor" name="e173b1cb8e2c9e9a5ef288006ccdbda7"></a><!-- doxytag: member="Glib::Markup::ParseContext::parse" ref="e173b1cb8e2c9e9a5ef288006ccdbda7" args="(const char *text_begin, const char *text_end)" -->
166
 
<div class="memitem">
167
 
<div class="memproto">
168
 
      <table class="memname">
169
 
        <tr>
170
 
          <td class="memname">void Glib::Markup::ParseContext::parse           </td>
171
 
          <td>(</td>
172
 
          <td class="paramtype">const char *&nbsp;</td>
173
 
          <td class="paramname"> <em>text_begin</em>, </td>
174
 
        </tr>
175
 
        <tr>
176
 
          <td class="paramkey"></td>
177
 
          <td></td>
178
 
          <td class="paramtype">const char *&nbsp;</td>
179
 
          <td class="paramname"> <em>text_end</em></td><td>&nbsp;</td>
180
 
        </tr>
181
 
        <tr>
182
 
          <td></td>
183
 
          <td>)</td>
184
 
          <td></td><td></td><td></td>
185
 
        </tr>
186
 
      </table>
187
 
</div>
188
 
<div class="memdoc">
189
 
 
190
 
<p>
191
 
Feed some data to the <a class="el" href="classGlib_1_1Markup_1_1ParseContext.html" title="A parse context is used to parse marked-up documents.">ParseContext</a>. 
192
 
<p>
193
 
The data need not be valid UTF-8; an error will be signalled if it's invalid. The data need not be an entire document; you can feed a document into the parser incrementally, via multiple calls to this function. Typically, as you receive data from a network connection or file, you feed each received chunk of data into this function, aborting the process if an error occurs. Once an error is reported, no further data may be fed to the <a class="el" href="classGlib_1_1Markup_1_1ParseContext.html" title="A parse context is used to parse marked-up documents.">ParseContext</a>; all errors are fatal. <dl compact><dt><b>Parameters:</b></dt><dd>
194
 
  <table border="0" cellspacing="2" cellpadding="0">
195
 
    <tr><td valign="top"></td><td valign="top"><em>text_begin</em>&nbsp;</td><td>Begin of chunk of text to parse. </td></tr>
196
 
    <tr><td valign="top"></td><td valign="top"><em>text_end</em>&nbsp;</td><td>End of chunk of text to parse. </td></tr>
197
 
  </table>
198
 
</dl>
199
 
<dl compact><dt><b>Exceptions:</b></dt><dd>
200
 
  <table border="0" cellspacing="2" cellpadding="0">
201
 
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classGlib_1_1MarkupError.html" title="Exception class for markup parsing errors.">Glib::MarkupError</a></em>&nbsp;</td><td></td></tr>
202
 
  </table>
203
 
</dl>
204
 
 
205
 
</div>
206
 
</div><p>
207
130
<a class="anchor" name="cd4b854317c6c562f55e0595f62aafb0"></a><!-- doxytag: member="Glib::Markup::ParseContext::end_parse" ref="cd4b854317c6c562f55e0595f62aafb0" args="()" -->
208
131
<div class="memitem">
209
132
<div class="memproto">
230
153
 
231
154
</div>
232
155
</div><p>
 
156
<a class="anchor" name="ed00dd8c7ca8bd43a44158c9491477e4"></a><!-- doxytag: member="Glib::Markup::ParseContext::get_char_number" ref="ed00dd8c7ca8bd43a44158c9491477e4" args="() const " -->
 
157
<div class="memitem">
 
158
<div class="memproto">
 
159
      <table class="memname">
 
160
        <tr>
 
161
          <td class="memname">int Glib::Markup::ParseContext::get_char_number           </td>
 
162
          <td>(</td>
 
163
          <td class="paramname">          </td>
 
164
          <td>&nbsp;)&nbsp;</td>
 
165
          <td> const</td>
 
166
        </tr>
 
167
      </table>
 
168
</div>
 
169
<div class="memdoc">
 
170
 
 
171
<p>
 
172
Retrieves the number of the current character on the current line. 
 
173
<p>
 
174
Intended for use in error messages; there are no strict semantics for what constitutes the "current" character number other than "the best number we could come up with for error messages." 
 
175
</div>
 
176
</div><p>
233
177
<a class="anchor" name="5324c8b9dcfd837c3ed79173c9aaf7fb"></a><!-- doxytag: member="Glib::Markup::ParseContext::get_element" ref="5324c8b9dcfd837c3ed79173c9aaf7fb" args="() const " -->
234
178
<div class="memitem">
235
179
<div class="memproto">
273
217
Intended for use in error messages; there are no strict semantics for what constitutes the "current" line number other than "the best number we could come up with for error messages." 
274
218
</div>
275
219
</div><p>
276
 
<a class="anchor" name="ed00dd8c7ca8bd43a44158c9491477e4"></a><!-- doxytag: member="Glib::Markup::ParseContext::get_char_number" ref="ed00dd8c7ca8bd43a44158c9491477e4" args="() const " -->
 
220
<a class="anchor" name="9dfac516a37a2fc5a82dc162e259e75b"></a><!-- doxytag: member="Glib::Markup::ParseContext::get_parser" ref="9dfac516a37a2fc5a82dc162e259e75b" args="() const " -->
277
221
<div class="memitem">
278
222
<div class="memproto">
279
223
      <table class="memname">
280
224
        <tr>
281
 
          <td class="memname">int Glib::Markup::ParseContext::get_char_number           </td>
 
225
          <td class="memname">const <a class="el" href="classGlib_1_1Markup_1_1Parser.html">Parser</a>* Glib::Markup::ParseContext::get_parser           </td>
282
226
          <td>(</td>
283
227
          <td class="paramname">          </td>
284
228
          <td>&nbsp;)&nbsp;</td>
285
 
          <td> const</td>
 
229
          <td> const<code> [inline]</code></td>
286
230
        </tr>
287
231
      </table>
288
232
</div>
289
233
<div class="memdoc">
290
234
 
291
235
<p>
292
 
Retrieves the number of the current character on the current line. 
293
 
<p>
294
 
Intended for use in error messages; there are no strict semantics for what constitutes the "current" character number other than "the best number we could come up with for error messages." 
 
236
 
295
237
</div>
296
238
</div><p>
297
239
<a class="anchor" name="4dcbfbf2ba04a4014378bc9b74bab281"></a><!-- doxytag: member="Glib::Markup::ParseContext::get_parser" ref="4dcbfbf2ba04a4014378bc9b74bab281" args="()" -->
313
255
 
314
256
</div>
315
257
</div><p>
316
 
<a class="anchor" name="9dfac516a37a2fc5a82dc162e259e75b"></a><!-- doxytag: member="Glib::Markup::ParseContext::get_parser" ref="9dfac516a37a2fc5a82dc162e259e75b" args="() const " -->
317
 
<div class="memitem">
318
 
<div class="memproto">
319
 
      <table class="memname">
320
 
        <tr>
321
 
          <td class="memname">const <a class="el" href="classGlib_1_1Markup_1_1Parser.html">Parser</a>* Glib::Markup::ParseContext::get_parser           </td>
322
 
          <td>(</td>
323
 
          <td class="paramname">          </td>
 
258
<a class="anchor" name="e173b1cb8e2c9e9a5ef288006ccdbda7"></a><!-- doxytag: member="Glib::Markup::ParseContext::parse" ref="e173b1cb8e2c9e9a5ef288006ccdbda7" args="(const char *text_begin, const char *text_end)" -->
 
259
<div class="memitem">
 
260
<div class="memproto">
 
261
      <table class="memname">
 
262
        <tr>
 
263
          <td class="memname">void Glib::Markup::ParseContext::parse           </td>
 
264
          <td>(</td>
 
265
          <td class="paramtype">const char *&nbsp;</td>
 
266
          <td class="paramname"> <em>text_begin</em>, </td>
 
267
        </tr>
 
268
        <tr>
 
269
          <td class="paramkey"></td>
 
270
          <td></td>
 
271
          <td class="paramtype">const char *&nbsp;</td>
 
272
          <td class="paramname"> <em>text_end</em></td><td>&nbsp;</td>
 
273
        </tr>
 
274
        <tr>
 
275
          <td></td>
 
276
          <td>)</td>
 
277
          <td></td><td></td><td></td>
 
278
        </tr>
 
279
      </table>
 
280
</div>
 
281
<div class="memdoc">
 
282
 
 
283
<p>
 
284
Feed some data to the <a class="el" href="classGlib_1_1Markup_1_1ParseContext.html" title="A parse context is used to parse marked-up documents.">ParseContext</a>. 
 
285
<p>
 
286
The data need not be valid UTF-8; an error will be signalled if it's invalid. The data need not be an entire document; you can feed a document into the parser incrementally, via multiple calls to this function. Typically, as you receive data from a network connection or file, you feed each received chunk of data into this function, aborting the process if an error occurs. Once an error is reported, no further data may be fed to the <a class="el" href="classGlib_1_1Markup_1_1ParseContext.html" title="A parse context is used to parse marked-up documents.">ParseContext</a>; all errors are fatal. <dl compact><dt><b>Parameters:</b></dt><dd>
 
287
  <table border="0" cellspacing="2" cellpadding="0">
 
288
    <tr><td valign="top"></td><td valign="top"><em>text_begin</em>&nbsp;</td><td>Begin of chunk of text to parse. </td></tr>
 
289
    <tr><td valign="top"></td><td valign="top"><em>text_end</em>&nbsp;</td><td>End of chunk of text to parse. </td></tr>
 
290
  </table>
 
291
</dl>
 
292
<dl compact><dt><b>Exceptions:</b></dt><dd>
 
293
  <table border="0" cellspacing="2" cellpadding="0">
 
294
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classGlib_1_1MarkupError.html" title="Exception class for markup parsing errors.">Glib::MarkupError</a></em>&nbsp;</td><td></td></tr>
 
295
  </table>
 
296
</dl>
 
297
 
 
298
</div>
 
299
</div><p>
 
300
<a class="anchor" name="1158f306b9d7211d97fa02fdfbfddf50"></a><!-- doxytag: member="Glib::Markup::ParseContext::parse" ref="1158f306b9d7211d97fa02fdfbfddf50" args="(const Glib::ustring &amp;text)" -->
 
301
<div class="memitem">
 
302
<div class="memproto">
 
303
      <table class="memname">
 
304
        <tr>
 
305
          <td class="memname">void Glib::Markup::ParseContext::parse           </td>
 
306
          <td>(</td>
 
307
          <td class="paramtype">const <a class="el" href="classGlib_1_1ustring.html">Glib::ustring</a>&amp;&nbsp;</td>
 
308
          <td class="paramname"> <em>text</em>          </td>
324
309
          <td>&nbsp;)&nbsp;</td>
325
 
          <td> const<code> [inline]</code></td>
 
310
          <td></td>
326
311
        </tr>
327
312
      </table>
328
313
</div>
329
314
<div class="memdoc">
330
315
 
331
316
<p>
 
317
Feed some data to the <a class="el" href="classGlib_1_1Markup_1_1ParseContext.html" title="A parse context is used to parse marked-up documents.">ParseContext</a>. 
 
318
<p>
 
319
The data need not be valid UTF-8; an error will be signalled if it's invalid. The data need not be an entire document; you can feed a document into the parser incrementally, via multiple calls to this function. Typically, as you receive data from a network connection or file, you feed each received chunk of data into this function, aborting the process if an error occurs. Once an error is reported, no further data may be fed to the <a class="el" href="classGlib_1_1Markup_1_1ParseContext.html" title="A parse context is used to parse marked-up documents.">ParseContext</a>; all errors are fatal. <dl compact><dt><b>Parameters:</b></dt><dd>
 
320
  <table border="0" cellspacing="2" cellpadding="0">
 
321
    <tr><td valign="top"></td><td valign="top"><em>text</em>&nbsp;</td><td>Chunk of text to parse. </td></tr>
 
322
  </table>
 
323
</dl>
 
324
<dl compact><dt><b>Exceptions:</b></dt><dd>
 
325
  <table border="0" cellspacing="2" cellpadding="0">
 
326
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classGlib_1_1MarkupError.html" title="Exception class for markup parsing errors.">Glib::MarkupError</a></em>&nbsp;</td><td></td></tr>
 
327
  </table>
 
328
</dl>
332
329
 
333
330
</div>
334
331
</div><p>
339
336
 
340
337
<hr><address><small>
341
338
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
342
 
Doxygen</a> 1.5.6 &copy;&nbsp;1997-2001</small></address>
 
339
Doxygen</a> 1.5.8 &copy;&nbsp;1997-2001</small></address>
 
340
</body>
 
341
</html>
 
342
tent -->
 
343
 
 
344
<hr><address><small>
 
345
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
 
346
Doxygen</a> 1.5.8 &copy;&nbsp;1997-2001</small></address>
343
347
</body>
344
348
</html>