git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-xml-template.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>XML Template Functions</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="LibGlabels Reference Manual">
   8 <link rel="up" href="ch02.html" title="Working Directly With LibGlabels XML">
   9 <link rel="prev" href="libglabels-xml-category.html" title="XML Category Functions">
  10 <link rel="next" href="libglabels-xml.html" title="XML Helper Functions">
  11 <meta name="generator" content="GTK-Doc V1.11 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 <link rel="chapter" href="ch01.html" title="Basic LibGlabels Usage">
  14 <link rel="chapter" href="ch02.html" title="Working Directly With LibGlabels XML">
  15 <link rel="chapter" href="ch03.html" title="Miscellaneous">
  16 </head>
  17 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  18 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  19 <tr valign="middle">
  20 <td><a accesskey="p" href="libglabels-xml-category.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  21 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  22 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  23 <th width="100%" align="center">LibGlabels Reference Manual</th>
  24 <td><a accesskey="n" href="libglabels-xml.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  25 </tr>
  26 <tr><td colspan="5" class="shortcuts">
  27 <a href="#libglabels-xml-template.synopsis" class="shortcut">Top</a>
  28                  |
  29                 <a href="#libglabels-xml-template.description" class="shortcut">Description</a>
  30 </td></tr>
  31 </table>
  32 <div class="refentry" title="XML Template Functions">
  33 <a name="libglabels-xml-template"></a><div class="titlepage"></div>
  34 <div class="refnamediv"><table width="100%"><tr>
  35 <td valign="top">
  36 <h2><span class="refentrytitle"><a name="libglabels-xml-template.top_of_page"></a>XML Template Functions</span></h2>
  37 <p>XML Template Functions — Functions to create and parse glabels XML template nodes and files</p>
  38 </td>
  39 <td valign="top" align="right"></td>
  40 </tr></table></div>
  41 <div class="refsynopsisdiv" title="Synopsis">
  42 <a name="libglabels-xml-template.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">
  44
  45 #include &lt;libglabels/xml-templates.h&gt;
  46
  47 <a
  48 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  49 >GList</a> *             <a class="link" href="libglabels-xml-template.html#lgl-xml-template-read-templates-from-file" title="lgl_xml_template_read_templates_from_file ()">lgl_xml_template_read_templates_from_file</a>
  50                                                         (const <a
  51 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  52 >gchar</a> *utf8_filename);
  53 <a
  54 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  55 >GList</a> *             <a class="link" href="libglabels-xml-template.html#lgl-xml-template-parse-templates-doc" title="lgl_xml_template_parse_templates_doc ()">lgl_xml_template_parse_templates_doc</a>
  56                                                         (const xmlDocPtr templates_doc);
  57 <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *       <a class="link" href="libglabels-xml-template.html#lgl-xml-template-parse-template-node" title="lgl_xml_template_parse_template_node ()">lgl_xml_template_parse_template_node</a>
  58                                                         (const xmlNodePtr template_node);
  59 <a
  60 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
  61 >gint</a>                <a class="link" href="libglabels-xml-template.html#lgl-xml-template-write-templates-to-file" title="lgl_xml_template_write_templates_to_file ()">lgl_xml_template_write_templates_to_file</a>
  62                                                         (<a
  63 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  64 >GList</a> *templates,
  65                                                          const <a
  66 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  67 >gchar</a> *utf8_filename);
  68 <a
  69 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
  70 >gint</a>                <a class="link" href="libglabels-xml-template.html#lgl-xml-template-write-template-to-file" title="lgl_xml_template_write_template_to_file ()">lgl_xml_template_write_template_to_file</a>
  71                                                         (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
  72                                                          const <a
  73 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  74 >gchar</a> *utf8_filename);
  75 void                <a class="link" href="libglabels-xml-template.html#lgl-xml-template-create-template-node" title="lgl_xml_template_create_template_node ()">lgl_xml_template_create_template_node</a>
  76                                                         (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
  77                                                          xmlNodePtr root,
  78                                                          const xmlNsPtr ns);
  79 </pre>
  80 </div>
  81 <div class="refsect1" title="Description">
  82 <a name="libglabels-xml-template.description"></a><h2>Description</h2>
  83 <p>
  84 This section describes a number of functions for creating and parsing
  85 glabels XML template nodes and files.  Template nodes are used in both
  86 template files and document files.
  87 </p>
  88 </div>
  89 <div class="refsect1" title="Details">
  90 <a name="libglabels-xml-template.details"></a><h2>Details</h2>
  91 <div class="refsect2" title="lgl_xml_template_read_templates_from_file ()">
  92 <a name="lgl-xml-template-read-templates-from-file"></a><h3>lgl_xml_template_read_templates_from_file ()</h3>
  93 <pre class="programlisting"><a
  94 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  95 >GList</a> *             lgl_xml_template_read_templates_from_file
  96                                                         (const <a
  97 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  98 >gchar</a> *utf8_filename);</pre>
  99 <p>
 100 Read glabels templates from template file.</p>
 101 <p>
 102 </p>
 103 <div class="variablelist"><table border="0">
 104 <col align="left" valign="top">
 105 <tbody>
 106 <tr>
 107 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
 108 <td>       Filename of papers file (name encoded as UTF-8)
 109 </td>
 110 </tr>
 111 <tr>
 112 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 113 <td> a list of <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structures.
 114
 115 </td>
 116 </tr>
 117 </tbody>
 118 </table></div>
 119 </div>
 120 <hr>
 121 <div class="refsect2" title="lgl_xml_template_parse_templates_doc ()">
 122 <a name="lgl-xml-template-parse-templates-doc"></a><h3>lgl_xml_template_parse_templates_doc ()</h3>
 123 <pre class="programlisting"><a
 124 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 125 >GList</a> *             lgl_xml_template_parse_templates_doc
 126                                                         (const xmlDocPtr templates_doc);</pre>
 127 <p>
 128 Read glabels templates from a libxml <span class="type">xmlDocPtr</span> tree.</p>
 129 <p>
 130 </p>
 131 <div class="variablelist"><table border="0">
 132 <col align="left" valign="top">
 133 <tbody>
 134 <tr>
 135 <td><p><span class="term"><em class="parameter"><code>templates_doc</code></em> :</span></p></td>
 136 <td>  libxml <span class="type">xmlDocPtr</span> tree, representing template file.
 137 </td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 141 <td> a list of <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structures.
 142
 143 </td>
 144 </tr>
 145 </tbody>
 146 </table></div>
 147 </div>
 148 <hr>
 149 <div class="refsect2" title="lgl_xml_template_parse_template_node ()">
 150 <a name="lgl-xml-template-parse-template-node"></a><h3>lgl_xml_template_parse_template_node ()</h3>
 151 <pre class="programlisting"><a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *       lgl_xml_template_parse_template_node
 152                                                         (const xmlNodePtr template_node);</pre>
 153 <p>
 154 Read a single glabels template from a libxml <span class="type">xmlNodePtr</span> node.</p>
 155 <p>
 156 </p>
 157 <div class="variablelist"><table border="0">
 158 <col align="left" valign="top">
 159 <tbody>
 160 <tr>
 161 <td><p><span class="term"><em class="parameter"><code>template_node</code></em> :</span></p></td>
 162 <td>  libxml <span class="type">xmlNodePtr</span> template node from a <span class="type">xmlDocPtr</span> tree.
 163 </td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 167 <td> a pointer to a newly created <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structure.
 168
 169 </td>
 170 </tr>
 171 </tbody>
 172 </table></div>
 173 </div>
 174 <hr>
 175 <div class="refsect2" title="lgl_xml_template_write_templates_to_file ()">
 176 <a name="lgl-xml-template-write-templates-to-file"></a><h3>lgl_xml_template_write_templates_to_file ()</h3>
 177 <pre class="programlisting"><a
 178 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 179 >gint</a>                lgl_xml_template_write_templates_to_file
 180                                                         (<a
 181 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 182 >GList</a> *templates,
 183                                                          const <a
 184 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 185 >gchar</a> *utf8_filename);</pre>
 186 <p>
 187 Write a list of <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structures to a glabels XML template file.</p>
 188 <p>
 189 </p>
 190 <div class="variablelist"><table border="0">
 191 <col align="left" valign="top">
 192 <tbody>
 193 <tr>
 194 <td><p><span class="term"><em class="parameter"><code>templates</code></em> :</span></p></td>
 195 <td>      List of <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structures
 196 </td>
 197 </tr>
 198 <tr>
 199 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
 200 <td>  Filename of templates file (name encoded as UTF-8)
 201 </td>
 202 </tr>
 203 <tr>
 204 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 205 <td> the number of bytes written or -1 in case of failure
 206
 207 </td>
 208 </tr>
 209 </tbody>
 210 </table></div>
 211 </div>
 212 <hr>
 213 <div class="refsect2" title="lgl_xml_template_write_template_to_file ()">
 214 <a name="lgl-xml-template-write-template-to-file"></a><h3>lgl_xml_template_write_template_to_file ()</h3>
 215 <pre class="programlisting"><a
 216 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 217 >gint</a>                lgl_xml_template_write_template_to_file
 218                                                         (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
 219                                                          const <a
 220 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 221 >gchar</a> *utf8_filename);</pre>
 222 <p>
 223 Write a single <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structures to a glabels XML template file.</p>
 224 <p>
 225 </p>
 226 <div class="variablelist"><table border="0">
 227 <col align="left" valign="top">
 228 <tbody>
 229 <tr>
 230 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
 231 <td>       <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structure to be written
 232 </td>
 233 </tr>
 234 <tr>
 235 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
 236 <td>  Filename of templates file (name encoded as UTF-8)
 237 </td>
 238 </tr>
 239 <tr>
 240 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 241 <td> the number of bytes written or -1 in case of failure
 242
 243 </td>
 244 </tr>
 245 </tbody>
 246 </table></div>
 247 </div>
 248 <hr>
 249 <div class="refsect2" title="lgl_xml_template_create_template_node ()">
 250 <a name="lgl-xml-template-create-template-node"></a><h3>lgl_xml_template_create_template_node ()</h3>
 251 <pre class="programlisting">void                lgl_xml_template_create_template_node
 252                                                         (const <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate">lglTemplate</a> *template,
 253                                                          xmlNodePtr root,
 254                                                          const xmlNsPtr ns);</pre>
 255 <p>
 256 Add a single <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> child node to given <span class="type">xmlNodePtr</span>.</p>
 257 <p>
 258 </p>
 259 <div class="variablelist"><table border="0">
 260 <col align="left" valign="top">
 261 <tbody>
 262 <tr>
 263 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
 264 <td>       <a class="link" href="libglabels-template.html#lglTemplate" title="lglTemplate"><span class="type">lglTemplate</span></a> structure to be written
 265 </td>
 266 </tr>
 267 <tr>
 268 <td><p><span class="term"><em class="parameter"><code>root</code></em> :</span></p></td>
 269 <td>           parent node to receive new child node
 270 </td>
 271 </tr>
 272 <tr>
 273 <td><p><span class="term"><em class="parameter"><code>ns</code></em> :</span></p></td>
 274 <td>             a libxml <span class="type">xmlNsPtr</span>
 275 </td>
 276 </tr>
 277 </tbody>
 278 </table></div>
 279 </div>
 280 </div>
 281 </div>
 282 <div class="footer">
 283 <hr>
 284           Generated by GTK-Doc V1.11</div>
 285 </body>
 286 </html>