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>XML Template Functions</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.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.17 (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="libglabels-3.0-xml-category.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch02.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">LibGlabels 3.0 Reference Manual</th>
  21 <td><a accesskey="n" href="libglabels-3.0-xml-vendor.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="#libglabels-3.0-xml-template.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libglabels-3.0-xml-template.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libglabels-3.0-xml-template"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="libglabels-3.0-xml-template.top_of_page"></a>XML Template Functions</span></h2>
  34 <p>XML Template Functions — Functions to create and parse glabels XML template nodes and files</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libglabels-3.0-xml-template.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;libglabels/lgl-xml-templates.h&gt;
  42
  43 <span class="returnvalue">void</span>                <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>
  44                                                         (<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>);
  45 <span class="returnvalue">void</span>                <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>
  46                                                         (<em class="parameter"><code>const <span class="type">xmlDocPtr</span> templates_doc</code></em>);
  47 <a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="returnvalue">lglTemplate</span></a> *       <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>
  48                                                         (<em class="parameter"><code>const <span class="type">xmlNodePtr</span> template_node</code></em>);
  49 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <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>
  50                                                         (<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>,
  51                                                          <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>);
  52 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <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>
  53                                                         (<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>,
  54                                                          <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>);
  55 <span class="returnvalue">void</span>                <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>
  56                                                         (<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>,
  57                                                          <em class="parameter"><code><span class="type">xmlNodePtr</span> root</code></em>,
  58                                                          <em class="parameter"><code>const <span class="type">xmlNsPtr</span> ns</code></em>);
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="libglabels-3.0-xml-template.description"></a><h2>Description</h2>
  63 <p>
  64 This section describes a number of functions for creating and parsing
  65 glabels XML template nodes and files.  Template nodes are used in both
  66 template files and document files.
  67 </p>
  68 </div>
  69 <div class="refsect1">
  70 <a name="libglabels-3.0-xml-template.details"></a><h2>Details</h2>
  71 <div class="refsect2">
  72 <a name="lgl-xml-template-read-templates-from-file"></a><h3>lgl_xml_template_read_templates_from_file ()</h3>
  73 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_template_read_templates_from_file
  74                                                         (<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>
  75 <p>
  76 Read glabels templates from template file.
  77 </p>
  78 <div class="variablelist"><table border="0">
  79 <col align="left" valign="top">
  80 <tbody><tr>
  81 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
  82 <td>Filename of papers file (name encoded as UTF-8)</td>
  83 </tr></tbody>
  84 </table></div>
  85 </div>
  86 <hr>
  87 <div class="refsect2">
  88 <a name="lgl-xml-template-parse-templates-doc"></a><h3>lgl_xml_template_parse_templates_doc ()</h3>
  89 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_template_parse_templates_doc
  90                                                         (<em class="parameter"><code>const <span class="type">xmlDocPtr</span> templates_doc</code></em>);</pre>
  91 <p>
  92 Read glabels templates from a libxml <span class="type">xmlDocPtr</span> tree.
  93 </p>
  94 <div class="variablelist"><table border="0">
  95 <col align="left" valign="top">
  96 <tbody><tr>
  97 <td><p><span class="term"><em class="parameter"><code>templates_doc</code></em> :</span></p></td>
  98 <td>libxml <span class="type">xmlDocPtr</span> tree, representing template file.</td>
  99 </tr></tbody>
 100 </table></div>
 101 </div>
 102 <hr>
 103 <div class="refsect2">
 104 <a name="lgl-xml-template-parse-template-node"></a><h3>lgl_xml_template_parse_template_node ()</h3>
 105 <pre class="programlisting"><a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="returnvalue">lglTemplate</span></a> *       lgl_xml_template_parse_template_node
 106                                                         (<em class="parameter"><code>const <span class="type">xmlNodePtr</span> template_node</code></em>);</pre>
 107 <p>
 108 Read a single glabels template from a libxml <span class="type">xmlNodePtr</span> node.
 109 </p>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term"><em class="parameter"><code>template_node</code></em> :</span></p></td>
 115 <td>libxml <span class="type">xmlNodePtr</span> template node from a <span class="type">xmlDocPtr</span> tree.</td>
 116 </tr>
 117 <tr>
 118 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 119 <td>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.</td>
 120 </tr>
 121 </tbody>
 122 </table></div>
 123 </div>
 124 <hr>
 125 <div class="refsect2">
 126 <a name="lgl-xml-template-write-templates-to-file"></a><h3>lgl_xml_template_write_templates_to_file ()</h3>
 127 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                lgl_xml_template_write_templates_to_file
 128                                                         (<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>,
 129                                                          <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>
 130 <p>
 131 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.
 132 </p>
 133 <div class="variablelist"><table border="0">
 134 <col align="left" valign="top">
 135 <tbody>
 136 <tr>
 137 <td><p><span class="term"><em class="parameter"><code>templates</code></em> :</span></p></td>
 138 <td>List of <a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="type">lglTemplate</span></a> structures</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
 142 <td>Filename of templates file (name encoded as UTF-8)</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 146 <td>the number of bytes written or -1 in case of failure</td>
 147 </tr>
 148 </tbody>
 149 </table></div>
 150 </div>
 151 <hr>
 152 <div class="refsect2">
 153 <a name="lgl-xml-template-write-template-to-file"></a><h3>lgl_xml_template_write_template_to_file ()</h3>
 154 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                lgl_xml_template_write_template_to_file
 155                                                         (<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>,
 156                                                          <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>
 157 <p>
 158 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.
 159 </p>
 160 <div class="variablelist"><table border="0">
 161 <col align="left" valign="top">
 162 <tbody>
 163 <tr>
 164 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
 165 <td>
 166 <a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="type">lglTemplate</span></a> structure to be written</td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
 170 <td>Filename of templates file (name encoded as UTF-8)</td>
 171 </tr>
 172 <tr>
 173 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 174 <td>the number of bytes written or -1 in case of failure</td>
 175 </tr>
 176 </tbody>
 177 </table></div>
 178 </div>
 179 <hr>
 180 <div class="refsect2">
 181 <a name="lgl-xml-template-create-template-node"></a><h3>lgl_xml_template_create_template_node ()</h3>
 182 <pre class="programlisting"><span class="returnvalue">void</span>                lgl_xml_template_create_template_node
 183                                                         (<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>,
 184                                                          <em class="parameter"><code><span class="type">xmlNodePtr</span> root</code></em>,
 185                                                          <em class="parameter"><code>const <span class="type">xmlNsPtr</span> ns</code></em>);</pre>
 186 <p>
 187 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>.
 188 </p>
 189 <div class="variablelist"><table border="0">
 190 <col align="left" valign="top">
 191 <tbody>
 192 <tr>
 193 <td><p><span class="term"><em class="parameter"><code>template</code></em> :</span></p></td>
 194 <td>
 195 <a class="link" href="libglabels-3.0-template.html#lglTemplate" title="struct lglTemplate"><span class="type">lglTemplate</span></a> structure to be written</td>
 196 </tr>
 197 <tr>
 198 <td><p><span class="term"><em class="parameter"><code>root</code></em> :</span></p></td>
 199 <td>parent node to receive new child node</td>
 200 </tr>
 201 <tr>
 202 <td><p><span class="term"><em class="parameter"><code>ns</code></em> :</span></p></td>
 203 <td>a libxml <span class="type">xmlNsPtr</span>
 204 </td>
 205 </tr>
 206 </tbody>
 207 </table></div>
 208 </div>
 209 </div>
 210 </div>
 211 <div class="footer">
 212 <hr>
 213           Generated by GTK-Doc V1.17</div>
 214 </body>
 215 </html>