Debian Codegraph @

doc/html/gsf-OASIS-Open-Document.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>OASIS Open Document: 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-metadata.html" title="metadata">
10 <link rel="next" href="gsf-blobs.html" title="blobs">
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-OASIS-Open-Document.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="parsers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="gsf-metadata.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="gsf-blobs.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="gsf-OASIS-Open-Document"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="gsf-OASIS-Open-Document.top_of_page"></a>OASIS Open Document</span></h2>
30 <p>OASIS Open Document</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="gsf-OASIS-Open-Document.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_proto_type">
39 <col class="functions_proto_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNS" title="GsfXMLInNS"><span class="returnvalue">GsfXMLInNS</span></a> const *
45 </td>
46 <td class="function_name">
47 <a class="link" href="gsf-OASIS-Open-Document.html#gsf-odf-get-ns" title="gsf_odf_get_ns ()">gsf_odf_get_ns</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">short</span>
53 </td>
54 <td class="function_name">
55 <a class="link" href="gsf-OASIS-Open-Document.html#gsf-odf-get-version" title="gsf_odf_get_version ()">gsf_odf_get_version</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <span class="returnvalue">char</span> const *
61 </td>
62 <td class="function_name">
63 <a class="link" href="gsf-OASIS-Open-Document.html#gsf-odf-get-version-string" title="gsf_odf_get_version_string ()">gsf_odf_get_version_string</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <span class="returnvalue">GError</span> *
69 </td>
70 <td class="function_name">
71 <a class="link" href="gsf-OASIS-Open-Document.html#gsf-opendoc-metadata-read" title="gsf_opendoc_metadata_read ()">gsf_opendoc_metadata_read</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 <tr>
75 <td class="function_type">
76 <span class="returnvalue">void</span>
77 </td>
78 <td class="function_name">
79 <a class="link" href="gsf-OASIS-Open-Document.html#gsf-opendoc-metadata-subtree" title="gsf_opendoc_metadata_subtree ()">gsf_opendoc_metadata_subtree</a> <span class="c_punctuation">()</span>
80 </td>
81 </tr>
82 <tr>
83 <td class="function_type">
84 <span class="returnvalue">gboolean</span>
85 </td>
86 <td class="function_name">
87 <a class="link" href="gsf-OASIS-Open-Document.html#gsf-opendoc-metadata-write" title="gsf_opendoc_metadata_write ()">gsf_opendoc_metadata_write</a> <span class="c_punctuation">()</span>
88 </td>
89 </tr>
90 <tr>
91 <td class="function_type">
92 <span class="returnvalue">GType</span>
93 </td>
94 <td class="function_name">
95 <a class="link" href="gsf-OASIS-Open-Document.html#gsf-doc-prop-get-type" title="gsf_doc_prop_get_type ()">gsf_doc_prop_get_type</a> <span class="c_punctuation">()</span>
96 </td>
97 </tr>
98 <tr>
99 <td class="function_type">
100 <span class="returnvalue">int</span>
101 </td>
102 <td class="function_name">
103 <a class="link" href="gsf-OASIS-Open-Document.html#gsf-odf-out-get-version" title="gsf_odf_out_get_version ()">gsf_odf_out_get_version</a> <span class="c_punctuation">()</span>
104 </td>
105 </tr>
106 <tr>
107 <td class="function_type">
108 <span class="returnvalue">char</span> *
109 </td>
110 <td class="function_name">
111 <a class="link" href="gsf-OASIS-Open-Document.html#gsf-odf-out-get-version-string" title="gsf_odf_out_get_version_string ()">gsf_odf_out_get_version_string</a> <span class="c_punctuation">()</span>
112 </td>
113 </tr>
114 <tr>
115 <td class="function_type">
116 <span class="returnvalue">short</span>
117 </td>
118 <td class="function_name">
119 <a class="link" href="gsf-OASIS-Open-Document.html#get-gsf-odf-version" title="get_gsf_odf_version ()">get_gsf_odf_version</a> <span class="c_punctuation">()</span>
120 </td>
121 </tr>
122 <tr>
123 <td class="function_type">
124 <span class="returnvalue">char</span> const *
125 </td>
126 <td class="function_name">
127 <a class="link" href="gsf-OASIS-Open-Document.html#get-gsf-odf-version-string" title="get_gsf_odf_version_string ()">get_gsf_odf_version_string</a> <span class="c_punctuation">()</span>
128 </td>
129 </tr>
130 <tr>
131 <td class="function_type">
132 <a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNS" title="GsfXMLInNS"><span class="returnvalue">GsfXMLInNS</span></a> *
133 </td>
134 <td class="function_name">
135 <a class="link" href="gsf-OASIS-Open-Document.html#get-gsf-ooo-ns" title="get_gsf_ooo_ns ()">get_gsf_ooo_ns</a> <span class="c_punctuation">()</span>
136 </td>
137 </tr>
138 </tbody>
139 </table></div>
140 </div>
141 <div class="refsect1">
142 <a name="gsf-OASIS-Open-Document.description"></a><h2>Description</h2>
143 </div>
144 <div class="refsect1">
145 <a name="gsf-OASIS-Open-Document.functions_details"></a><h2>Functions</h2>
146 <div class="refsect2">
147 <a name="gsf-odf-get-ns"></a><h3>gsf_odf_get_ns ()</h3>
148 <pre class="programlisting"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNS" title="GsfXMLInNS"><span class="returnvalue">GsfXMLInNS</span></a> const *
149 gsf_odf_get_ns (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
150 <div class="refsect3">
151 <a name="gsf-odf-get-ns.returns"></a><h4>Returns</h4>
152 <p> the used ODF namespace</p>
153 </div>
154 <p class="since">Since: 1.14.24</p>
155 </div>
156 <hr>
157 <div class="refsect2">
158 <a name="gsf-odf-get-version"></a><h3>gsf_odf_get_version ()</h3>
159 <pre class="programlisting"><span class="returnvalue">short</span>
160 gsf_odf_get_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
161 <p>Gives the ODF version used by libgsf when writing Open Document files.</p>
162 <div class="refsect3">
163 <a name="gsf-odf-get-version.returns"></a><h4>Returns</h4>
164 <p> the ODF version: 102.</p>
165 </div>
166 <p class="since">Since: 1.14.24</p>
167 </div>
168 <hr>
169 <div class="refsect2">
170 <a name="gsf-odf-get-version-string"></a><h3>gsf_odf_get_version_string ()</h3>
171 <pre class="programlisting"><span class="returnvalue">char</span> const *
172 gsf_odf_get_version_string (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
173 <p>Gives the ODF version used by libgsf when writing Open Document files.</p>
174 <div class="refsect3">
175 <a name="gsf-odf-get-version-string.returns"></a><h4>Returns</h4>
176 <p> the ODF version as a string: "1.2".</p>
177 </div>
178 <p class="since">Since: 1.14.24</p>
179 </div>
180 <hr>
181 <div class="refsect2">
182 <a name="gsf-opendoc-metadata-read"></a><h3>gsf_opendoc_metadata_read ()</h3>
183 <pre class="programlisting"><span class="returnvalue">GError</span> *
184 gsf_opendoc_metadata_read (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
185 <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *md</code></em>);</pre>
186 <div class="warning">
187 <p><code class="literal">gsf_opendoc_metadata_read</code> has been deprecated since version 1.14.24 and should not be used in newly-written code.</p>
188 <p>, use gsf_doc_meta_data_read_from_odf</p>
189 </div>
190 <p>Read an OpenDocument metadata stream from <em class="parameter"><code>input</code></em>
191 and store the properties
192 into <em class="parameter"><code>md</code></em>
193 . Overwrite any existing properties with the same id.</p>
194 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
195 <div class="refsect3">
196 <a name="gsf-opendoc-metadata-read.parameters"></a><h4>Parameters</h4>
197 <div class="informaltable"><table class="informaltable" width="100%" border="0">
198 <colgroup>
199 <col width="150px" class="parameters_name">
200 <col class="parameters_description">
201 <col width="200px" class="parameters_annotations">
202 </colgroup>
203 <tbody>
204 <tr>
205 <td class="parameter_name"><p>input</p></td>
206 <td class="parameter_description"><p><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
207 <td class="parameter_annotations"> </td>
208 </tr>
209 <tr>
210 <td class="parameter_name"><p>md</p></td>
211 <td class="parameter_description"><p><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a></p></td>
212 <td class="parameter_annotations"> </td>
213 </tr>
214 </tbody>
215 </table></div>
216 </div>
217 <div class="refsect3">
218 <a name="gsf-opendoc-metadata-read.returns"></a><h4>Returns</h4>
219 <p>a <span class="type">GError</span> if there is a problem. </p>
220 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
221 </div>
222 </div>
223 <hr>
224 <div class="refsect2">
225 <a name="gsf-opendoc-metadata-subtree"></a><h3>gsf_opendoc_metadata_subtree ()</h3>
226 <pre class="programlisting"><span class="returnvalue">void</span>
227 gsf_opendoc_metadata_subtree (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLIn" title="GsfXMLIn"><span class="type">GsfXMLIn</span></a> *doc</code></em>,
228 <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *md</code></em>);</pre>
229 <div class="warning">
230 <p><code class="literal">gsf_opendoc_metadata_subtree</code> has been deprecated since version 1.14.24 and should not be used in newly-written code.</p>
231 <p>, use gsf_doc_meta_data_odf_subtree</p>
232 <p>Extend <em class="parameter"><code>xin</code></em>
233 so that it can parse a subtree in OpenDoc metadata format</p>
234 </div>
235 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
236 <div class="refsect3">
237 <a name="gsf-opendoc-metadata-subtree.parameters"></a><h4>Parameters</h4>
238 <div class="informaltable"><table class="informaltable" width="100%" border="0">
239 <colgroup>
240 <col width="150px" class="parameters_name">
241 <col class="parameters_description">
242 <col width="200px" class="parameters_annotations">
243 </colgroup>
244 <tbody>
245 <tr>
246 <td class="parameter_name"><p>doc</p></td>
247 <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>
248 <td class="parameter_annotations"> </td>
249 </tr>
250 <tr>
251 <td class="parameter_name"><p>md</p></td>
252 <td class="parameter_description"><p><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a></p></td>
253 <td class="parameter_annotations"> </td>
254 </tr>
255 </tbody>
256 </table></div>
257 </div>
258 </div>
259 <hr>
260 <div class="refsect2">
261 <a name="gsf-opendoc-metadata-write"></a><h3>gsf_opendoc_metadata_write ()</h3>
262 <pre class="programlisting"><span class="returnvalue">gboolean</span>
263 gsf_opendoc_metadata_write (<em class="parameter"><code><span class="type">gpointer</span> output</code></em>,
264 <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *md</code></em>);</pre>
265 <div class="warning">
266 <p><code class="literal">gsf_opendoc_metadata_write</code> has been deprecated since version 1.14.24 and should not be used in newly-written code.</p>
267 <p>, use gsf_doc_meta_data_write_to_odf</p>
268 </div>
269 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
270 <div class="refsect3">
271 <a name="gsf-opendoc-metadata-write.parameters"></a><h4>Parameters</h4>
272 <div class="informaltable"><table class="informaltable" width="100%" border="0">
273 <colgroup>
274 <col width="150px" class="parameters_name">
275 <col class="parameters_description">
276 <col width="200px" class="parameters_annotations">
277 </colgroup>
278 <tbody>
279 <tr>
280 <td class="parameter_name"><p>output</p></td>
281 <td class="parameter_description"><p>a pointer to a <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a>.</p></td>
282 <td class="parameter_annotations"> </td>
283 </tr>
284 <tr>
285 <td class="parameter_name"><p>md</p></td>
286 <td class="parameter_description"><p><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a></p></td>
287 <td class="parameter_annotations"> </td>
288 </tr>
289 </tbody>
290 </table></div>
291 </div>
292 <div class="refsect3">
293 <a name="gsf-opendoc-metadata-write.returns"></a><h4>Returns</h4>
294 <p> <code class="literal">TRUE</code> if no error occured.</p>
295 </div>
296 </div>
297 <hr>
298 <div class="refsect2">
299 <a name="gsf-doc-prop-get-type"></a><h3>gsf_doc_prop_get_type ()</h3>
300 <pre class="programlisting"><span class="returnvalue">GType</span>
301 gsf_doc_prop_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
302 </div>
303 <hr>
304 <div class="refsect2">
305 <a name="gsf-odf-out-get-version"></a><h3>gsf_odf_out_get_version ()</h3>
306 <pre class="programlisting"><span class="returnvalue">int</span>
307 gsf_odf_out_get_version (<em class="parameter"><code><span class="type">GsfODFOut</span> *oout</code></em>);</pre>
308 </div>
309 <hr>
310 <div class="refsect2">
311 <a name="gsf-odf-out-get-version-string"></a><h3>gsf_odf_out_get_version_string ()</h3>
312 <pre class="programlisting"><span class="returnvalue">char</span> *
313 gsf_odf_out_get_version_string (<em class="parameter"><code><span class="type">GsfODFOut</span> *oout</code></em>);</pre>
314 </div>
315 <hr>
316 <div class="refsect2">
317 <a name="get-gsf-odf-version"></a><h3>get_gsf_odf_version ()</h3>
318 <pre class="programlisting"><span class="returnvalue">short</span>
319 get_gsf_odf_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
320 <div class="warning">
321 <p><code class="literal">get_gsf_odf_version</code> has been deprecated since version 1.14.24 and should not be used in newly-written code.</p>
322 <p>, use gsf_odf_get_version</p>
323 </div>
324 <p>Gives the ODF version used by libgsf when writing Open Document files.</p>
325 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
326 <div class="refsect3">
327 <a name="get-gsf-odf-version.returns"></a><h4>Returns</h4>
328 <p> the ODF version: 102.</p>
329 </div>
330 </div>
331 <hr>
332 <div class="refsect2">
333 <a name="get-gsf-odf-version-string"></a><h3>get_gsf_odf_version_string ()</h3>
334 <pre class="programlisting"><span class="returnvalue">char</span> const *
335 get_gsf_odf_version_string (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
336 <div class="warning">
337 <p><code class="literal">get_gsf_odf_version_string</code> has been deprecated since version 1.14.24 and should not be used in newly-written code.</p>
338 <p>, use gsf_odf_get_version_string</p>
339 </div>
340 <p>Gives the ODF version used by libgsf when writing Open Document files.</p>
341 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
342 <div class="refsect3">
343 <a name="get-gsf-odf-version-string.returns"></a><h4>Returns</h4>
344 <p> the ODF version as a string: "1.2".</p>
345 </div>
346 </div>
347 <hr>
348 <div class="refsect2">
349 <a name="get-gsf-ooo-ns"></a><h3>get_gsf_ooo_ns ()</h3>
350 <pre class="programlisting"><a class="link" href="gsf-XML-and-libxml.html#GsfXMLInNS" title="GsfXMLInNS"><span class="returnvalue">GsfXMLInNS</span></a> *
351 get_gsf_ooo_ns (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
352 <div class="warning">
353 <p><code class="literal">get_gsf_ooo_ns</code> has been deprecated since version 1.14.24 and should not be used in newly-written code.</p>
354 <p>, use gsf_odf_get_ns</p>
355 </div>
356 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
357 <div class="refsect3">
358 <a name="get-gsf-ooo-ns.returns"></a><h4>Returns</h4>
359 <p> the used ODF namespace</p>
360 </div>
361 </div>
362 </div>
363 </div>
364 <div class="footer">
365 <hr>Generated by GTK-Doc V1.34.0</div>
366 </body>
367 </html>