git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-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.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="ch02.html" title="Working Directly With LibGlabels XML">
  10 <link rel="next" href="libglabels-xml-category.html" title="XML Category 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">
  16 </head>
  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">
  19 <tr valign="middle">
  20 <td><a accesskey="p" href="ch02.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-category.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  25 </tr>
  26 <tr><td colspan="5" class="shortcuts">
  27 <a href="#libglabels-xml-paper.synopsis" class="shortcut">Top</a>
  28                  |
  29                 <a href="#libglabels-xml-paper.description" class="shortcut">Description</a>
  30 </td></tr>
  31 </table>
  32 <div class="refentry" title="XML Paper Functions">
  33 <a name="libglabels-xml-paper"></a><div class="titlepage"></div>
  34 <div class="refnamediv"><table width="100%"><tr>
  35 <td valign="top">
  36 <h2><span class="refentrytitle"><a name="libglabels-xml-paper.top_of_page"></a>XML Paper Functions</span></h2>
  37 <p>XML Paper Functions — Functions to parse glabels XML paper definition files</p>
  38 </td>
  39 <td valign="top" align="right"></td>
  40 </tr></table></div>
  41 <div class="refsynopsisdiv" title="Synopsis">
  42 <a name="libglabels-xml-paper.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">
  44
  45 #include &lt;libglabels/xml-paper.h&gt;
  46
  47 <a
  48 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  49 >GList</a> *             <a class="link" href="libglabels-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> (<a
  50 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  51 >gchar</a> *utf8_filename);
  52 <a
  53 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  54 >GList</a> *             <a class="link" href="libglabels-xml-paper.html#lgl-xml-paper-parse-papers-doc" title="lgl_xml_paper_parse_papers_doc ()">lgl_xml_paper_parse_papers_doc</a>      (xmlDocPtr papers_doc);
  55 <a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper">lglPaper</a> *          <a class="link" href="libglabels-xml-paper.html#lgl-xml-paper-parse-paper-node" title="lgl_xml_paper_parse_paper_node ()">lgl_xml_paper_parse_paper_node</a>      (xmlNodePtr paper_node);
  56 </pre>
  57 </div>
  58 <div class="refsect1" title="Description">
  59 <a name="libglabels-xml-paper.description"></a><h2>Description</h2>
  60 <p>
  61 This section describes a number of functions for parsing glabels
  62 XML paper definition files.
  63 </p>
  64 </div>
  65 <div class="refsect1" title="Details">
  66 <a name="libglabels-xml-paper.details"></a><h2>Details</h2>
  67 <div class="refsect2" title="lgl_xml_paper_read_papers_from_file ()">
  68 <a name="lgl-xml-paper-read-papers-from-file"></a><h3>lgl_xml_paper_read_papers_from_file ()</h3>
  69 <pre class="programlisting"><a
  70 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  71 >GList</a> *             lgl_xml_paper_read_papers_from_file (<a
  72 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  73 >gchar</a> *utf8_filename);</pre>
  74 <p>
  75 Read paper definitions from a file.</p>
  76 <p>
  77 </p>
  78 <div class="variablelist"><table border="0">
  79 <col align="left" valign="top">
  80 <tbody>
  81 <tr>
  82 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
  83 <td>       Filename of papers file (name encoded as UTF-8)
  84 </td>
  85 </tr>
  86 <tr>
  87 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  88 <td> a list of <a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper"><span class="type">lglPaper</span></a> structures.
  89
  90 </td>
  91 </tr>
  92 </tbody>
  93 </table></div>
  94 </div>
  95 <hr>
  96 <div class="refsect2" title="lgl_xml_paper_parse_papers_doc ()">
  97 <a name="lgl-xml-paper-parse-papers-doc"></a><h3>lgl_xml_paper_parse_papers_doc ()</h3>
  98 <pre class="programlisting"><a
  99 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 100 >GList</a> *             lgl_xml_paper_parse_papers_doc      (xmlDocPtr papers_doc);</pre>
 101 <p>
 102 Read paper definitions from a libxml <span class="type">xmlDocPtr</span> tree.</p>
 103 <p>
 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>papers_doc</code></em> :</span></p></td>
 110 <td>  libxml <span class="type">xmlDocPtr</span> tree, representing a papers definition file.
 111 </td>
 112 </tr>
 113 <tr>
 114 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 115 <td> a list of <a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper"><span class="type">lglPaper</span></a> structures.
 116
 117 </td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 </div>
 122 <hr>
 123 <div class="refsect2" title="lgl_xml_paper_parse_paper_node ()">
 124 <a name="lgl-xml-paper-parse-paper-node"></a><h3>lgl_xml_paper_parse_paper_node ()</h3>
 125 <pre class="programlisting"><a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper">lglPaper</a> *          lgl_xml_paper_parse_paper_node      (xmlNodePtr paper_node);</pre>
 126 <p>
 127 Read a single paper definition from a libxml <span class="type">xmlNodePtr</span> node.</p>
 128 <p>
 129 </p>
 130 <div class="variablelist"><table border="0">
 131 <col align="left" valign="top">
 132 <tbody>
 133 <tr>
 134 <td><p><span class="term"><em class="parameter"><code>paper_node</code></em> :</span></p></td>
 135 <td>  libxml <span class="type">xmlNodePtr</span> paper node from a <span class="type">xmlDocPtr</span> tree.
 136 </td>
 137 </tr>
 138 <tr>
 139 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 140 <td> a pointer to a newly created <a class="link" href="libglabels-paper.html#lglPaper" title="lglPaper"><span class="type">lglPaper</span></a> structure.
 141
 142 </td>
 143 </tr>
 144 </tbody>
 145 </table></div>
 146 </div>
 147 </div>
 148 </div>
 149 <div class="footer">
 150 <hr>
 151           Generated by GTK-Doc V1.11</div>
 152 </body>
 153 </html>