doc/html/gsf-OASIS-Open-Document.html

   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</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   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="GsfBlob">
  11 <meta name="generator" content="GTK-Doc V1.14 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gsf-metadata.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="parsers.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GSF Reference Manual</th>
  21 <td><a accesskey="n" href="gsf-blobs.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gsf-OASIS-Open-Document.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gsf-OASIS-Open-Document.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry" title="OASIS Open Document">
  30 <a name="gsf-OASIS-Open-Document"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gsf-OASIS-Open-Document.top_of_page"></a>OASIS Open Document</span></h2>
  34 <p>OASIS Open Document</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv" title="Synopsis">
  39 <a name="gsf-OASIS-Open-Document.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *            <a class="link" href="gsf-OASIS-Open-Document.html#gsf-opendoc-metadata-read" title="gsf_opendoc_metadata_read ()">gsf_opendoc_metadata_read</a>           (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
  41                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *md</code></em>);
  42 <span class="returnvalue">void</span>                <a class="link" href="gsf-OASIS-Open-Document.html#gsf-opendoc-metadata-subtree" title="gsf_opendoc_metadata_subtree ()">gsf_opendoc_metadata_subtree</a>        (<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>,
  43                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *md</code></em>);
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gsf-OASIS-Open-Document.html#gsf-opendoc-metadata-write" title="gsf_opendoc_metadata_write ()">gsf_opendoc_metadata_write</a>          (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *output</code></em>,
  45                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *md</code></em>);
  46 </pre>
  47 </div>
  48 <div class="refsect1" title="Description">
  49 <a name="gsf-OASIS-Open-Document.description"></a><h2>Description</h2>
  50 <p>
  51 </p>
  52 </div>
  53 <div class="refsect1" title="Details">
  54 <a name="gsf-OASIS-Open-Document.details"></a><h2>Details</h2>
  55 <div class="refsect2" title="gsf_opendoc_metadata_read ()">
  56 <a name="gsf-opendoc-metadata-read"></a><h3>gsf_opendoc_metadata_read ()</h3>
  57 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *            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>,
  58                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *md</code></em>);</pre>
  59 <p>
  60 Read an OpenDocument metadata stream from <em class="parameter"><code>input</code></em> and store the properties
  61 into <em class="parameter"><code>md</code></em>.  Overwrite any existing properties with the same id.
  62 </p>
  63 <div class="variablelist"><table border="0">
  64 <col align="left" valign="top">
  65 <tbody>
  66 <tr>
  67 <td><p><span class="term"><em class="parameter"><code>input</code></em> :</span></p></td>
  68 <td>
  69 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a>
  70 </td>
  71 </tr>
  72 <tr>
  73 <td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
  74 <td>
  75 <a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
  76 </td>
  77 </tr>
  78 <tr>
  79 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  80 <td> a GError if there is a problem.
  81 </td>
  82 </tr>
  83 </tbody>
  84 </table></div>
  85 </div>
  86 <hr>
  87 <div class="refsect2" title="gsf_opendoc_metadata_subtree ()">
  88 <a name="gsf-opendoc-metadata-subtree"></a><h3>gsf_opendoc_metadata_subtree ()</h3>
  89 <pre class="programlisting"><span class="returnvalue">void</span>                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>,
  90                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> *md</code></em>);</pre>
  91 <p>
  92 Extend <em class="parameter"><code>xin</code></em> so that it can parse a subtree in OpenDoc metadata format
  93 </p>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody>
  97 <tr>
  98 <td><p><span class="term"><em class="parameter"><code>doc</code></em> :</span></p></td>
  99 <td>
 100 <a class="link" href="gsf-XML-and-libxml.html#GsfXMLInDoc" title="GsfXMLInDoc"><span class="type">GsfXMLInDoc</span></a>
 101 </td>
 102 </tr>
 103 <tr>
 104 <td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 105 <td>
 106 <a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a>
 107 </td>
 108 </tr>
 109 </tbody>
 110 </table></div>
 111 </div>
 112 <hr>
 113 <div class="refsect2" title="gsf_opendoc_metadata_write ()">
 114 <a name="gsf-opendoc-metadata-write"></a><h3>gsf_opendoc_metadata_write ()</h3>
 115 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gsf_opendoc_metadata_write          (<em class="parameter"><code><a class="link" href="gsf-XML-and-libxml.html#GsfXMLOut"><span class="type">GsfXMLOut</span></a> *output</code></em>,
 116                                                          <em class="parameter"><code><a class="link" href="gsf-metadata.html#GsfDocMetaData"><span class="type">GsfDocMetaData</span></a> const *md</code></em>);</pre>
 117 <p>
 118 </p>
 119 <div class="variablelist"><table border="0">
 120 <col align="left" valign="top">
 121 <tbody>
 122 <tr>
 123 <td><p><span class="term"><em class="parameter"><code>output</code></em> :</span></p></td>
 124 <td>
 125 </td>
 126 </tr>
 127 <tr>
 128 <td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 129 <td>
 130 </td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 134 <td>
 135 </td>
 136 </tr>
 137 </tbody>
 138 </table></div>
 139 </div>
 140 </div>
 141 </div>
 142 <div class="footer">
 143 <hr>
 144           Generated by GTK-Doc V1.14</div>
 145 </body>
 146 </html>