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</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="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.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="ch02.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-category.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-paper.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libglabels-3.0-xml-paper.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libglabels-3.0-xml-paper"></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-paper.top_of_page"></a>XML Paper Functions</span></h2>
  34 <p>XML Paper Functions — Functions to parse glabels XML paper definition 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-paper.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;libglabels/lgl-xml-paper.h&gt;
  42
  43 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <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> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *utf8_filename</code></em>);
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <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>      (<em class="parameter"><code><span class="type">xmlDocPtr</span> papers_doc</code></em>);
  45 <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *          <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>      (<em class="parameter"><code><span class="type">xmlNodePtr</span> paper_node</code></em>);
  46 </pre>
  47 </div>
  48 <div class="refsect1">
  49 <a name="libglabels-3.0-xml-paper.description"></a><h2>Description</h2>
  50 <p>
  51 This section describes a number of functions for parsing glabels
  52 XML paper definition files.
  53 </p>
  54 </div>
  55 <div class="refsect1">
  56 <a name="libglabels-3.0-xml-paper.details"></a><h2>Details</h2>
  57 <div class="refsect2">
  58 <a name="lgl-xml-paper-read-papers-from-file"></a><h3>lgl_xml_paper_read_papers_from_file ()</h3>
  59 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             lgl_xml_paper_read_papers_from_file (<em class="parameter"><code><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>
  60 <p>
  61 Read paper definitions from a file.
  62 </p>
  63 <div class="variablelist"><table border="0">
  64 <col align="left" valign="top">
  65 <tbody>
  66 <tr>
  67 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
  68 <td>Filename of papers file (name encoded as UTF-8)</td>
  69 </tr>
  70 <tr>
  71 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  72 <td>a list of <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structures.</td>
  73 </tr>
  74 </tbody>
  75 </table></div>
  76 </div>
  77 <hr>
  78 <div class="refsect2">
  79 <a name="lgl-xml-paper-parse-papers-doc"></a><h3>lgl_xml_paper_parse_papers_doc ()</h3>
  80 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             lgl_xml_paper_parse_papers_doc      (<em class="parameter"><code><span class="type">xmlDocPtr</span> papers_doc</code></em>);</pre>
  81 <p>
  82 Read paper definitions from a libxml <span class="type">xmlDocPtr</span> tree.
  83 </p>
  84 <div class="variablelist"><table border="0">
  85 <col align="left" valign="top">
  86 <tbody>
  87 <tr>
  88 <td><p><span class="term"><em class="parameter"><code>papers_doc</code></em> :</span></p></td>
  89 <td>libxml <span class="type">xmlDocPtr</span> tree, representing a papers definition file.</td>
  90 </tr>
  91 <tr>
  92 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  93 <td>a list of <a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="type">lglPaper</span></a> structures.</td>
  94 </tr>
  95 </tbody>
  96 </table></div>
  97 </div>
  98 <hr>
  99 <div class="refsect2">
 100 <a name="lgl-xml-paper-parse-paper-node"></a><h3>lgl_xml_paper_parse_paper_node ()</h3>
 101 <pre class="programlisting"><a class="link" href="libglabels-3.0-paper.html#lglPaper" title="struct lglPaper"><span class="returnvalue">lglPaper</span></a> *          lgl_xml_paper_parse_paper_node      (<em class="parameter"><code><span class="type">xmlNodePtr</span> paper_node</code></em>);</pre>
 102 <p>
 103 Read a single paper definition from a libxml <span class="type">xmlNodePtr</span> node.
 104 </p>
 105 <div class="variablelist"><table border="0">
 106 <col align="left" valign="top">
 107 <tbody>
 108 <tr>
 109 <td><p><span class="term"><em class="parameter"><code>paper_node</code></em> :</span></p></td>
 110 <td>libxml <span class="type">xmlNodePtr</span> paper node from a <span class="type">xmlDocPtr</span> tree.</td>
 111 </tr>
 112 <tr>
 113 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 114 <td>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.</td>
 115 </tr>
 116 </tbody>
 117 </table></div>
 118 </div>
 119 </div>
 120 </div>
 121 <div class="footer">
 122 <hr>
 123           Generated by GTK-Doc V1.17</div>
 124 </body>
 125 </html>