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>LibGlabels 3.0 Reference Manual: XML Category Functions</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.20 (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="10"><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><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#libglabels-3.0-xml-category.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <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>
  24 <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>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="libglabels-3.0-xml-category"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="libglabels-3.0-xml-category.top_of_page"></a>XML Category Functions</span></h2>
  31 <p>XML Category Functions — Functions to parse glabels XML category definition files</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="libglabels-3.0-xml-category.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
  46 </td>
  47 <td class="function_name">
  48 <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>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
  54 </td>
  55 <td class="function_name">
  56 <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>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
  62 </td>
  63 <td class="function_name">
  64 <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>
  65 </td>
  66 </tr>
  67 </tbody>
  68 </table></div>
  69 </div>
  70 <div class="refsect1">
  71 <a name="libglabels-3.0-xml-category.object-hierarchy"></a><h2>Object Hierarchy</h2>
  72 <pre class="screen">
  73 </pre>
  74 </div>
  75 <div class="refsect1">
  76 <a name="libglabels-3.0-xml-category.includes"></a><h2>Includes</h2>
  77 <pre class="synopsis">#include &lt;libglabels/lgl-xml-category.h&gt;
  78 </pre>
  79 </div>
  80 <div class="refsect1">
  81 <a name="libglabels-3.0-xml-category.description"></a><h2>Description</h2>
  82 <p>
  83 This section describes a number of functions for parsing glabels
  84 XML category definition files.
  85 </p>
  86 </div>
  87 <div class="refsect1">
  88 <a name="libglabels-3.0-xml-category.functions_details"></a><h2>Functions</h2>
  89 <div class="refsect2">
  90 <a name="lgl-xml-category-read-categories-from-file"></a><h3>lgl_xml_category_read_categories_from_file ()</h3>
  91 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
  92 lgl_xml_category_read_categories_from_file
  93                                (<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>
  94 <p>Read category definitions from a file.</p>
  95 <div class="refsect3">
  96 <a name="id-1.3.3.7.2.5"></a><h4>Parameters</h4>
  97 <div class="informaltable"><table width="100%" border="0">
  98 <colgroup>
  99 <col width="150px" class="parameters_name">
 100 <col class="parameters_description">
 101 <col width="200px" class="parameters_annotations">
 102 </colgroup>
 103 <tbody><tr>
 104 <td class="parameter_name"><p>utf8_filename</p></td>
 105 <td class="parameter_description"><p>Filename of categories file (name encoded as UTF-8)</p></td>
 106 <td class="parameter_annotations"> </td>
 107 </tr></tbody>
 108 </table></div>
 109 </div>
 110 <div class="refsect3">
 111 <a name="id-1.3.3.7.2.6"></a><h4>Returns</h4>
 112 <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>
 113 <p></p>
 114 </div>
 115 </div>
 116 <hr>
 117 <div class="refsect2">
 118 <a name="lgl-xml-category-parse-categories-doc"></a><h3>lgl_xml_category_parse_categories_doc ()</h3>
 119 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
 120 lgl_xml_category_parse_categories_doc (<em class="parameter"><code><span class="type">xmlDocPtr</span> categories_doc</code></em>);</pre>
 121 <p>Read category definitions from a libxml <span class="type">xmlDocPtr</span> tree.</p>
 122 <div class="refsect3">
 123 <a name="id-1.3.3.7.3.5"></a><h4>Parameters</h4>
 124 <div class="informaltable"><table width="100%" border="0">
 125 <colgroup>
 126 <col width="150px" class="parameters_name">
 127 <col class="parameters_description">
 128 <col width="200px" class="parameters_annotations">
 129 </colgroup>
 130 <tbody><tr>
 131 <td class="parameter_name"><p>categories_doc</p></td>
 132 <td class="parameter_description"><p>libxml <span class="type">xmlDocPtr</span> tree, representing a categories
 133 definition file.</p></td>
 134 <td class="parameter_annotations"> </td>
 135 </tr></tbody>
 136 </table></div>
 137 </div>
 138 <div class="refsect3">
 139 <a name="id-1.3.3.7.3.6"></a><h4>Returns</h4>
 140 <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>
 141 <p></p>
 142 </div>
 143 </div>
 144 <hr>
 145 <div class="refsect2">
 146 <a name="lgl-xml-category-parse-category-node"></a><h3>lgl_xml_category_parse_category_node ()</h3>
 147 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
 148 lgl_xml_category_parse_category_node (<em class="parameter"><code><span class="type">xmlNodePtr</span> category_node</code></em>);</pre>
 149 <p>Read a single category definition from a libxml <span class="type">xmlNodePtr</span> node.</p>
 150 <div class="refsect3">
 151 <a name="id-1.3.3.7.4.5"></a><h4>Parameters</h4>
 152 <div class="informaltable"><table width="100%" border="0">
 153 <colgroup>
 154 <col width="150px" class="parameters_name">
 155 <col class="parameters_description">
 156 <col width="200px" class="parameters_annotations">
 157 </colgroup>
 158 <tbody><tr>
 159 <td class="parameter_name"><p>category_node</p></td>
 160 <td class="parameter_description"><p>libxml <span class="type">xmlNodePtr</span> category node from a <span class="type">xmlDocPtr</span> tree.</p></td>
 161 <td class="parameter_annotations"> </td>
 162 </tr></tbody>
 163 </table></div>
 164 </div>
 165 <div class="refsect3">
 166 <a name="id-1.3.3.7.4.6"></a><h4>Returns</h4>
 167 <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>
 168 <p></p>
 169 </div>
 170 </div>
 171 </div>
 172 <div class="refsect1">
 173 <a name="libglabels-3.0-xml-category.other_details"></a><h2>Types and Values</h2>
 174 </div>
 175 </div>
 176 <div class="footer">
 177 <hr>
 178           Generated by GTK-Doc V1.20</div>
 179 </body>
 180 </html>