Debian Codegraph @

doc/html/gsf-XML-and-libxml.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>XML and libxml: GSF Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="GSF Reference Manual">
8 <link rel="up" href="parsers.html" title="Stream Parsers">
9 <link rel="prev" href="gsf-Text.html" title="Text">
10 <link rel="next" href="gsf-Zip.html" title="Zip files">
11 <meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gsf-XML-and-libxml.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#gsf-XML-and-libxml.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
20 <a href="#gsf-XML-and-libxml.properties" class="shortcut">Properties</a></span>
21 </td>
22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23 <td><a accesskey="u" href="parsers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24 <td><a accesskey="p" href="gsf-Text.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25 <td><a accesskey="n" href="gsf-Zip.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26 </tr></table>
27 <div class="refentry">
28 <a name="gsf-XML-and-libxml"></a><div class="titlepage"></div>
29 <div class="refnamediv"><table width="100%"><tr>
30 <td valign="top">
31 <h2><span class="refentrytitle"><a name="gsf-XML-and-libxml.top_of_page"></a>XML and libxml</span></h2>
32 <p>XML and libxml</p>
33 </td>
34 <td class="gallery_image" valign="top" align="right"></td>
35 </tr></table></div>
36 <div class="refsect1">
37 <a name="gsf-XML-and-libxml.functions"></a><h2>Functions</h2>
38 <div class="informaltable"><table class="informaltable" width="100%" border="0">
39 <colgroup>
40 <col width="150px" class="functions_proto_type">
41 <col class="functions_proto_name">
42 </colgroup>
43 <tbody>
44 <tr>
45 <td class="function_type">
46 <span class="returnvalue">gboolean</span>
47 </td>
48 <td class="function_name">
49 <span class="c_punctuation">(</span><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInUnknownFunc" title="GsfXMLInUnknownFunc ()">*GsfXMLInUnknownFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <span class="returnvalue">void</span>
55 </td>
56 <td class="function_name">
57 <span class="c_punctuation">(</span><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInExtDtor" title="GsfXMLInExtDtor ()">*GsfXMLInExtDtor</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <span class="returnvalue">gboolean</span>
63 </td>
64 <td class="function_name">
65 <span class="c_punctuation">(</span><a class="link" href="gsf-XML-and-libxml.html#GsfXMLProbeFunc" title="GsfXMLProbeFunc ()">*GsfXMLProbeFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 <tr>
69 <td class="define_keyword">#define</td>
70 <td class="function_name">
71 <a class="link" href="gsf-XML-and-libxml.html#GSF-XML-IN-NODE-FULL:CAPS" title="GSF_XML_IN_NODE_FULL()">GSF_XML_IN_NODE_FULL</a><span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="define_keyword">#define</td>
76 <td class="function_name">
77 <a class="link" href="gsf-XML-and-libxml.html#GSF-XML-IN-NODE:CAPS" title="GSF_XML_IN_NODE()">GSF_XML_IN_NODE</a><span class="c_punctuation">()</span>
78 </td>
79 </tr>
80 <tr>
81 <td class="define_keyword">#define</td>
82 <td class="function_name">
83 <a class="link" href="gsf-XML-and-libxml.html#GSF-XML-IN-NS:CAPS" title="GSF_XML_IN_NS()">GSF_XML_IN_NS</a><span class="c_punctuation">()</span>
84 </td>
85 </tr>
86 <tr>
87 <td class="function_type">
88 <a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="returnvalue">GsfXMLInDoc</span></a> *
89 </td>
90 <td class="function_name">
91 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-in-doc-new" title="gsf_xml_in_doc_new ()">gsf_xml_in_doc_new</a> <span class="c_punctuation">()</span>
92 </td>
93 </tr>
94 <tr>
95 <td class="function_type">
96 <span class="returnvalue">void</span>
97 </td>
98 <td class="function_name">
99 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-in-doc-free" title="gsf_xml_in_doc_free ()">gsf_xml_in_doc_free</a> <span class="c_punctuation">()</span>
100 </td>
101 </tr>
102 <tr>
103 <td class="function_type">
104 <span class="returnvalue">void</span>
105 </td>
106 <td class="function_name">
107 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-in-doc-add-nodes" title="gsf_xml_in_doc_add_nodes ()">gsf_xml_in_doc_add_nodes</a> <span class="c_punctuation">()</span>
108 </td>
109 </tr>
110 <tr>
111 <td class="function_type">
112 <span class="returnvalue">gboolean</span>
113 </td>
114 <td class="function_name">
115 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-in-doc-parse" title="gsf_xml_in_doc_parse ()">gsf_xml_in_doc_parse</a> <span class="c_punctuation">()</span>
116 </td>
117 </tr>
118 <tr>
119 <td class="function_type">
120 <span class="returnvalue">void</span>
121 </td>
122 <td class="function_name">
123 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-in-doc-set-unknown-handler" title="gsf_xml_in_doc_set_unknown_handler ()">gsf_xml_in_doc_set_unknown_handler</a> <span class="c_punctuation">()</span>
124 </td>
125 </tr>
126 <tr>
127 <td class="function_type">
128 <span class="returnvalue">void</span>
129 </td>
130 <td class="function_name">
131 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-in-push-state" title="gsf_xml_in_push_state ()">gsf_xml_in_push_state</a> <span class="c_punctuation">()</span>
132 </td>
133 </tr>
134 <tr>
135 <td class="function_type">
136 <span class="returnvalue">gboolean</span>
137 </td>
138 <td class="function_name">
139 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-in-namecmp" title="gsf_xml_in_namecmp ()">gsf_xml_in_namecmp</a> <span class="c_punctuation">()</span>
140 </td>
141 </tr>
142 <tr>
143 <td class="function_type">
144 <span class="returnvalue">char</span> const *
145 </td>
146 <td class="function_name">
147 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-in-check-ns" title="gsf_xml_in_check_ns ()">gsf_xml_in_check_ns</a> <span class="c_punctuation">()</span>
148 </td>
149 </tr>
150 <tr>
151 <td class="function_type">
152 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
153 </td>
154 <td class="function_name">
155 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-in-get-input" title="gsf_xml_in_get_input ()">gsf_xml_in_get_input</a> <span class="c_punctuation">()</span>
156 </td>
157 </tr>
158 <tr>
159 <td class="function_type">
160 <span class="returnvalue">gboolean</span>
161 </td>
162 <td class="function_name">
163 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-probe" title="gsf_xml_probe ()">gsf_xml_probe</a> <span class="c_punctuation">()</span>
164 </td>
165 </tr>
166 <tr>
167 <td class="function_type">
168 <a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="returnvalue">GsfXMLOut</span></a> *
169 </td>
170 <td class="function_name">
171 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-new" title="gsf_xml_out_new ()">gsf_xml_out_new</a> <span class="c_punctuation">()</span>
172 </td>
173 </tr>
174 <tr>
175 <td class="function_type">
176 <span class="returnvalue">void</span>
177 </td>
178 <td class="function_name">
179 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-set-doc-type" title="gsf_xml_out_set_doc_type ()">gsf_xml_out_set_doc_type</a> <span class="c_punctuation">()</span>
180 </td>
181 </tr>
182 <tr>
183 <td class="function_type">
184 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
185 </td>
186 <td class="function_name">
187 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-get-output" title="gsf_xml_out_get_output ()">gsf_xml_out_get_output</a> <span class="c_punctuation">()</span>
188 </td>
189 </tr>
190 <tr>
191 <td class="function_type">
192 <span class="returnvalue">void</span>
193 </td>
194 <td class="function_name">
195 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-start-element" title="gsf_xml_out_start_element ()">gsf_xml_out_start_element</a> <span class="c_punctuation">()</span>
196 </td>
197 </tr>
198 <tr>
199 <td class="function_type">
200 <span class="returnvalue">char</span> const *
201 </td>
202 <td class="function_name">
203 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-end-element" title="gsf_xml_out_end_element ()">gsf_xml_out_end_element</a> <span class="c_punctuation">()</span>
204 </td>
205 </tr>
206 <tr>
207 <td class="function_type">
208 <span class="returnvalue">void</span>
209 </td>
210 <td class="function_name">
211 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-cstr" title="gsf_xml_out_add_cstr ()">gsf_xml_out_add_cstr</a> <span class="c_punctuation">()</span>
212 </td>
213 </tr>
214 <tr>
215 <td class="function_type">
216 <span class="returnvalue">void</span>
217 </td>
218 <td class="function_name">
219 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-cstr-unchecked" title="gsf_xml_out_add_cstr_unchecked ()">gsf_xml_out_add_cstr_unchecked</a> <span class="c_punctuation">()</span>
220 </td>
221 </tr>
222 <tr>
223 <td class="function_type">
224 <span class="returnvalue">void</span>
225 </td>
226 <td class="function_name">
227 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-bool" title="gsf_xml_out_add_bool ()">gsf_xml_out_add_bool</a> <span class="c_punctuation">()</span>
228 </td>
229 </tr>
230 <tr>
231 <td class="function_type">
232 <span class="returnvalue">void</span>
233 </td>
234 <td class="function_name">
235 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-int" title="gsf_xml_out_add_int ()">gsf_xml_out_add_int</a> <span class="c_punctuation">()</span>
236 </td>
237 </tr>
238 <tr>
239 <td class="function_type">
240 <span class="returnvalue">void</span>
241 </td>
242 <td class="function_name">
243 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-uint" title="gsf_xml_out_add_uint ()">gsf_xml_out_add_uint</a> <span class="c_punctuation">()</span>
244 </td>
245 </tr>
246 <tr>
247 <td class="function_type">
248 <span class="returnvalue">void</span>
249 </td>
250 <td class="function_name">
251 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-float" title="gsf_xml_out_add_float ()">gsf_xml_out_add_float</a> <span class="c_punctuation">()</span>
252 </td>
253 </tr>
254 <tr>
255 <td class="function_type">
256 <span class="returnvalue">void</span>
257 </td>
258 <td class="function_name">
259 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-enum" title="gsf_xml_out_add_enum ()">gsf_xml_out_add_enum</a> <span class="c_punctuation">()</span>
260 </td>
261 </tr>
262 <tr>
263 <td class="function_type">
264 <span class="returnvalue">void</span>
265 </td>
266 <td class="function_name">
267 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-color" title="gsf_xml_out_add_color ()">gsf_xml_out_add_color</a> <span class="c_punctuation">()</span>
268 </td>
269 </tr>
270 <tr>
271 <td class="function_type">
272 <span class="returnvalue">void</span>
273 </td>
274 <td class="function_name">
275 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-base64" title="gsf_xml_out_add_base64 ()">gsf_xml_out_add_base64</a> <span class="c_punctuation">()</span>
276 </td>
277 </tr>
278 <tr>
279 <td class="function_type">
280 <span class="returnvalue">void</span>
281 </td>
282 <td class="function_name">
283 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-add-gvalue" title="gsf_xml_out_add_gvalue ()">gsf_xml_out_add_gvalue</a> <span class="c_punctuation">()</span>
284 </td>
285 </tr>
286 <tr>
287 <td class="function_type">
288 <span class="returnvalue">void</span>
289 </td>
290 <td class="function_name">
291 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-simple-element" title="gsf_xml_out_simple_element ()">gsf_xml_out_simple_element</a> <span class="c_punctuation">()</span>
292 </td>
293 </tr>
294 <tr>
295 <td class="function_type">
296 <span class="returnvalue">void</span>
297 </td>
298 <td class="function_name">
299 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-simple-float-element" title="gsf_xml_out_simple_float_element ()">gsf_xml_out_simple_float_element</a> <span class="c_punctuation">()</span>
300 </td>
301 </tr>
302 <tr>
303 <td class="function_type">
304 <span class="returnvalue">void</span>
305 </td>
306 <td class="function_name">
307 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-out-simple-int-element" title="gsf_xml_out_simple_int_element ()">gsf_xml_out_simple_int_element</a> <span class="c_punctuation">()</span>
308 </td>
309 </tr>
310 <tr>
311 <td class="function_type">
312 <span class="returnvalue">gchar</span> *
313 </td>
314 <td class="function_name">
315 <a class="link" href="gsf-XML-and-libxml.html#gsf-input-http-get-content-type" title="gsf_input_http_get_content_type ()">gsf_input_http_get_content_type</a> <span class="c_punctuation">()</span>
316 </td>
317 </tr>
318 <tr>
319 <td class="function_type">
320 <span class="returnvalue">GType</span>
321 </td>
322 <td class="function_name">
323 <a class="link" href="gsf-XML-and-libxml.html#gsf-input-http-get-type" title="gsf_input_http_get_type ()">gsf_input_http_get_type</a> <span class="c_punctuation">()</span>
324 </td>
325 </tr>
326 <tr>
327 <td class="function_type">
328 <span class="returnvalue">gchar</span> *
329 </td>
330 <td class="function_name">
331 <a class="link" href="gsf-XML-and-libxml.html#gsf-input-http-get-url" title="gsf_input_http_get_url ()">gsf_input_http_get_url</a> <span class="c_punctuation">()</span>
332 </td>
333 </tr>
334 <tr>
335 <td class="function_type">
336 <span class="returnvalue">xmlParserCtxt</span> *
337 </td>
338 <td class="function_name">
339 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-parser-context" title="gsf_xml_parser_context ()">gsf_xml_parser_context</a> <span class="c_punctuation">()</span>
340 </td>
341 </tr>
342 <tr>
343 <td class="function_type">
344 <span class="returnvalue">gboolean</span>
345 </td>
346 <td class="function_name">
347 <a class="link" href="gsf-XML-and-libxml.html#gsf-xml-gvalue-from-str" title="gsf_xml_gvalue_from_str ()">gsf_xml_gvalue_from_str</a> <span class="c_punctuation">()</span>
348 </td>
349 </tr>
350 <tr>
351 <td class="function_type">
352 <span class="returnvalue">int</span>
353 </td>
354 <td class="function_name">
355 <a class="link" href="gsf-XML-and-libxml.html#gsf-xmlDocFormatDump" title="gsf_xmlDocFormatDump ()">gsf_xmlDocFormatDump</a> <span class="c_punctuation">()</span>
356 </td>
357 </tr>
358 </tbody>
359 </table></div>
360 </div>
361 <div class="refsect1">
362 <a name="gsf-XML-and-libxml.properties"></a><h2>Properties</h2>
363 <div class="informaltable"><table class="informaltable" border="0">
364 <colgroup>
365 <col width="150px" class="properties_type">
366 <col width="300px" class="properties_name">
367 <col width="200px" class="properties_flags">
368 </colgroup>
369 <tbody>
370 <tr>
371 <td class="property_type"><span class="type">gboolean</span></td>
372 <td class="property_name"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut--pretty-print" title="The “pretty-print” property">pretty-print</a></td>
373 <td class="property_flags">Read / Write</td>
374 </tr>
375 <tr>
376 <td class="property_type">
377 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</td>
378 <td class="property_name"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut--sink" title="The “sink” property">sink</a></td>
379 <td class="property_flags">Read / Write / Construct Only</td>
380 </tr>
381 </tbody>
382 </table></div>
383 </div>
384 <a name="GsfInputHTTP"></a><a name="GsfXMLOut"></a><div class="refsect1">
385 <a name="gsf-XML-and-libxml.other"></a><h2>Types and Values</h2>
386 <div class="informaltable"><table class="informaltable" width="100%" border="0">
387 <colgroup>
388 <col width="150px" class="other_proto_type">
389 <col class="other_proto_name">
390 </colgroup>
391 <tbody>
392 <tr>
393 <td class="datatype_keyword"> </td>
394 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn">GsfXMLIn</a></td>
395 </tr>
396 <tr>
397 <td class="datatype_keyword"> </td>
398 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc">GsfXMLInDoc</a></td>
399 </tr>
400 <tr>
401 <td class="datatype_keyword"> </td>
402 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNS" title="GsfXMLInNS">GsfXMLInNS</a></td>
403 </tr>
404 <tr>
405 <td class="datatype_keyword"> </td>
406 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNode" title="GsfXMLInNode">GsfXMLInNode</a></td>
407 </tr>
408 <tr>
409 <td class="datatype_keyword">enum</td>
410 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLContent" title="enum GsfXMLContent">GsfXMLContent</a></td>
411 </tr>
412 <tr>
413 <td class="datatype_keyword"> </td>
414 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLBlob" title="GsfXMLBlob">GsfXMLBlob</a></td>
415 </tr>
416 <tr>
417 <td class="datatype_keyword"> </td>
418 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GsfInputHTTP-struct" title="GsfInputHTTP">GsfInputHTTP</a></td>
419 </tr>
420 <tr>
421 <td class="define_keyword">#define</td>
422 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GSF-XML-IN-NODE-END:CAPS" title="GSF_XML_IN_NODE_END">GSF_XML_IN_NODE_END</a></td>
423 </tr>
424 <tr>
425 <td class="define_keyword">#define</td>
426 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GSF-XML-IN-NS-END:CAPS" title="GSF_XML_IN_NS_END">GSF_XML_IN_NS_END</a></td>
427 </tr>
428 <tr>
429 <td class="datatype_keyword"> </td>
430 <td class="function_name"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut-struct" title="GsfXMLOut">GsfXMLOut</a></td>
431 </tr>
432 </tbody>
433 </table></div>
434 </div>
435 <div class="refsect1">
436 <a name="gsf-XML-and-libxml.object-hierarchy"></a><h2>Object Hierarchy</h2>
437 <pre class="screen"> GObject
438 <span class="lineart">├──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
439 <span class="lineart">│</span> <span class="lineart">╰──</span> GsfInputHTTP
440 <span class="lineart">╰──</span> GsfXMLOut
441 </pre>
442 </div>
443 <div class="refsect1">
444 <a name="gsf-XML-and-libxml.description"></a><h2>Description</h2>
445 </div>
446 <div class="refsect1">
447 <a name="gsf-XML-and-libxml.functions_details"></a><h2>Functions</h2>
448 <div class="refsect2">
449 <a name="GsfXMLInUnknownFunc"></a><h3>GsfXMLInUnknownFunc ()</h3>
450 <pre class="programlisting"><span class="returnvalue">gboolean</span>
451 <span class="c_punctuation">(</span>*GsfXMLInUnknownFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a> *xin</code></em>,
452 <em class="parameter"><code><span class="type">xmlChar</span> const *elem</code></em>,
453 <em class="parameter"><code><span class="type">xmlChar</span> const **attrs</code></em>);</pre>
454 </div>
455 <hr>
456 <div class="refsect2">
457 <a name="GsfXMLInExtDtor"></a><h3>GsfXMLInExtDtor ()</h3>
458 <pre class="programlisting"><span class="returnvalue">void</span>
459 <span class="c_punctuation">(</span>*GsfXMLInExtDtor<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a> *xin</code></em>,
460 <em class="parameter"><code><span class="type">gpointer</span> old_state</code></em>);</pre>
461 </div>
462 <hr>
463 <div class="refsect2">
464 <a name="GsfXMLProbeFunc"></a><h3>GsfXMLProbeFunc ()</h3>
465 <pre class="programlisting"><span class="returnvalue">gboolean</span>
466 <span class="c_punctuation">(</span>*GsfXMLProbeFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">xmlChar</span> *name</code></em>,
467 <em class="parameter"><code>const <span class="type">xmlChar</span> *prefix</code></em>,
468 <em class="parameter"><code>const <span class="type">xmlChar</span> *URI</code></em>,
469 <em class="parameter"><code><span class="type">int</span> nb_namespaces</code></em>,
470 <em class="parameter"><code>const <span class="type">xmlChar</span> **namespaces</code></em>,
471 <em class="parameter"><code><span class="type">int</span> nb_attributes</code></em>,
472 <em class="parameter"><code><span class="type">int</span> nb_defaulted</code></em>,
473 <em class="parameter"><code>const <span class="type">xmlChar</span> **attributes</code></em>);</pre>
474 </div>
475 <hr>
476 <div class="refsect2">
477 <a name="GSF-XML-IN-NODE-FULL:CAPS"></a><h3>GSF_XML_IN_NODE_FULL()</h3>
478 <pre class="programlisting">#define GSF_XML_IN_NODE_FULL(parent_id, id, ns, name, has_content, \
479 share_children_with_parent, check_ns, start, end, user)</pre>
480 </div>
481 <hr>
482 <div class="refsect2">
483 <a name="GSF-XML-IN-NODE:CAPS"></a><h3>GSF_XML_IN_NODE()</h3>
484 <pre class="programlisting">#define GSF_XML_IN_NODE(parent_id, id, ns, name, has_content, start, end)</pre>
485 </div>
486 <hr>
487 <div class="refsect2">
488 <a name="GSF-XML-IN-NS:CAPS"></a><h3>GSF_XML_IN_NS()</h3>
489 <pre class="programlisting">#define GSF_XML_IN_NS(id, uri)</pre>
490 </div>
491 <hr>
492 <div class="refsect2">
493 <a name="gsf-xml-in-doc-new"></a><h3>gsf_xml_in_doc_new ()</h3>
494 <pre class="programlisting"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="returnvalue">GsfXMLInDoc</span></a> *
495 gsf_xml_in_doc_new (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNode" title="GsfXMLInNode"><span class="type">GsfXMLInNode</span></a> const *nodes</code></em>,
496 <em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNS" title="GsfXMLInNS"><span class="type">GsfXMLInNS</span></a> const *ns</code></em>);</pre>
497 <p>Combine the nodes in the <code class="literal">NULL</code> terminated array starting at <em class="parameter"><code>nodes</code></em>
498 with the
499 name spaces in the <code class="literal">NULL</code> terminated array starting at <em class="parameter"><code>ns</code></em>
500 . Prepare the
501 data structures necessary to validate a doument based on that description.</p>
502 <div class="refsect3">
503 <a name="gsf-xml-in-doc-new.parameters"></a><h4>Parameters</h4>
504 <div class="informaltable"><table class="informaltable" width="100%" border="0">
505 <colgroup>
506 <col width="150px" class="parameters_name">
507 <col class="parameters_description">
508 <col width="200px" class="parameters_annotations">
509 </colgroup>
510 <tbody>
511 <tr>
512 <td class="parameter_name"><p>nodes</p></td>
513 <td class="parameter_description"><p>an array of node descriptors. </p></td>
514 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
515 </tr>
516 <tr>
517 <td class="parameter_name"><p>ns</p></td>
518 <td class="parameter_description"><p>an array of namespace identifiers. </p></td>
519 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
520 </tr>
521 </tbody>
522 </table></div>
523 </div>
524 <div class="refsect3">
525 <a name="gsf-xml-in-doc-new.returns"></a><h4>Returns</h4>
526 <p>a <a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a>. </p>
527 <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
528 </div>
529 </div>
530 <hr>
531 <div class="refsect2">
532 <a name="gsf-xml-in-doc-free"></a><h3>gsf_xml_in_doc_free ()</h3>
533 <pre class="programlisting"><span class="returnvalue">void</span>
534 gsf_xml_in_doc_free (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a> *doc</code></em>);</pre>
535 <p>Free up resources</p>
536 <div class="refsect3">
537 <a name="gsf-xml-in-doc-free.parameters"></a><h4>Parameters</h4>
538 <div class="informaltable"><table class="informaltable" width="100%" border="0">
539 <colgroup>
540 <col width="150px" class="parameters_name">
541 <col class="parameters_description">
542 <col width="200px" class="parameters_annotations">
543 </colgroup>
544 <tbody><tr>
545 <td class="parameter_name"><p>doc</p></td>
546 <td class="parameter_description"><p>A <a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a></p></td>
547 <td class="parameter_annotations"> </td>
548 </tr></tbody>
549 </table></div>
550 </div>
551 </div>
552 <hr>
553 <div class="refsect2">
554 <a name="gsf-xml-in-doc-add-nodes"></a><h3>gsf_xml_in_doc_add_nodes ()</h3>
555 <pre class="programlisting"><span class="returnvalue">void</span>
556 gsf_xml_in_doc_add_nodes (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a> *doc</code></em>,
557 <em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNode" title="GsfXMLInNode"><span class="type">GsfXMLInNode</span></a> const *nodes</code></em>);</pre>
558 <p>Adds additional nodes to the structure of <em class="parameter"><code>doc</code></em>
559 </p>
560 <div class="refsect3">
561 <a name="gsf-xml-in-doc-add-nodes.parameters"></a><h4>Parameters</h4>
562 <div class="informaltable"><table class="informaltable" width="100%" border="0">
563 <colgroup>
564 <col width="150px" class="parameters_name">
565 <col class="parameters_description">
566 <col width="200px" class="parameters_annotations">
567 </colgroup>
568 <tbody>
569 <tr>
570 <td class="parameter_name"><p>doc</p></td>
571 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a></p></td>
572 <td class="parameter_annotations"> </td>
573 </tr>
574 <tr>
575 <td class="parameter_name"><p>nodes</p></td>
576 <td class="parameter_description"><p><code class="literal">NULL</code> terminated array of <a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNode" title="GsfXMLInNode"><span class="type">GsfXMLInNode</span></a>. </p></td>
577 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td>
578 </tr>
579 </tbody>
580 </table></div>
581 </div>
582 </div>
583 <hr>
584 <div class="refsect2">
585 <a name="gsf-xml-in-doc-parse"></a><h3>gsf_xml_in_doc_parse ()</h3>
586 <pre class="programlisting"><span class="returnvalue">gboolean</span>
587 gsf_xml_in_doc_parse (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a> *doc</code></em>,
588 <em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
589 <em class="parameter"><code><span class="type">gpointer</span> user_state</code></em>);</pre>
590 <p>Read an xml document from <em class="parameter"><code>input</code></em>
591 and parse based on the the descriptor in
592 <em class="parameter"><code>doc</code></em>
593 </p>
594 <div class="refsect3">
595 <a name="gsf-xml-in-doc-parse.parameters"></a><h4>Parameters</h4>
596 <div class="informaltable"><table class="informaltable" width="100%" border="0">
597 <colgroup>
598 <col width="150px" class="parameters_name">
599 <col class="parameters_description">
600 <col width="200px" class="parameters_annotations">
601 </colgroup>
602 <tbody>
603 <tr>
604 <td class="parameter_name"><p>doc</p></td>
605 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a></p></td>
606 <td class="parameter_annotations"> </td>
607 </tr>
608 <tr>
609 <td class="parameter_name"><p>input</p></td>
610 <td class="parameter_description"><p><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
611 <td class="parameter_annotations"> </td>
612 </tr>
613 <tr>
614 <td class="parameter_name"><p>user_state</p></td>
615 <td class="parameter_description"><p>arbitrary content stored in the parser</p></td>
616 <td class="parameter_annotations"> </td>
617 </tr>
618 </tbody>
619 </table></div>
620 </div>
621 <div class="refsect3">
622 <a name="gsf-xml-in-doc-parse.returns"></a><h4>Returns</h4>
623 <p> <code class="literal">FALSE</code> on error</p>
624 </div>
625 </div>
626 <hr>
627 <div class="refsect2">
628 <a name="gsf-xml-in-doc-set-unknown-handler"></a><h3>gsf_xml_in_doc_set_unknown_handler ()</h3>
629 <pre class="programlisting"><span class="returnvalue">void</span>
630 gsf_xml_in_doc_set_unknown_handler (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a> *doc</code></em>,
631 <em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInUnknownFunc" title="GsfXMLInUnknownFunc ()"><span class="type">GsfXMLInUnknownFunc</span></a> handler</code></em>);</pre>
632 <p>Call the function <em class="parameter"><code>handler</code></em>
633 when an unexpected child node is found</p>
634 <div class="refsect3">
635 <a name="gsf-xml-in-doc-set-unknown-handler.parameters"></a><h4>Parameters</h4>
636 <div class="informaltable"><table class="informaltable" width="100%" border="0">
637 <colgroup>
638 <col width="150px" class="parameters_name">
639 <col class="parameters_description">
640 <col width="200px" class="parameters_annotations">
641 </colgroup>
642 <tbody>
643 <tr>
644 <td class="parameter_name"><p>doc</p></td>
645 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a></p></td>
646 <td class="parameter_annotations"> </td>
647 </tr>
648 <tr>
649 <td class="parameter_name"><p>handler</p></td>
650 <td class="parameter_description"><p>The function to call. </p></td>
651 <td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
652 </tr>
653 </tbody>
654 </table></div>
655 </div>
656 </div>
657 <hr>
658 <div class="refsect2">
659 <a name="gsf-xml-in-push-state"></a><h3>gsf_xml_in_push_state ()</h3>
660 <pre class="programlisting"><span class="returnvalue">void</span>
661 gsf_xml_in_push_state (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a> *xin</code></em>,
662 <em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a> const *doc</code></em>,
663 <em class="parameter"><code><span class="type">gpointer</span> new_state</code></em>,
664 <em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInExtDtor" title="GsfXMLInExtDtor ()"><span class="type">GsfXMLInExtDtor</span></a> dtor</code></em>,
665 <em class="parameter"><code><span class="type">xmlChar</span> const **attrs</code></em>);</pre>
666 <p>Take the first node from <em class="parameter"><code>doc</code></em>
667 as the current node and call its start handler.</p>
668 <div class="refsect3">
669 <a name="gsf-xml-in-push-state.parameters"></a><h4>Parameters</h4>
670 <div class="informaltable"><table class="informaltable" width="100%" border="0">
671 <colgroup>
672 <col width="150px" class="parameters_name">
673 <col class="parameters_description">
674 <col width="200px" class="parameters_annotations">
675 </colgroup>
676 <tbody>
677 <tr>
678 <td class="parameter_name"><p>xin</p></td>
679 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a></p></td>
680 <td class="parameter_annotations"> </td>
681 </tr>
682 <tr>
683 <td class="parameter_name"><p>doc</p></td>
684 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a></p></td>
685 <td class="parameter_annotations"> </td>
686 </tr>
687 <tr>
688 <td class="parameter_name"><p>new_state</p></td>
689 <td class="parameter_description"><p>arbitrary content for the parser</p></td>
690 <td class="parameter_annotations"> </td>
691 </tr>
692 <tr>
693 <td class="parameter_name"><p>dtor</p></td>
694 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInExtDtor" title="GsfXMLInExtDtor ()"><span class="type">GsfXMLInExtDtor</span></a>. </p></td>
695 <td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
696 </tr>
697 <tr>
698 <td class="parameter_name"><p>attrs</p></td>
699 <td class="parameter_description"><p>array of xmlChar const *. </p></td>
700 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></td>
701 </tr>
702 </tbody>
703 </table></div>
704 </div>
705 </div>
706 <hr>
707 <div class="refsect2">
708 <a name="gsf-xml-in-namecmp"></a><h3>gsf_xml_in_namecmp ()</h3>
709 <pre class="programlisting"><span class="returnvalue">gboolean</span>
710 gsf_xml_in_namecmp (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a> const *xin</code></em>,
711 <em class="parameter"><code><span class="type">char</span> const *str</code></em>,
712 <em class="parameter"><code>unsigned <span class="type">int</span> ns_id</code></em>,
713 <em class="parameter"><code><span class="type">char</span> const *name</code></em>);</pre>
714 <p>Checks to see if <em class="parameter"><code>str</code></em>
715 is the same as <em class="parameter"><code>ns_id</code></em>
716 ::<em class="parameter"><code>name</code></em>
717 with either an explicit
718 namespace or the current default namespace.</p>
719 <div class="refsect3">
720 <a name="gsf-xml-in-namecmp.parameters"></a><h4>Parameters</h4>
721 <div class="informaltable"><table class="informaltable" width="100%" border="0">
722 <colgroup>
723 <col width="150px" class="parameters_name">
724 <col class="parameters_description">
725 <col width="200px" class="parameters_annotations">
726 </colgroup>
727 <tbody>
728 <tr>
729 <td class="parameter_name"><p>xin</p></td>
730 <td class="parameter_description"><p>The <a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a> we are reading from.</p></td>
731 <td class="parameter_annotations"> </td>
732 </tr>
733 <tr>
734 <td class="parameter_name"><p>str</p></td>
735 <td class="parameter_description"><p>The potentially namespace qualified node name.</p></td>
736 <td class="parameter_annotations"> </td>
737 </tr>
738 <tr>
739 <td class="parameter_name"><p>ns_id</p></td>
740 <td class="parameter_description"><p>The name space id to check</p></td>
741 <td class="parameter_annotations"> </td>
742 </tr>
743 <tr>
744 <td class="parameter_name"><p>name</p></td>
745 <td class="parameter_description"><p>The target node name</p></td>
746 <td class="parameter_annotations"> </td>
747 </tr>
748 </tbody>
749 </table></div>
750 </div>
751 <div class="refsect3">
752 <a name="gsf-xml-in-namecmp.returns"></a><h4>Returns</h4>
753 <p> <code class="literal">TRUE</code> if <em class="parameter"><code>str</code></em>
754 == <em class="parameter"><code>ns_id</code></em>
755 :<em class="parameter"><code>name</code></em>
756 according to <em class="parameter"><code>state</code></em>
757 .</p>
758 </div>
759 </div>
760 <hr>
761 <div class="refsect2">
762 <a name="gsf-xml-in-check-ns"></a><h3>gsf_xml_in_check_ns ()</h3>
763 <pre class="programlisting"><span class="returnvalue">char</span> const *
764 gsf_xml_in_check_ns (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a> const *xin</code></em>,
765 <em class="parameter"><code><span class="type">char</span> const *str</code></em>,
766 <em class="parameter"><code>unsigned <span class="type">int</span> ns_id</code></em>);</pre>
767 <p>According to <em class="parameter"><code>state</code></em>
768 is <em class="parameter"><code>str</code></em>
769 in the namespace <em class="parameter"><code>ns_id</code></em>
770 ?</p>
771 <div class="refsect3">
772 <a name="gsf-xml-in-check-ns.parameters"></a><h4>Parameters</h4>
773 <div class="informaltable"><table class="informaltable" width="100%" border="0">
774 <colgroup>
775 <col width="150px" class="parameters_name">
776 <col class="parameters_description">
777 <col width="200px" class="parameters_annotations">
778 </colgroup>
779 <tbody>
780 <tr>
781 <td class="parameter_name"><p>xin</p></td>
782 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a></p></td>
783 <td class="parameter_annotations"> </td>
784 </tr>
785 <tr>
786 <td class="parameter_name"><p>str</p></td>
787 <td class="parameter_description"><p>string to check</p></td>
788 <td class="parameter_annotations"> </td>
789 </tr>
790 <tr>
791 <td class="parameter_name"><p>ns_id</p></td>
792 <td class="parameter_description"><p>the namespace id</p></td>
793 <td class="parameter_annotations"> </td>
794 </tr>
795 </tbody>
796 </table></div>
797 </div>
798 <div class="refsect3">
799 <a name="gsf-xml-in-check-ns.returns"></a><h4>Returns</h4>
800 <p>a pointer to <em class="parameter"><code>str</code></em>
801 after the namespace
802 if successful, otherwise <code class="literal">NULL</code>. </p>
803 <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
804 </div>
805 </div>
806 <hr>
807 <div class="refsect2">
808 <a name="gsf-xml-in-get-input"></a><h3>gsf_xml_in_get_input ()</h3>
809 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
810 gsf_xml_in_get_input (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a> const *xin</code></em>);</pre>
811 <p>(New in 1.14.2)</p>
812 <div class="refsect3">
813 <a name="gsf-xml-in-get-input.parameters"></a><h4>Parameters</h4>
814 <div class="informaltable"><table class="informaltable" width="100%" border="0">
815 <colgroup>
816 <col width="150px" class="parameters_name">
817 <col class="parameters_description">
818 <col width="200px" class="parameters_annotations">
819 </colgroup>
820 <tbody><tr>
821 <td class="parameter_name"><p>xin</p></td>
822 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a></p></td>
823 <td class="parameter_annotations"> </td>
824 </tr></tbody>
825 </table></div>
826 </div>
827 <div class="refsect3">
828 <a name="gsf-xml-in-get-input.returns"></a><h4>Returns</h4>
829 <p>(but does not reference) the stream being parsed. </p>
830 <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
831 </div>
832 </div>
833 <hr>
834 <div class="refsect2">
835 <a name="gsf-xml-probe"></a><h3>gsf_xml_probe ()</h3>
836 <pre class="programlisting"><span class="returnvalue">gboolean</span>
837 gsf_xml_probe (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
838 <em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLProbeFunc" title="GsfXMLProbeFunc ()"><span class="type">GsfXMLProbeFunc</span></a> func</code></em>);</pre>
839 <div class="refsect3">
840 <a name="gsf-xml-probe.parameters"></a><h4>Parameters</h4>
841 <div class="informaltable"><table class="informaltable" width="100%" border="0">
842 <colgroup>
843 <col width="150px" class="parameters_name">
844 <col class="parameters_description">
845 <col width="200px" class="parameters_annotations">
846 </colgroup>
847 <tbody>
848 <tr>
849 <td class="parameter_name"><p>input</p></td>
850 <td class="parameter_description"><p><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
851 <td class="parameter_annotations"> </td>
852 </tr>
853 <tr>
854 <td class="parameter_name"><p>func</p></td>
855 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLProbeFunc" title="GsfXMLProbeFunc ()"><span class="type">GsfXMLProbeFunc</span></a>. </p></td>
856 <td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
857 </tr>
858 </tbody>
859 </table></div>
860 </div>
861 <div class="refsect3">
862 <a name="gsf-xml-probe.returns"></a><h4>Returns</h4>
863 <p> TRUE on success.</p>
864 </div>
865 </div>
866 <hr>
867 <div class="refsect2">
868 <a name="gsf-xml-out-new"></a><h3>gsf_xml_out_new ()</h3>
869 <pre class="programlisting"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="returnvalue">GsfXMLOut</span></a> *
870 gsf_xml_out_new (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>);</pre>
871 <p>Create an XML output stream.</p>
872 <div class="refsect3">
873 <a name="gsf-xml-out-new.parameters"></a><h4>Parameters</h4>
874 <div class="informaltable"><table class="informaltable" width="100%" border="0">
875 <colgroup>
876 <col width="150px" class="parameters_name">
877 <col class="parameters_description">
878 <col width="200px" class="parameters_annotations">
879 </colgroup>
880 <tbody><tr>
881 <td class="parameter_name"><p>output</p></td>
882 <td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
883 <td class="parameter_annotations"> </td>
884 </tr></tbody>
885 </table></div>
886 </div>
887 <div class="refsect3">
888 <a name="gsf-xml-out-new.returns"></a><h4>Returns</h4>
889 <p> <a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p>
890 </div>
891 </div>
892 <hr>
893 <div class="refsect2">
894 <a name="gsf-xml-out-set-doc-type"></a><h3>gsf_xml_out_set_doc_type ()</h3>
895 <pre class="programlisting"><span class="returnvalue">void</span>
896 gsf_xml_out_set_doc_type (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
897 <em class="parameter"><code><span class="type">char</span> const *type</code></em>);</pre>
898 <p>Store some optional &lt;!DOCTYPE .. &gt; content</p>
899 <div class="refsect3">
900 <a name="gsf-xml-out-set-doc-type.parameters"></a><h4>Parameters</h4>
901 <div class="informaltable"><table class="informaltable" width="100%" border="0">
902 <colgroup>
903 <col width="150px" class="parameters_name">
904 <col class="parameters_description">
905 <col width="200px" class="parameters_annotations">
906 </colgroup>
907 <tbody>
908 <tr>
909 <td class="parameter_name"><p>xout</p></td>
910 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
911 <td class="parameter_annotations"> </td>
912 </tr>
913 <tr>
914 <td class="parameter_name"><p>type</p></td>
915 <td class="parameter_description"><p>the document type declaration</p></td>
916 <td class="parameter_annotations"> </td>
917 </tr>
918 </tbody>
919 </table></div>
920 </div>
921 </div>
922 <hr>
923 <div class="refsect2">
924 <a name="gsf-xml-out-get-output"></a><h3>gsf_xml_out_get_output ()</h3>
925 <pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
926 gsf_xml_out_get_output (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> const *xout</code></em>);</pre>
927 <p>Get the <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> we are writing to..</p>
928 <div class="refsect3">
929 <a name="gsf-xml-out-get-output.parameters"></a><h4>Parameters</h4>
930 <div class="informaltable"><table class="informaltable" width="100%" border="0">
931 <colgroup>
932 <col width="150px" class="parameters_name">
933 <col class="parameters_description">
934 <col width="200px" class="parameters_annotations">
935 </colgroup>
936 <tbody><tr>
937 <td class="parameter_name"><p>xout</p></td>
938 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
939 <td class="parameter_annotations"> </td>
940 </tr></tbody>
941 </table></div>
942 </div>
943 <div class="refsect3">
944 <a name="gsf-xml-out-get-output.returns"></a><h4>Returns</h4>
945 <p><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>. </p>
946 <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
947 </div>
948 </div>
949 <hr>
950 <div class="refsect2">
951 <a name="gsf-xml-out-start-element"></a><h3>gsf_xml_out_start_element ()</h3>
952 <pre class="programlisting"><span class="returnvalue">void</span>
953 gsf_xml_out_start_element (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
954 <em class="parameter"><code><span class="type">char</span> const *id</code></em>);</pre>
955 <p>Output a start element <em class="parameter"><code>id</code></em>
956 , if necessary preceeded by an XML declaration.</p>
957 <div class="refsect3">
958 <a name="gsf-xml-out-start-element.parameters"></a><h4>Parameters</h4>
959 <div class="informaltable"><table class="informaltable" width="100%" border="0">
960 <colgroup>
961 <col width="150px" class="parameters_name">
962 <col class="parameters_description">
963 <col width="200px" class="parameters_annotations">
964 </colgroup>
965 <tbody>
966 <tr>
967 <td class="parameter_name"><p>xout</p></td>
968 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
969 <td class="parameter_annotations"> </td>
970 </tr>
971 <tr>
972 <td class="parameter_name"><p>id</p></td>
973 <td class="parameter_description"><p>Element name</p></td>
974 <td class="parameter_annotations"> </td>
975 </tr>
976 </tbody>
977 </table></div>
978 </div>
979 </div>
980 <hr>
981 <div class="refsect2">
982 <a name="gsf-xml-out-end-element"></a><h3>gsf_xml_out_end_element ()</h3>
983 <pre class="programlisting"><span class="returnvalue">char</span> const *
984 gsf_xml_out_end_element (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>);</pre>
985 <p>Closes/ends an XML element.</p>
986 <div class="refsect3">
987 <a name="gsf-xml-out-end-element.parameters"></a><h4>Parameters</h4>
988 <div class="informaltable"><table class="informaltable" width="100%" border="0">
989 <colgroup>
990 <col width="150px" class="parameters_name">
991 <col class="parameters_description">
992 <col width="200px" class="parameters_annotations">
993 </colgroup>
994 <tbody><tr>
995 <td class="parameter_name"><p>xout</p></td>
996 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
997 <td class="parameter_annotations"> </td>
998 </tr></tbody>
999 </table></div>
1000 </div>
1001 <div class="refsect3">
1002 <a name="gsf-xml-out-end-element.returns"></a><h4>Returns</h4>
1003 <p>the element that has been closed. </p>
1004 <p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
1005 </div>
1006 </div>
1007 <hr>
1008 <div class="refsect2">
1009 <a name="gsf-xml-out-add-cstr"></a><h3>gsf_xml_out_add_cstr ()</h3>
1010 <pre class="programlisting"><span class="returnvalue">void</span>
1011 gsf_xml_out_add_cstr (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1012 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1013 <em class="parameter"><code><span class="type">char</span> const *val_utf8</code></em>);</pre>
1014 <p>dump <em class="parameter"><code>val_utf8</code></em>
1015 to an attribute named <em class="parameter"><code>id</code></em>
1016 or as the nodes content escaping
1017 characters as necessary. If <em class="parameter"><code>val_utf8</code></em>
1018 is <code class="literal">NULL</code> do nothing (no warning, no
1019 output)</p>
1020 <div class="refsect3">
1021 <a name="gsf-xml-out-add-cstr.parameters"></a><h4>Parameters</h4>
1022 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1023 <colgroup>
1024 <col width="150px" class="parameters_name">
1025 <col class="parameters_description">
1026 <col width="200px" class="parameters_annotations">
1027 </colgroup>
1028 <tbody>
1029 <tr>
1030 <td class="parameter_name"><p>xout</p></td>
1031 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1032 <td class="parameter_annotations"> </td>
1033 </tr>
1034 <tr>
1035 <td class="parameter_name"><p>id</p></td>
1036 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1037 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1038 </tr>
1039 <tr>
1040 <td class="parameter_name"><p>val_utf8</p></td>
1041 <td class="parameter_description"><p>a utf8 encoded string. </p></td>
1042 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1043 </tr>
1044 </tbody>
1045 </table></div>
1046 </div>
1047 </div>
1048 <hr>
1049 <div class="refsect2">
1050 <a name="gsf-xml-out-add-cstr-unchecked"></a><h3>gsf_xml_out_add_cstr_unchecked ()</h3>
1051 <pre class="programlisting"><span class="returnvalue">void</span>
1052 gsf_xml_out_add_cstr_unchecked (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1053 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1054 <em class="parameter"><code><span class="type">char</span> const *val_utf8</code></em>);</pre>
1055 <p>dump <em class="parameter"><code>val_utf8</code></em>
1056 to an attribute named <em class="parameter"><code>id</code></em>
1057 without checking to see if
1058 the content needs escaping. A useful performance enhancement when
1059 the application knows that structure of the content well. If
1060 <em class="parameter"><code>val_utf8</code></em>
1061 is <code class="literal">NULL</code> do nothing (no warning, no output)</p>
1062 <div class="refsect3">
1063 <a name="gsf-xml-out-add-cstr-unchecked.parameters"></a><h4>Parameters</h4>
1064 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1065 <colgroup>
1066 <col width="150px" class="parameters_name">
1067 <col class="parameters_description">
1068 <col width="200px" class="parameters_annotations">
1069 </colgroup>
1070 <tbody>
1071 <tr>
1072 <td class="parameter_name"><p>xout</p></td>
1073 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1074 <td class="parameter_annotations"> </td>
1075 </tr>
1076 <tr>
1077 <td class="parameter_name"><p>id</p></td>
1078 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1079 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1080 </tr>
1081 <tr>
1082 <td class="parameter_name"><p>val_utf8</p></td>
1083 <td class="parameter_description"><p>a utf8 encoded string to export. </p></td>
1084 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1085 </tr>
1086 </tbody>
1087 </table></div>
1088 </div>
1089 </div>
1090 <hr>
1091 <div class="refsect2">
1092 <a name="gsf-xml-out-add-bool"></a><h3>gsf_xml_out_add_bool ()</h3>
1093 <pre class="programlisting"><span class="returnvalue">void</span>
1094 gsf_xml_out_add_bool (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1095 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1096 <em class="parameter"><code><span class="type">gboolean</span> val</code></em>);</pre>
1097 <p>dump boolean value <em class="parameter"><code>val</code></em>
1098 to an attribute named <em class="parameter"><code>id</code></em>
1099 or as the nodes content
1100 Use '1' or '0' to simplify import</p>
1101 <div class="refsect3">
1102 <a name="gsf-xml-out-add-bool.parameters"></a><h4>Parameters</h4>
1103 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1104 <colgroup>
1105 <col width="150px" class="parameters_name">
1106 <col class="parameters_description">
1107 <col width="200px" class="parameters_annotations">
1108 </colgroup>
1109 <tbody>
1110 <tr>
1111 <td class="parameter_name"><p>xout</p></td>
1112 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1113 <td class="parameter_annotations"> </td>
1114 </tr>
1115 <tr>
1116 <td class="parameter_name"><p>id</p></td>
1117 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1118 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1119 </tr>
1120 <tr>
1121 <td class="parameter_name"><p>val</p></td>
1122 <td class="parameter_description"><p>a boolean</p></td>
1123 <td class="parameter_annotations"> </td>
1124 </tr>
1125 </tbody>
1126 </table></div>
1127 </div>
1128 </div>
1129 <hr>
1130 <div class="refsect2">
1131 <a name="gsf-xml-out-add-int"></a><h3>gsf_xml_out_add_int ()</h3>
1132 <pre class="programlisting"><span class="returnvalue">void</span>
1133 gsf_xml_out_add_int (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1134 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1135 <em class="parameter"><code><span class="type">int</span> val</code></em>);</pre>
1136 <p>dump integer value <em class="parameter"><code>val</code></em>
1137 to an attribute named <em class="parameter"><code>id</code></em>
1138 or as the nodes content</p>
1139 <div class="refsect3">
1140 <a name="gsf-xml-out-add-int.parameters"></a><h4>Parameters</h4>
1141 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1142 <colgroup>
1143 <col width="150px" class="parameters_name">
1144 <col class="parameters_description">
1145 <col width="200px" class="parameters_annotations">
1146 </colgroup>
1147 <tbody>
1148 <tr>
1149 <td class="parameter_name"><p>xout</p></td>
1150 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1151 <td class="parameter_annotations"> </td>
1152 </tr>
1153 <tr>
1154 <td class="parameter_name"><p>id</p></td>
1155 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1156 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1157 </tr>
1158 <tr>
1159 <td class="parameter_name"><p>val</p></td>
1160 <td class="parameter_description"><p>the value</p></td>
1161 <td class="parameter_annotations"> </td>
1162 </tr>
1163 </tbody>
1164 </table></div>
1165 </div>
1166 </div>
1167 <hr>
1168 <div class="refsect2">
1169 <a name="gsf-xml-out-add-uint"></a><h3>gsf_xml_out_add_uint ()</h3>
1170 <pre class="programlisting"><span class="returnvalue">void</span>
1171 gsf_xml_out_add_uint (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1172 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1173 <em class="parameter"><code>unsigned <span class="type">int</span> val</code></em>);</pre>
1174 <p>dump unsigned integer value <em class="parameter"><code>val</code></em>
1175 to an attribute named <em class="parameter"><code>id</code></em>
1176 or as the nodes
1177 content</p>
1178 <div class="refsect3">
1179 <a name="gsf-xml-out-add-uint.parameters"></a><h4>Parameters</h4>
1180 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1181 <colgroup>
1182 <col width="150px" class="parameters_name">
1183 <col class="parameters_description">
1184 <col width="200px" class="parameters_annotations">
1185 </colgroup>
1186 <tbody>
1187 <tr>
1188 <td class="parameter_name"><p>xout</p></td>
1189 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1190 <td class="parameter_annotations"> </td>
1191 </tr>
1192 <tr>
1193 <td class="parameter_name"><p>id</p></td>
1194 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1195 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1196 </tr>
1197 <tr>
1198 <td class="parameter_name"><p>val</p></td>
1199 <td class="parameter_description"><p>the value</p></td>
1200 <td class="parameter_annotations"> </td>
1201 </tr>
1202 </tbody>
1203 </table></div>
1204 </div>
1205 </div>
1206 <hr>
1207 <div class="refsect2">
1208 <a name="gsf-xml-out-add-float"></a><h3>gsf_xml_out_add_float ()</h3>
1209 <pre class="programlisting"><span class="returnvalue">void</span>
1210 gsf_xml_out_add_float (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1211 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1212 <em class="parameter"><code><span class="type">double</span> val</code></em>,
1213 <em class="parameter"><code><span class="type">int</span> precision</code></em>);</pre>
1214 <p>dump float value <em class="parameter"><code>val</code></em>
1215 to an attribute named <em class="parameter"><code>id</code></em>
1216 or as the nodes
1217 content with precision <em class="parameter"><code>precision</code></em>
1218 . The number will be formattted
1219 according to the "C" locale.</p>
1220 <div class="refsect3">
1221 <a name="gsf-xml-out-add-float.parameters"></a><h4>Parameters</h4>
1222 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1223 <colgroup>
1224 <col width="150px" class="parameters_name">
1225 <col class="parameters_description">
1226 <col width="200px" class="parameters_annotations">
1227 </colgroup>
1228 <tbody>
1229 <tr>
1230 <td class="parameter_name"><p>xout</p></td>
1231 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1232 <td class="parameter_annotations"> </td>
1233 </tr>
1234 <tr>
1235 <td class="parameter_name"><p>id</p></td>
1236 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1237 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1238 </tr>
1239 <tr>
1240 <td class="parameter_name"><p>val</p></td>
1241 <td class="parameter_description"><p>the value</p></td>
1242 <td class="parameter_annotations"> </td>
1243 </tr>
1244 <tr>
1245 <td class="parameter_name"><p>precision</p></td>
1246 <td class="parameter_description"><p>the number of significant digits to use, -1 meaning "enough".</p></td>
1247 <td class="parameter_annotations"> </td>
1248 </tr>
1249 </tbody>
1250 </table></div>
1251 </div>
1252 </div>
1253 <hr>
1254 <div class="refsect2">
1255 <a name="gsf-xml-out-add-enum"></a><h3>gsf_xml_out_add_enum ()</h3>
1256 <pre class="programlisting"><span class="returnvalue">void</span>
1257 gsf_xml_out_add_enum (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1258 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1259 <em class="parameter"><code><span class="type">GType</span> etype</code></em>,
1260 <em class="parameter"><code><span class="type">gint</span> val</code></em>);</pre>
1261 <p>Output the name of value <em class="parameter"><code>val</code></em>
1262 of enumeration type <em class="parameter"><code>etype</code></em>
1263 .</p>
1264 <div class="refsect3">
1265 <a name="gsf-xml-out-add-enum.parameters"></a><h4>Parameters</h4>
1266 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1267 <colgroup>
1268 <col width="150px" class="parameters_name">
1269 <col class="parameters_description">
1270 <col width="200px" class="parameters_annotations">
1271 </colgroup>
1272 <tbody>
1273 <tr>
1274 <td class="parameter_name"><p>xout</p></td>
1275 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1276 <td class="parameter_annotations"> </td>
1277 </tr>
1278 <tr>
1279 <td class="parameter_name"><p>id</p></td>
1280 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1281 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1282 </tr>
1283 <tr>
1284 <td class="parameter_name"><p>etype</p></td>
1285 <td class="parameter_description"><p><span class="type">GType</span></p></td>
1286 <td class="parameter_annotations"> </td>
1287 </tr>
1288 <tr>
1289 <td class="parameter_name"><p>val</p></td>
1290 <td class="parameter_description"><p>enum element number</p></td>
1291 <td class="parameter_annotations"> </td>
1292 </tr>
1293 </tbody>
1294 </table></div>
1295 </div>
1296 </div>
1297 <hr>
1298 <div class="refsect2">
1299 <a name="gsf-xml-out-add-color"></a><h3>gsf_xml_out_add_color ()</h3>
1300 <pre class="programlisting"><span class="returnvalue">void</span>
1301 gsf_xml_out_add_color (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1302 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1303 <em class="parameter"><code>unsigned <span class="type">int</span> r</code></em>,
1304 <em class="parameter"><code>unsigned <span class="type">int</span> g</code></em>,
1305 <em class="parameter"><code>unsigned <span class="type">int</span> b</code></em>);</pre>
1306 <p>dump Color <em class="parameter"><code>r</code></em>
1307 .<em class="parameter"><code>g</code></em>
1308 .<em class="parameter"><code>b</code></em>
1309 to an attribute named <em class="parameter"><code>id</code></em>
1310 or as the nodes content</p>
1311 <div class="refsect3">
1312 <a name="gsf-xml-out-add-color.parameters"></a><h4>Parameters</h4>
1313 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1314 <colgroup>
1315 <col width="150px" class="parameters_name">
1316 <col class="parameters_description">
1317 <col width="200px" class="parameters_annotations">
1318 </colgroup>
1319 <tbody>
1320 <tr>
1321 <td class="parameter_name"><p>xout</p></td>
1322 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1323 <td class="parameter_annotations"> </td>
1324 </tr>
1325 <tr>
1326 <td class="parameter_name"><p>id</p></td>
1327 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1328 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1329 </tr>
1330 <tr>
1331 <td class="parameter_name"><p>r</p></td>
1332 <td class="parameter_description"><p>Red value</p></td>
1333 <td class="parameter_annotations"> </td>
1334 </tr>
1335 <tr>
1336 <td class="parameter_name"><p>g</p></td>
1337 <td class="parameter_description"><p>Green value</p></td>
1338 <td class="parameter_annotations"> </td>
1339 </tr>
1340 <tr>
1341 <td class="parameter_name"><p>b</p></td>
1342 <td class="parameter_description"><p>Blue value</p></td>
1343 <td class="parameter_annotations"> </td>
1344 </tr>
1345 </tbody>
1346 </table></div>
1347 </div>
1348 </div>
1349 <hr>
1350 <div class="refsect2">
1351 <a name="gsf-xml-out-add-base64"></a><h3>gsf_xml_out_add_base64 ()</h3>
1352 <pre class="programlisting"><span class="returnvalue">void</span>
1353 gsf_xml_out_add_base64 (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1354 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1355 <em class="parameter"><code><span class="type">guint8</span> const *data</code></em>,
1356 <em class="parameter"><code>unsigned <span class="type">int</span> len</code></em>);</pre>
1357 <p>Dump <em class="parameter"><code>len</code></em>
1358 bytes in <em class="parameter"><code>data</code></em>
1359 into the content of node <em class="parameter"><code>id</code></em>
1360 using base64</p>
1361 <div class="refsect3">
1362 <a name="gsf-xml-out-add-base64.parameters"></a><h4>Parameters</h4>
1363 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1364 <colgroup>
1365 <col width="150px" class="parameters_name">
1366 <col class="parameters_description">
1367 <col width="200px" class="parameters_annotations">
1368 </colgroup>
1369 <tbody>
1370 <tr>
1371 <td class="parameter_name"><p>xout</p></td>
1372 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1373 <td class="parameter_annotations"> </td>
1374 </tr>
1375 <tr>
1376 <td class="parameter_name"><p>id</p></td>
1377 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1378 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1379 </tr>
1380 <tr>
1381 <td class="parameter_name"><p>data</p></td>
1382 <td class="parameter_description"><p>Data to be written. </p></td>
1383 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len]</span></td>
1384 </tr>
1385 <tr>
1386 <td class="parameter_name"><p>len</p></td>
1387 <td class="parameter_description"><p>Length of data</p></td>
1388 <td class="parameter_annotations"> </td>
1389 </tr>
1390 </tbody>
1391 </table></div>
1392 </div>
1393 </div>
1394 <hr>
1395 <div class="refsect2">
1396 <a name="gsf-xml-out-add-gvalue"></a><h3>gsf_xml_out_add_gvalue ()</h3>
1397 <pre class="programlisting"><span class="returnvalue">void</span>
1398 gsf_xml_out_add_gvalue (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1399 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1400 <em class="parameter"><code><span class="type">GValue</span> const *val</code></em>);</pre>
1401 <p>Output the value of <em class="parameter"><code>val</code></em>
1402 as a string. Does NOT store any type information
1403 with the string, just thevalue.</p>
1404 <div class="refsect3">
1405 <a name="gsf-xml-out-add-gvalue.parameters"></a><h4>Parameters</h4>
1406 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1407 <colgroup>
1408 <col width="150px" class="parameters_name">
1409 <col class="parameters_description">
1410 <col width="200px" class="parameters_annotations">
1411 </colgroup>
1412 <tbody>
1413 <tr>
1414 <td class="parameter_name"><p>xout</p></td>
1415 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1416 <td class="parameter_annotations"> </td>
1417 </tr>
1418 <tr>
1419 <td class="parameter_name"><p>id</p></td>
1420 <td class="parameter_description"><p>tag id, or <code class="literal">NULL</code> for node content. </p></td>
1421 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1422 </tr>
1423 <tr>
1424 <td class="parameter_name"><p>val</p></td>
1425 <td class="parameter_description"><p><span class="type">GValue</span></p></td>
1426 <td class="parameter_annotations"> </td>
1427 </tr>
1428 </tbody>
1429 </table></div>
1430 </div>
1431 </div>
1432 <hr>
1433 <div class="refsect2">
1434 <a name="gsf-xml-out-simple-element"></a><h3>gsf_xml_out_simple_element ()</h3>
1435 <pre class="programlisting"><span class="returnvalue">void</span>
1436 gsf_xml_out_simple_element (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1437 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1438 <em class="parameter"><code><span class="type">char</span> const *content</code></em>);</pre>
1439 <p>Convenience routine to output a simple <em class="parameter"><code>id</code></em>
1440 element with content <em class="parameter"><code>content</code></em>
1441 .</p>
1442 <div class="refsect3">
1443 <a name="gsf-xml-out-simple-element.parameters"></a><h4>Parameters</h4>
1444 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1445 <colgroup>
1446 <col width="150px" class="parameters_name">
1447 <col class="parameters_description">
1448 <col width="200px" class="parameters_annotations">
1449 </colgroup>
1450 <tbody>
1451 <tr>
1452 <td class="parameter_name"><p>xout</p></td>
1453 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1454 <td class="parameter_annotations"> </td>
1455 </tr>
1456 <tr>
1457 <td class="parameter_name"><p>id</p></td>
1458 <td class="parameter_description"><p>Element name</p></td>
1459 <td class="parameter_annotations"> </td>
1460 </tr>
1461 <tr>
1462 <td class="parameter_name"><p>content</p></td>
1463 <td class="parameter_description"><p>Content of the element</p></td>
1464 <td class="parameter_annotations"> </td>
1465 </tr>
1466 </tbody>
1467 </table></div>
1468 </div>
1469 </div>
1470 <hr>
1471 <div class="refsect2">
1472 <a name="gsf-xml-out-simple-float-element"></a><h3>gsf_xml_out_simple_float_element ()</h3>
1473 <pre class="programlisting"><span class="returnvalue">void</span>
1474 gsf_xml_out_simple_float_element (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1475 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1476 <em class="parameter"><code><span class="type">double</span> val</code></em>,
1477 <em class="parameter"><code><span class="type">int</span> precision</code></em>);</pre>
1478 <p>Convenience routine to output an element <em class="parameter"><code>id</code></em>
1479 with float value <em class="parameter"><code>val</code></em>
1480 using
1481 <em class="parameter"><code>precision</code></em>
1482 significant digits.</p>
1483 <div class="refsect3">
1484 <a name="gsf-xml-out-simple-float-element.parameters"></a><h4>Parameters</h4>
1485 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1486 <colgroup>
1487 <col width="150px" class="parameters_name">
1488 <col class="parameters_description">
1489 <col width="200px" class="parameters_annotations">
1490 </colgroup>
1491 <tbody>
1492 <tr>
1493 <td class="parameter_name"><p>xout</p></td>
1494 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1495 <td class="parameter_annotations"> </td>
1496 </tr>
1497 <tr>
1498 <td class="parameter_name"><p>id</p></td>
1499 <td class="parameter_description"><p>Element name</p></td>
1500 <td class="parameter_annotations"> </td>
1501 </tr>
1502 <tr>
1503 <td class="parameter_name"><p>val</p></td>
1504 <td class="parameter_description"><p>Element value</p></td>
1505 <td class="parameter_annotations"> </td>
1506 </tr>
1507 <tr>
1508 <td class="parameter_name"><p>precision</p></td>
1509 <td class="parameter_description"><p>the number of significant digits to use, -1 meaning "enough".</p></td>
1510 <td class="parameter_annotations"> </td>
1511 </tr>
1512 </tbody>
1513 </table></div>
1514 </div>
1515 </div>
1516 <hr>
1517 <div class="refsect2">
1518 <a name="gsf-xml-out-simple-int-element"></a><h3>gsf_xml_out_simple_int_element ()</h3>
1519 <pre class="programlisting"><span class="returnvalue">void</span>
1520 gsf_xml_out_simple_int_element (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *xout</code></em>,
1521 <em class="parameter"><code><span class="type">char</span> const *id</code></em>,
1522 <em class="parameter"><code><span class="type">int</span> val</code></em>);</pre>
1523 <p>Convenience routine to output an element <em class="parameter"><code>id</code></em>
1524 with integer value <em class="parameter"><code>val</code></em>
1525 .</p>
1526 <div class="refsect3">
1527 <a name="gsf-xml-out-simple-int-element.parameters"></a><h4>Parameters</h4>
1528 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1529 <colgroup>
1530 <col width="150px" class="parameters_name">
1531 <col class="parameters_description">
1532 <col width="200px" class="parameters_annotations">
1533 </colgroup>
1534 <tbody>
1535 <tr>
1536 <td class="parameter_name"><p>xout</p></td>
1537 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a></p></td>
1538 <td class="parameter_annotations"> </td>
1539 </tr>
1540 <tr>
1541 <td class="parameter_name"><p>id</p></td>
1542 <td class="parameter_description"><p>Element name</p></td>
1543 <td class="parameter_annotations"> </td>
1544 </tr>
1545 <tr>
1546 <td class="parameter_name"><p>val</p></td>
1547 <td class="parameter_description"><p>Element value</p></td>
1548 <td class="parameter_annotations"> </td>
1549 </tr>
1550 </tbody>
1551 </table></div>
1552 </div>
1553 </div>
1554 <hr>
1555 <div class="refsect2">
1556 <a name="gsf-input-http-get-content-type"></a><h3>gsf_input_http_get_content_type ()</h3>
1557 <pre class="programlisting"><span class="returnvalue">gchar</span> *
1558 gsf_input_http_get_content_type (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfInputHTTP"><span class="type">GsfInputHTTP</span></a> *input</code></em>);</pre>
1559 <div class="refsect3">
1560 <a name="gsf-input-http-get-content-type.parameters"></a><h4>Parameters</h4>
1561 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1562 <colgroup>
1563 <col width="150px" class="parameters_name">
1564 <col class="parameters_description">
1565 <col width="200px" class="parameters_annotations">
1566 </colgroup>
1567 <tbody><tr>
1568 <td class="parameter_name"><p>input</p></td>
1569 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfInputHTTP"><span class="type">GsfInputHTTP</span></a></p></td>
1570 <td class="parameter_annotations"> </td>
1571 </tr></tbody>
1572 </table></div>
1573 </div>
1574 <div class="refsect3">
1575 <a name="gsf-input-http-get-content-type.returns"></a><h4>Returns</h4>
1576 <p> an allocated string containing the Content-Type field of the HTTP response.</p>
1577 </div>
1578 </div>
1579 <hr>
1580 <div class="refsect2">
1581 <a name="gsf-input-http-get-type"></a><h3>gsf_input_http_get_type ()</h3>
1582 <pre class="programlisting"><span class="returnvalue">GType</span>
1583 gsf_input_http_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
1584 </div>
1585 <hr>
1586 <div class="refsect2">
1587 <a name="gsf-input-http-get-url"></a><h3>gsf_input_http_get_url ()</h3>
1588 <pre class="programlisting"><span class="returnvalue">gchar</span> *
1589 gsf_input_http_get_url (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfInputHTTP"><span class="type">GsfInputHTTP</span></a> *input</code></em>);</pre>
1590 <div class="refsect3">
1591 <a name="gsf-input-http-get-url.parameters"></a><h4>Parameters</h4>
1592 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1593 <colgroup>
1594 <col width="150px" class="parameters_name">
1595 <col class="parameters_description">
1596 <col width="200px" class="parameters_annotations">
1597 </colgroup>
1598 <tbody><tr>
1599 <td class="parameter_name"><p>input</p></td>
1600 <td class="parameter_description"><p><a class="link" href="gsf-XML-and-libxml.html#GsfInputHTTP"><span class="type">GsfInputHTTP</span></a></p></td>
1601 <td class="parameter_annotations"> </td>
1602 </tr></tbody>
1603 </table></div>
1604 </div>
1605 <div class="refsect3">
1606 <a name="gsf-input-http-get-url.returns"></a><h4>Returns</h4>
1607 <p> an allocated string containing the URL used for input.</p>
1608 </div>
1609 </div>
1610 <hr>
1611 <div class="refsect2">
1612 <a name="gsf-xml-parser-context"></a><h3>gsf_xml_parser_context ()</h3>
1613 <pre class="programlisting"><span class="returnvalue">xmlParserCtxt</span> *
1614 gsf_xml_parser_context (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>);</pre>
1615 <p>Create a libxml2 pull style parser context wrapper around gsf input <em class="parameter"><code>input</code></em>
1616 .
1617 This signature will probably change to supply a SAX structure.</p>
1618 <div class="note">This adds a reference to <em class="parameter"><code>input</code></em>.</div>
1619 <div class="note">A simple wrapper around a cleaner implementation that will fold in
1620 when we add other api changes. Its not worth bumping just for this.</div>
1621 <p>NOTE: skipped since xmlParserCtxt is not exported to introspection.</p>
1622 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
1623 <div class="refsect3">
1624 <a name="gsf-xml-parser-context.parameters"></a><h4>Parameters</h4>
1625 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1626 <colgroup>
1627 <col width="150px" class="parameters_name">
1628 <col class="parameters_description">
1629 <col width="200px" class="parameters_annotations">
1630 </colgroup>
1631 <tbody><tr>
1632 <td class="parameter_name"><p>input</p></td>
1633 <td class="parameter_description"><p><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
1634 <td class="parameter_annotations"> </td>
1635 </tr></tbody>
1636 </table></div>
1637 </div>
1638 <div class="refsect3">
1639 <a name="gsf-xml-parser-context.returns"></a><h4>Returns</h4>
1640 <p>A parser context. </p>
1641 <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
1642 </div>
1643 </div>
1644 <hr>
1645 <div class="refsect2">
1646 <a name="gsf-xml-gvalue-from-str"></a><h3>gsf_xml_gvalue_from_str ()</h3>
1647 <pre class="programlisting"><span class="returnvalue">gboolean</span>
1648 gsf_xml_gvalue_from_str (<em class="parameter"><code><span class="type">GValue</span> *res</code></em>,
1649 <em class="parameter"><code><span class="type">GType</span> t</code></em>,
1650 <em class="parameter"><code><span class="type">char</span> const *str</code></em>);</pre>
1651 <p>Try to parse <em class="parameter"><code>str</code></em>
1652 as a value of type <em class="parameter"><code>t</code></em>
1653 into <em class="parameter"><code>res</code></em>
1654 .</p>
1655 <div class="refsect3">
1656 <a name="gsf-xml-gvalue-from-str.parameters"></a><h4>Parameters</h4>
1657 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1658 <colgroup>
1659 <col width="150px" class="parameters_name">
1660 <col class="parameters_description">
1661 <col width="200px" class="parameters_annotations">
1662 </colgroup>
1663 <tbody>
1664 <tr>
1665 <td class="parameter_name"><p>res</p></td>
1666 <td class="parameter_description"><p>Result value</p></td>
1667 <td class="parameter_annotations"> </td>
1668 </tr>
1669 <tr>
1670 <td class="parameter_name"><p>t</p></td>
1671 <td class="parameter_description"><p>Type of data</p></td>
1672 <td class="parameter_annotations"> </td>
1673 </tr>
1674 <tr>
1675 <td class="parameter_name"><p>str</p></td>
1676 <td class="parameter_description"><p>Value string</p></td>
1677 <td class="parameter_annotations"> </td>
1678 </tr>
1679 </tbody>
1680 </table></div>
1681 </div>
1682 <div class="refsect3">
1683 <a name="gsf-xml-gvalue-from-str.returns"></a><h4>Returns</h4>
1684 <p> True when parsing of <em class="parameter"><code>str</code></em>
1685 as a value of type <em class="parameter"><code>t</code></em>
1686 was succesfull;
1687 false otherwise.</p>
1688 </div>
1689 </div>
1690 <hr>
1691 <div class="refsect2">
1692 <a name="gsf-xmlDocFormatDump"></a><h3>gsf_xmlDocFormatDump ()</h3>
1693 <pre class="programlisting"><span class="returnvalue">int</span>
1694 gsf_xmlDocFormatDump (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>,
1695 <em class="parameter"><code><span class="type">xmlDoc</span> *cur</code></em>,
1696 <em class="parameter"><code><span class="type">char</span> const *encoding</code></em>,
1697 <em class="parameter"><code><span class="type">gboolean</span> format</code></em>);</pre>
1698 <p>Dumps the document <em class="parameter"><code>cur</code></em>
1699 into <em class="parameter"><code>output</code></em>
1700 .</p>
1701 <div class="refsect3">
1702 <a name="gsf-xmlDocFormatDump.parameters"></a><h4>Parameters</h4>
1703 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1704 <colgroup>
1705 <col width="150px" class="parameters_name">
1706 <col class="parameters_description">
1707 <col width="200px" class="parameters_annotations">
1708 </colgroup>
1709 <tbody>
1710 <tr>
1711 <td class="parameter_name"><p>output</p></td>
1712 <td class="parameter_description"><p><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
1713 <td class="parameter_annotations"> </td>
1714 </tr>
1715 <tr>
1716 <td class="parameter_name"><p>cur</p></td>
1717 <td class="parameter_description"><p><span class="type">xmlDocPtr</span></p></td>
1718 <td class="parameter_annotations"> </td>
1719 </tr>
1720 <tr>
1721 <td class="parameter_name"><p>encoding</p></td>
1722 <td class="parameter_description"><p>The encoding to use. </p></td>
1723 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
1724 </tr>
1725 <tr>
1726 <td class="parameter_name"><p>format</p></td>
1727 <td class="parameter_description"><p><code class="literal">TRUE</code> to reformat the output.</p></td>
1728 <td class="parameter_annotations"> </td>
1729 </tr>
1730 </tbody>
1731 </table></div>
1732 </div>
1733 <div class="refsect3">
1734 <a name="gsf-xmlDocFormatDump.returns"></a><h4>Returns</h4>
1735 <p> status from xmlSaveFormatFileTo.</p>
1736 </div>
1737 </div>
1738 </div>
1739 <div class="refsect1">
1740 <a name="gsf-XML-and-libxml.other_details"></a><h2>Types and Values</h2>
1741 <div class="refsect2">
1742 <a name="GsfXMLIn"></a><h3>GsfXMLIn</h3>
1743 <pre class="programlisting">typedef struct {
1744 /* public state : read only */
1745 gpointer user_state;
1746 GString *content;
1747 GsfXMLInDoc const *doc;
1748 GsfXMLInNode const *node; /* current node (not on the stack) */
1749 } GsfXMLIn;
1750 </pre>
1751 <div class="refsect3">
1752 <a name="GsfXMLIn.members"></a><h4>Members</h4>
1753 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1754 <colgroup>
1755 <col width="300px" class="struct_members_name">
1756 <col class="struct_members_description">
1757 <col width="200px" class="struct_members_annotations">
1758 </colgroup>
1759 <tbody>
1760 <tr>
1761 <td class="struct_member_name"><p><span class="type">gpointer</span> <em class="structfield"><code><a name="GsfXMLIn.user-state"></a>user_state</code></em>;</p></td>
1762 <td class="struct_member_description"><p>user data</p></td>
1763 <td class="struct_member_annotations"> </td>
1764 </tr>
1765 <tr>
1766 <td class="struct_member_name"><p><span class="type">GString</span> *<em class="structfield"><code><a name="GsfXMLIn.content"></a>content</code></em>;</p></td>
1767 <td class="struct_member_description"><p>the current node content</p></td>
1768 <td class="struct_member_annotations"> </td>
1769 </tr>
1770 <tr>
1771 <td class="struct_member_name"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a> const  *<em class="structfield"><code><a name="GsfXMLIn.doc"></a>doc</code></em>;</p></td>
1772 <td class="struct_member_description"><p>Current document being parsed <a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a></p></td>
1773 <td class="struct_member_annotations"> </td>
1774 </tr>
1775 <tr>
1776 <td class="struct_member_name"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNode" title="GsfXMLInNode"><span class="type">GsfXMLInNode</span></a> const  *<em class="structfield"><code><a name="GsfXMLIn.node"></a>node</code></em>;</p></td>
1777 <td class="struct_member_description"><p>current node (not on the stack)</p></td>
1778 <td class="struct_member_annotations"> </td>
1779 </tr>
1780 </tbody>
1781 </table></div>
1782 </div>
1783 </div>
1784 <hr>
1785 <div class="refsect2">
1786 <a name="GsfXMLInDoc"></a><h3>GsfXMLInDoc</h3>
1787 <pre class="programlisting">typedef struct _GsfXMLInDoc GsfXMLInDoc;</pre>
1788 </div>
1789 <hr>
1790 <div class="refsect2">
1791 <a name="GsfXMLInNS"></a><h3>GsfXMLInNS</h3>
1792 <pre class="programlisting">typedef struct {
1793 char const *uri;
1794 unsigned ns_id;
1795 } GsfXMLInNS;
1796 </pre>
1797 <div class="refsect3">
1798 <a name="GsfXMLInNS.members"></a><h4>Members</h4>
1799 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1800 <colgroup>
1801 <col width="300px" class="struct_members_name">
1802 <col class="struct_members_description">
1803 <col width="200px" class="struct_members_annotations">
1804 </colgroup>
1805 <tbody><tr>
1806 <td class="struct_member_name"><p><span class="type">char</span> const  *<em class="structfield"><code><a name="GsfXMLInNS.uri"></a>uri</code></em>;</p></td>
1807 <td class="struct_member_description"><p>URI</p></td>
1808 <td class="struct_member_annotations"> </td>
1809 </tr></tbody>
1810 </table></div>
1811 </div>
1812 </div>
1813 <hr>
1814 <div class="refsect2">
1815 <a name="GsfXMLInNode"></a><h3>GsfXMLInNode</h3>
1816 <pre class="programlisting">typedef struct {
1817 char const *id; /* unique in the entire tree */
1818 int ns_id;
1819 char const *name;
1820 char const *parent_id;
1821 void (*start) (GsfXMLIn *xin, xmlChar const **attrs);
1822 void (*end) (GsfXMLIn *xin, GsfXMLBlob *unknown);
1823
1824 union {
1825 int v_int;
1826 gboolean v_bool;
1827 gpointer v_blob;
1828 char const *v_str;
1829 } user_data;
1830 GsfXMLContent has_content;
1831
1832 unsigned int check_children_for_ns : 1;
1833 unsigned int share_children_with_parent : 1;
1834 } GsfXMLInNode;
1835 </pre>
1836 <div class="refsect3">
1837 <a name="GsfXMLInNode.members"></a><h4>Members</h4>
1838 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1839 <colgroup>
1840 <col width="300px" class="struct_members_name">
1841 <col class="struct_members_description">
1842 <col width="200px" class="struct_members_annotations">
1843 </colgroup>
1844 <tbody>
1845 <tr>
1846 <td class="struct_member_name"><p><span class="type">char</span> const  *<em class="structfield"><code><a name="GsfXMLInNode.id"></a>id</code></em>;</p></td>
1847 <td class="struct_member_description"><p>identifier unique in the entire tree</p></td>
1848 <td class="struct_member_annotations"> </td>
1849 </tr>
1850 <tr>
1851 <td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="GsfXMLInNode.ns-id"></a>ns_id</code></em>;</p></td>
1852 <td class="struct_member_description"><p>namespace identifier</p></td>
1853 <td class="struct_member_annotations"> </td>
1854 </tr>
1855 <tr>
1856 <td class="struct_member_name"><p><span class="type">char</span> const  *<em class="structfield"><code><a name="GsfXMLInNode.name"></a>name</code></em>;</p></td>
1857 <td class="struct_member_description"><p>node name</p></td>
1858 <td class="struct_member_annotations"> </td>
1859 </tr>
1860 <tr>
1861 <td class="struct_member_name"><p><span class="type">char</span> const  *<em class="structfield"><code><a name="GsfXMLInNode.parent-id"></a>parent_id</code></em>;</p></td>
1862 <td class="struct_member_description"><p>parent node identifier</p></td>
1863 <td class="struct_member_annotations"> </td>
1864 </tr>
1865 <tr>
1866 <td class="struct_member_name"><p><em class="structfield"><code><a name="GsfXMLInNode.start"></a>start</code></em> ()</p></td>
1867 <td class="struct_member_description"><p>callback for the node opening</p></td>
1868 <td class="struct_member_annotations"> </td>
1869 </tr>
1870 <tr>
1871 <td class="struct_member_name"><p><em class="structfield"><code><a name="GsfXMLInNode.end"></a>end</code></em> ()</p></td>
1872 <td class="struct_member_description"><p>callback for node end</p></td>
1873 <td class="struct_member_annotations"> </td>
1874 </tr>
1875 <tr>
1876 <td class="struct_member_name"><p><a class="link" href="gsf-XML-and-libxml.html#GsfXMLContent" title="enum GsfXMLContent"><span class="type">GsfXMLContent</span></a> <em class="structfield"><code><a name="GsfXMLInNode.has-content"></a>has_content</code></em>;</p></td>
1877 <td class="struct_member_description"><p>whether the node has content</p></td>
1878 <td class="struct_member_annotations"> </td>
1879 </tr>
1880 <tr>
1881 <td class="struct_member_name"><p>unsigned <span class="type">int</span> <em class="structfield"><code><a name="GsfXMLInNode.check-children-for-ns"></a>check_children_for_ns</code></em> : 1;</p></td>
1882 <td class="struct_member_description"><p>whether to check namespace for children</p></td>
1883 <td class="struct_member_annotations"> </td>
1884 </tr>
1885 <tr>
1886 <td class="struct_member_name"><p>unsigned <span class="type">int</span> <em class="structfield"><code><a name="GsfXMLInNode.share-children-with-parent"></a>share_children_with_parent</code></em> : 1;</p></td>
1887 <td class="struct_member_description"><p>whether to share children with parent.</p></td>
1888 <td class="struct_member_annotations"> </td>
1889 </tr>
1890 </tbody>
1891 </table></div>
1892 </div>
1893 </div>
1894 <hr>
1895 <div class="refsect2">
1896 <a name="GsfXMLContent"></a><h3>enum GsfXMLContent</h3>
1897 <p>Controls the handling of character data within a parser node.</p>
1898 <div class="refsect3">
1899 <a name="GsfXMLContent.members"></a><h4>Members</h4>
1900 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1901 <colgroup>
1902 <col width="300px" class="enum_members_name">
1903 <col class="enum_members_description">
1904 <col width="200px" class="enum_members_annotations">
1905 </colgroup>
1906 <tbody>
1907 <tr>
1908 <td class="enum_member_name"><p><a name="GSF-XML-NO-CONTENT:CAPS"></a>GSF_XML_NO_CONTENT</p></td>
1909 <td class="enum_member_description">
1910 <p>node has no cstr contents</p>
1911 </td>
1912 <td class="enum_member_annotations"> </td>
1913 </tr>
1914 <tr>
1915 <td class="enum_member_name"><p><a name="GSF-XML-CONTENT:CAPS"></a>GSF_XML_CONTENT</p></td>
1916 <td class="enum_member_description">
1917 <p>node has cstr contents</p>
1918 </td>
1919 <td class="enum_member_annotations"> </td>
1920 </tr>
1921 <tr>
1922 <td class="enum_member_name"><p><a name="GSF-XML-SHARED-CONTENT:CAPS"></a>GSF_XML_SHARED_CONTENT</p></td>
1923 <td class="enum_member_description">
1924 <p>node has contents that is shared with children</p>
1925 </td>
1926 <td class="enum_member_annotations"> </td>
1927 </tr>
1928 <tr>
1929 <td class="enum_member_name"><p><a name="GSF-XML-2ND:CAPS"></a>GSF_XML_2ND</p></td>
1930 <td class="enum_member_description">
1931 <p>node is second or later occurrence</p>
1932 </td>
1933 <td class="enum_member_annotations"> </td>
1934 </tr>
1935 </tbody>
1936 </table></div>
1937 </div>
1938 </div>
1939 <hr>
1940 <div class="refsect2">
1941 <a name="GsfXMLBlob"></a><h3>GsfXMLBlob</h3>
1942 <pre class="programlisting">typedef struct _GsfXMLBlob GsfXMLBlob;</pre>
1943 </div>
1944 <hr>
1945 <div class="refsect2">
1946 <a name="GsfInputHTTP-struct"></a><h3>GsfInputHTTP</h3>
1947 <pre class="programlisting">typedef struct _GsfInputHTTP GsfInputHTTP;</pre>
1948 </div>
1949 <hr>
1950 <div class="refsect2">
1951 <a name="GSF-XML-IN-NODE-END:CAPS"></a><h3>GSF_XML_IN_NODE_END</h3>
1952 <pre class="programlisting">#define GSF_XML_IN_NODE_END</pre>
1953 </div>
1954 <hr>
1955 <div class="refsect2">
1956 <a name="GSF-XML-IN-NS-END:CAPS"></a><h3>GSF_XML_IN_NS_END</h3>
1957 <pre class="programlisting">#define GSF_XML_IN_NS_END</pre>
1958 </div>
1959 <hr>
1960 <div class="refsect2">
1961 <a name="GsfXMLOut-struct"></a><h3>GsfXMLOut</h3>
1962 <pre class="programlisting">typedef struct _GsfXMLOut GsfXMLOut;</pre>
1963 </div>
1964 </div>
1965 <div class="refsect1">
1966 <a name="gsf-XML-and-libxml.property-details"></a><h2>Property Details</h2>
1967 <div class="refsect2">
1968 <a name="GsfXMLOut--pretty-print"></a><h3>The <code class="literal">“pretty-print”</code> property</h3>
1969 <pre class="programlisting"> “pretty-print” <span class="type">gboolean</span></pre>
1970 <p>Should the output auto-indent elements to make reading easier?.</p>
1971 <p>Owner: GsfXMLOut</p>
1972 <p>Flags: Read / Write</p>
1973 <p>Default value: TRUE</p>
1974 </div>
1975 <hr>
1976 <div class="refsect2">
1977 <a name="GsfXMLOut--sink"></a><h3>The <code class="literal">“sink”</code> property</h3>
1978 <pre class="programlisting"> “sink” <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</pre>
1979 <p>The destination for writes.</p>
1980 <p>Owner: GsfXMLOut</p>
1981 <p>Flags: Read / Write / Construct Only</p>
1982 </div>
1983 </div>
1984 </div>
1985 <div class="footer">
1986 <hr>Generated by GTK-Doc V1.34.0</div>
1987 </body>
1988 </html>