git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-3.0-xml-category.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 Category 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-paper.html" title="XML Paper Functions">
  10 <link rel="next" href="libglabels-3.0-xml-template.html" title="XML Template 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-paper.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-template.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-category.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libglabels-3.0-xml-category.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libglabels-3.0-xml-category"></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-category.top_of_page"></a>XML Category Functions</span></h2>
  34 <p>XML Category Functions — Functions to parse glabels XML category 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-category.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;libglabels/lgl-xml-category.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-category.html#lgl-xml-category-read-categories-from-file" title="lgl_xml_category_read_categories_from_file ()">lgl_xml_category_read_categories_from_file</a>
  44                                                         (<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>);
  45 <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-category.html#lgl-xml-category-parse-categories-doc" title="lgl_xml_category_parse_categories_doc ()">lgl_xml_category_parse_categories_doc</a>
  46                                                         (<em class="parameter"><code><span class="type">xmlDocPtr</span> categories_doc</code></em>);
  47 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *       <a class="link" href="libglabels-3.0-xml-category.html#lgl-xml-category-parse-category-node" title="lgl_xml_category_parse_category_node ()">lgl_xml_category_parse_category_node</a>
  48                                                         (<em class="parameter"><code><span class="type">xmlNodePtr</span> category_node</code></em>);
  49 </pre>
  50 </div>
  51 <div class="refsect1">
  52 <a name="libglabels-3.0-xml-category.description"></a><h2>Description</h2>
  53 <p>
  54 This section describes a number of functions for parsing glabels
  55 XML category definition files.
  56 </p>
  57 </div>
  58 <div class="refsect1">
  59 <a name="libglabels-3.0-xml-category.details"></a><h2>Details</h2>
  60 <div class="refsect2">
  61 <a name="lgl-xml-category-read-categories-from-file"></a><h3>lgl_xml_category_read_categories_from_file ()</h3>
  62 <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_category_read_categories_from_file
  63                                                         (<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>
  64 <p>
  65 Read category definitions from a file.
  66 </p>
  67 <div class="variablelist"><table border="0">
  68 <col align="left" valign="top">
  69 <tbody>
  70 <tr>
  71 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
  72 <td>Filename of categories file (name encoded as UTF-8)</td>
  73 </tr>
  74 <tr>
  75 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  76 <td>a list of <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structures.</td>
  77 </tr>
  78 </tbody>
  79 </table></div>
  80 </div>
  81 <hr>
  82 <div class="refsect2">
  83 <a name="lgl-xml-category-parse-categories-doc"></a><h3>lgl_xml_category_parse_categories_doc ()</h3>
  84 <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_category_parse_categories_doc
  85                                                         (<em class="parameter"><code><span class="type">xmlDocPtr</span> categories_doc</code></em>);</pre>
  86 <p>
  87 Read category definitions from a libxml <span class="type">xmlDocPtr</span> tree.
  88 </p>
  89 <div class="variablelist"><table border="0">
  90 <col align="left" valign="top">
  91 <tbody>
  92 <tr>
  93 <td><p><span class="term"><em class="parameter"><code>categories_doc</code></em> :</span></p></td>
  94 <td>libxml <span class="type">xmlDocPtr</span> tree, representing a categories
  95 definition file.</td>
  96 </tr>
  97 <tr>
  98 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  99 <td>a list of <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structures.</td>
 100 </tr>
 101 </tbody>
 102 </table></div>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="lgl-xml-category-parse-category-node"></a><h3>lgl_xml_category_parse_category_node ()</h3>
 107 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *       lgl_xml_category_parse_category_node
 108                                                         (<em class="parameter"><code><span class="type">xmlNodePtr</span> category_node</code></em>);</pre>
 109 <p>
 110 Read a single category definition from a libxml <span class="type">xmlNodePtr</span> node.
 111 </p>
 112 <div class="variablelist"><table border="0">
 113 <col align="left" valign="top">
 114 <tbody>
 115 <tr>
 116 <td><p><span class="term"><em class="parameter"><code>category_node</code></em> :</span></p></td>
 117 <td>libxml <span class="type">xmlNodePtr</span> category node from a <span class="type">xmlDocPtr</span> tree.</td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 121 <td>a pointer to a newly created <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</td>
 122 </tr>
 123 </tbody>
 124 </table></div>
 125 </div>
 126 </div>
 127 </div>
 128 <div class="footer">
 129 <hr>
 130           Generated by GTK-Doc V1.17</div>
 131 </body>
 132 </html>