git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-3.0-xml-paper.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 Paper Functions: LibGlabels 3.0 Reference Manual</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="ch02.html" title="Working Directly With LibGlabels XML">
  10 <link rel="next" href="libglabels-3.0-xml-category.html" title="XML Category Functions">
  11 <meta name="generator" content="GTK-Doc V1.24 (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="5"><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-paper.description" class="shortcut">Description</a></span>
  19 </td>
  20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  21 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="libglabels-3.0-xml-category.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  24 </tr></table>
  25 <div class="refentry">
  26 <a name="libglabels-3.0-xml-paper"></a><div class="titlepage"></div>
  27 <div class="refnamediv"><table width="100%"><tr>
  28 <td valign="top">
  29 <h2><span class="refentrytitle"><a name="libglabels-3.0-xml-paper.top_of_page"></a>XML Paper Functions</span></h2>
  30 <p>XML Paper Functions — Functions to parse glabels XML paper definition files</p>
  31 </td>
  32 <td class="gallery_image" valign="top" align="right"></td>
  33 </tr></table></div>
  34 <div class="refsect1">
  35 <a name="libglabels-3.0-xml-paper.functions"></a><h2>Functions</h2>
  36 <div class="informaltable"><table width="100%" border="0">
  37 <colgroup>
  38 <col width="150px" class="functions_return">
  39 <col class="functions_name">
  40 </colgroup>
  41 <tbody>
  42 <tr>
  43 <td class="function_type">
  44 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
  45 </td>
  46 <td class="function_name">
  47 <a class="link" href="libglabels-3.0-xml-paper.html#lgl-xml-paper-read-papers-from-file" title="lgl_xml_paper_read_papers_from_file ()">lgl_xml_paper_read_papers_from_file</a> <span class="c_punctuation">()</span>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
  53 </td>
  54 <td class="function_name">
  55 <a class="link" href="libglabels-3.0-xml-paper.html#lgl-xml-paper-parse-papers-doc" title="lgl_xml_paper_parse_papers_doc ()">lgl_xml_paper_parse_papers_doc</a> <span class="c_punctuation">()</span>
  56 </td>
  57 </tr>
  58 <tr>
  59 <td class="function_type">
  60 <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
  61 </td>
  62 <td class="function_name">
  63 <a class="link" href="libglabels-3.0-xml-paper.html#lgl-xml-paper-parse-paper-node" title="lgl_xml_paper_parse_paper_node ()">lgl_xml_paper_parse_paper_node</a> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 </tbody>
  67 </table></div>
  68 </div>
  69 <div class="refsect1">
  70 <a name="libglabels-3.0-xml-paper.includes"></a><h2>Includes</h2>
  71 <pre class="synopsis">#include &lt;libglabels/lgl-xml-paper.h&gt;
  72 </pre>
  73 </div>
  74 <div class="refsect1">
  75 <a name="libglabels-3.0-xml-paper.description"></a><h2>Description</h2>
  76 <p>
  77 This section describes a number of functions for parsing glabels
  78 XML paper definition files.
  79 </p>
  80 </div>
  81 <div class="refsect1">
  82 <a name="libglabels-3.0-xml-paper.functions_details"></a><h2>Functions</h2>
  83 <div class="refsect2">
  84 <a name="lgl-xml-paper-read-papers-from-file"></a><h3>lgl_xml_paper_read_papers_from_file ()</h3>
  85 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
  86 lgl_xml_paper_read_papers_from_file (<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *utf8_filename</code></em>);</pre>
  87 <p>Read paper definitions from a file.</p>
  88 <div class="refsect3">
  89 <a name="id-1.3.2.6.2.5"></a><h4>Parameters</h4>
  90 <div class="informaltable"><table width="100%" border="0">
  91 <colgroup>
  92 <col width="150px" class="parameters_name">
  93 <col class="parameters_description">
  94 <col width="200px" class="parameters_annotations">
  95 </colgroup>
  96 <tbody><tr>
  97 <td class="parameter_name"><p>utf8_filename</p></td>
  98 <td class="parameter_description"><p>Filename of papers file (name encoded as UTF-8)</p></td>
  99 <td class="parameter_annotations"> </td>
 100 </tr></tbody>
 101 </table></div>
 102 </div>
 103 <div class="refsect3">
 104 <a name="id-1.3.2.6.2.6"></a><h4>Returns</h4>
 105 <p> a list of <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structures.</p>
 106 </div>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="lgl-xml-paper-parse-papers-doc"></a><h3>lgl_xml_paper_parse_papers_doc ()</h3>
 111 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 112 lgl_xml_paper_parse_papers_doc (<em class="parameter"><code><span class="type">xmlDocPtr</span> papers_doc</code></em>);</pre>
 113 <p>Read paper definitions from a libxml <span class="type">xmlDocPtr</span> tree.</p>
 114 <div class="refsect3">
 115 <a name="id-1.3.2.6.3.5"></a><h4>Parameters</h4>
 116 <div class="informaltable"><table width="100%" border="0">
 117 <colgroup>
 118 <col width="150px" class="parameters_name">
 119 <col class="parameters_description">
 120 <col width="200px" class="parameters_annotations">
 121 </colgroup>
 122 <tbody><tr>
 123 <td class="parameter_name"><p>papers_doc</p></td>
 124 <td class="parameter_description"><p>libxml <span class="type">xmlDocPtr</span> tree, representing a papers definition file.</p></td>
 125 <td class="parameter_annotations"> </td>
 126 </tr></tbody>
 127 </table></div>
 128 </div>
 129 <div class="refsect3">
 130 <a name="id-1.3.2.6.3.6"></a><h4>Returns</h4>
 131 <p> a list of <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structures.</p>
 132 </div>
 133 </div>
 134 <hr>
 135 <div class="refsect2">
 136 <a name="lgl-xml-paper-parse-paper-node"></a><h3>lgl_xml_paper_parse_paper_node ()</h3>
 137 <pre class="programlisting"><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *
 138 lgl_xml_paper_parse_paper_node (<em class="parameter"><code><span class="type">xmlNodePtr</span> paper_node</code></em>);</pre>
 139 <p>Read a single paper definition from a libxml <span class="type">xmlNodePtr</span> node.</p>
 140 <div class="refsect3">
 141 <a name="id-1.3.2.6.4.5"></a><h4>Parameters</h4>
 142 <div class="informaltable"><table width="100%" border="0">
 143 <colgroup>
 144 <col width="150px" class="parameters_name">
 145 <col class="parameters_description">
 146 <col width="200px" class="parameters_annotations">
 147 </colgroup>
 148 <tbody><tr>
 149 <td class="parameter_name"><p>paper_node</p></td>
 150 <td class="parameter_description"><p>libxml <span class="type">xmlNodePtr</span> paper node from a <span class="type">xmlDocPtr</span> tree.</p></td>
 151 <td class="parameter_annotations"> </td>
 152 </tr></tbody>
 153 </table></div>
 154 </div>
 155 <div class="refsect3">
 156 <a name="id-1.3.2.6.4.6"></a><h4>Returns</h4>
 157 <p> a pointer to a newly created <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structure.</p>
 158 </div>
 159 </div>
 160 </div>
 161 <div class="refsect1">
 162 <a name="libglabels-3.0-xml-paper.other_details"></a><h2>Types and Values</h2>
 163 </div>
 164 </div>
 165 <div class="footer">
 166 <hr>Generated by GTK-Doc V1.24</div>
 167 </body>
 168 </html>