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: 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="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.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-category.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="libglabels-3.0-xml-paper.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-template.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-category"></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-category.top_of_page"></a>XML Category Functions</span></h2>
  30 <p>XML Category Functions — Functions to parse glabels XML category 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-category.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-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> <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-category.html#lgl-xml-category-parse-categories-doc" title="lgl_xml_category_parse_categories_doc ()">lgl_xml_category_parse_categories_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-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
  61 </td>
  62 <td class="function_name">
  63 <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> <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-category.includes"></a><h2>Includes</h2>
  71 <pre class="synopsis">#include &lt;libglabels/lgl-xml-category.h&gt;
  72 </pre>
  73 </div>
  74 <div class="refsect1">
  75 <a name="libglabels-3.0-xml-category.description"></a><h2>Description</h2>
  76 <p>
  77 This section describes a number of functions for parsing glabels
  78 XML category definition files.
  79 </p>
  80 </div>
  81 <div class="refsect1">
  82 <a name="libglabels-3.0-xml-category.functions_details"></a><h2>Functions</h2>
  83 <div class="refsect2">
  84 <a name="lgl-xml-category-read-categories-from-file"></a><h3>lgl_xml_category_read_categories_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_category_read_categories_from_file
  87                                (<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>
  88 <p>Read category definitions from a file.</p>
  89 <div class="refsect3">
  90 <a name="id-1.3.3.6.2.5"></a><h4>Parameters</h4>
  91 <div class="informaltable"><table width="100%" border="0">
  92 <colgroup>
  93 <col width="150px" class="parameters_name">
  94 <col class="parameters_description">
  95 <col width="200px" class="parameters_annotations">
  96 </colgroup>
  97 <tbody><tr>
  98 <td class="parameter_name"><p>utf8_filename</p></td>
  99 <td class="parameter_description"><p>Filename of categories file (name encoded as UTF-8)</p></td>
 100 <td class="parameter_annotations"> </td>
 101 </tr></tbody>
 102 </table></div>
 103 </div>
 104 <div class="refsect3">
 105 <a name="id-1.3.3.6.2.6"></a><h4>Returns</h4>
 106 <p> a list of <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structures.</p>
 107 </div>
 108 </div>
 109 <hr>
 110 <div class="refsect2">
 111 <a name="lgl-xml-category-parse-categories-doc"></a><h3>lgl_xml_category_parse_categories_doc ()</h3>
 112 <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 113 lgl_xml_category_parse_categories_doc (<em class="parameter"><code><span class="type">xmlDocPtr</span> categories_doc</code></em>);</pre>
 114 <p>Read category definitions from a libxml <span class="type">xmlDocPtr</span> tree.</p>
 115 <div class="refsect3">
 116 <a name="id-1.3.3.6.3.5"></a><h4>Parameters</h4>
 117 <div class="informaltable"><table width="100%" border="0">
 118 <colgroup>
 119 <col width="150px" class="parameters_name">
 120 <col class="parameters_description">
 121 <col width="200px" class="parameters_annotations">
 122 </colgroup>
 123 <tbody><tr>
 124 <td class="parameter_name"><p>categories_doc</p></td>
 125 <td class="parameter_description"><p>libxml <span class="type">xmlDocPtr</span> tree, representing a categories
 126 definition file.</p></td>
 127 <td class="parameter_annotations"> </td>
 128 </tr></tbody>
 129 </table></div>
 130 </div>
 131 <div class="refsect3">
 132 <a name="id-1.3.3.6.3.6"></a><h4>Returns</h4>
 133 <p> a list of <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structures.</p>
 134 </div>
 135 </div>
 136 <hr>
 137 <div class="refsect2">
 138 <a name="lgl-xml-category-parse-category-node"></a><h3>lgl_xml_category_parse_category_node ()</h3>
 139 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
 140 lgl_xml_category_parse_category_node (<em class="parameter"><code><span class="type">xmlNodePtr</span> category_node</code></em>);</pre>
 141 <p>Read a single category definition from a libxml <span class="type">xmlNodePtr</span> node.</p>
 142 <div class="refsect3">
 143 <a name="id-1.3.3.6.4.5"></a><h4>Parameters</h4>
 144 <div class="informaltable"><table width="100%" border="0">
 145 <colgroup>
 146 <col width="150px" class="parameters_name">
 147 <col class="parameters_description">
 148 <col width="200px" class="parameters_annotations">
 149 </colgroup>
 150 <tbody><tr>
 151 <td class="parameter_name"><p>category_node</p></td>
 152 <td class="parameter_description"><p>libxml <span class="type">xmlNodePtr</span> category node from a <span class="type">xmlDocPtr</span> tree.</p></td>
 153 <td class="parameter_annotations"> </td>
 154 </tr></tbody>
 155 </table></div>
 156 </div>
 157 <div class="refsect3">
 158 <a name="id-1.3.3.6.4.6"></a><h4>Returns</h4>
 159 <p> 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.</p>
 160 </div>
 161 </div>
 162 </div>
 163 <div class="refsect1">
 164 <a name="libglabels-3.0-xml-category.other_details"></a><h2>Types and Values</h2>
 165 </div>
 166 </div>
 167 <div class="footer">
 168 <hr>Generated by GTK-Doc V1.24</div>
 169 </body>
 170 </html>