1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
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">
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">
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>
26 <tr><td colspan="5" class="shortcuts">
27 <a href="#libglabels-xml-template.synopsis" class="shortcut">Top</a>
29 <a href="#libglabels-xml-template.description" class="shortcut">Description</a>
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>
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>
39 <td valign="top" align="right"></td>
41 <div class="refsynopsisdiv" title="Synopsis">
42 <a name="libglabels-xml-template.synopsis"></a><h2>Synopsis</h2>
43 <pre class="synopsis">
45 #include <libglabels/xml-templates.h>
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>
51 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
52 >gchar</a> *utf8_filename);
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);
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>
63 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
64 >GList</a> *templates,
66 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
67 >gchar</a> *utf8_filename);
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,
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,
81 <div class="refsect1" title="Description">
82 <a name="libglabels-xml-template.description"></a><h2>Description</h2>
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.
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
97 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
98 >gchar</a> *utf8_filename);</pre>
100 Read glabels templates from template file.</p>
103 <div class="variablelist"><table border="0">
104 <col align="left" valign="top">
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)
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.
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>
128 Read glabels templates from a libxml <span class="type">xmlDocPtr</span> tree.</p>
131 <div class="variablelist"><table border="0">
132 <col align="left" valign="top">
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.
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.
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>
154 Read a single glabels template from a libxml <span class="type">xmlNodePtr</span> node.</p>
157 <div class="variablelist"><table border="0">
158 <col align="left" valign="top">
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.
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.
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
181 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
182 >GList</a> *templates,
184 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
185 >gchar</a> *utf8_filename);</pre>
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>
190 <div class="variablelist"><table border="0">
191 <col align="left" valign="top">
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
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)
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
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,
220 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
221 >gchar</a> *utf8_filename);</pre>
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>
226 <div class="variablelist"><table border="0">
227 <col align="left" valign="top">
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
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)
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
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,
254 const xmlNsPtr ns);</pre>
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>
259 <div class="variablelist"><table border="0">
260 <col align="left" valign="top">
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
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
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>
284 Generated by GTK-Doc V1.11</div>