git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-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.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-paper.html" title="XML Paper Functions">
  10 <link rel="next" href="libglabels-xml-template.html" title="XML Template 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="libglabels-xml-paper.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-template.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-category.synopsis" class="shortcut">Top</a>
  28                  |
  29                 <a href="#libglabels-xml-category.description" class="shortcut">Description</a>
  30 </td></tr>
  31 </table>
  32 <div class="refentry" title="XML Category Functions">
  33 <a name="libglabels-xml-category"></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-category.top_of_page"></a>XML Category Functions</span></h2>
  37 <p>XML Category Functions — Functions to parse glabels XML category 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-category.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">
  44
  45 #include &lt;libglabels/xml-category.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-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>
  50                                                         (<a
  51 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  52 >gchar</a> *utf8_filename);
  53 <a
  54 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  55 >GList</a> *             <a class="link" href="libglabels-xml-category.html#lgl-xml-category-parse-categories-doc" title="lgl_xml_category_parse_categories_doc ()">lgl_xml_category_parse_categories_doc</a>
  56                                                         (xmlDocPtr categories_doc);
  57 <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *       <a class="link" href="libglabels-xml-category.html#lgl-xml-category-parse-category-node" title="lgl_xml_category_parse_category_node ()">lgl_xml_category_parse_category_node</a>
  58                                                         (xmlNodePtr category_node);
  59 </pre>
  60 </div>
  61 <div class="refsect1" title="Description">
  62 <a name="libglabels-xml-category.description"></a><h2>Description</h2>
  63 <p>
  64 This section describes a number of functions for parsing glabels
  65 XML category definition files.
  66 </p>
  67 </div>
  68 <div class="refsect1" title="Details">
  69 <a name="libglabels-xml-category.details"></a><h2>Details</h2>
  70 <div class="refsect2" title="lgl_xml_category_read_categories_from_file ()">
  71 <a name="lgl-xml-category-read-categories-from-file"></a><h3>lgl_xml_category_read_categories_from_file ()</h3>
  72 <pre class="programlisting"><a
  73 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
  74 >GList</a> *             lgl_xml_category_read_categories_from_file
  75                                                         (<a
  76 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
  77 >gchar</a> *utf8_filename);</pre>
  78 <p>
  79 Read category definitions from a file.</p>
  80 <p>
  81 </p>
  82 <div class="variablelist"><table border="0">
  83 <col align="left" valign="top">
  84 <tbody>
  85 <tr>
  86 <td><p><span class="term"><em class="parameter"><code>utf8_filename</code></em> :</span></p></td>
  87 <td>       Filename of categories file (name encoded as UTF-8)
  88 </td>
  89 </tr>
  90 <tr>
  91 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  92 <td> a list of <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structures.
  93
  94 </td>
  95 </tr>
  96 </tbody>
  97 </table></div>
  98 </div>
  99 <hr>
 100 <div class="refsect2" title="lgl_xml_category_parse_categories_doc ()">
 101 <a name="lgl-xml-category-parse-categories-doc"></a><h3>lgl_xml_category_parse_categories_doc ()</h3>
 102 <pre class="programlisting"><a
 103 href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"
 104 >GList</a> *             lgl_xml_category_parse_categories_doc
 105                                                         (xmlDocPtr categories_doc);</pre>
 106 <p>
 107 Read category definitions from a libxml <span class="type">xmlDocPtr</span> tree.</p>
 108 <p>
 109 </p>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term"><em class="parameter"><code>categories_doc</code></em> :</span></p></td>
 115 <td>  libxml <span class="type">xmlDocPtr</span> tree, representing a categories
 116 definition file.
 117 </td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 121 <td> a list of <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structures.
 122
 123 </td>
 124 </tr>
 125 </tbody>
 126 </table></div>
 127 </div>
 128 <hr>
 129 <div class="refsect2" title="lgl_xml_category_parse_category_node ()">
 130 <a name="lgl-xml-category-parse-category-node"></a><h3>lgl_xml_category_parse_category_node ()</h3>
 131 <pre class="programlisting"><a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *       lgl_xml_category_parse_category_node
 132                                                         (xmlNodePtr category_node);</pre>
 133 <p>
 134 Read a single category definition from a libxml <span class="type">xmlNodePtr</span> node.</p>
 135 <p>
 136 </p>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><span class="term"><em class="parameter"><code>category_node</code></em> :</span></p></td>
 142 <td>  libxml <span class="type">xmlNodePtr</span> category node from a <span class="type">xmlDocPtr</span> tree.
 143 </td>
 144 </tr>
 145 <tr>
 146 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 147 <td> a pointer to a newly created <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure.
 148
 149 </td>
 150 </tr>
 151 </tbody>
 152 </table></div>
 153 </div>
 154 </div>
 155 </div>
 156 <div class="footer">
 157 <hr>
 158           Generated by GTK-Doc V1.11</div>
 159 </body>
 160 </html>