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