git.sur5r.net Git - glabels/blob - docs/libglabels/xml/xml-category.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id="libglabels-xml-category">
   6 <refmeta>
   7 <refentrytitle role="top_of_page" id="libglabels-xml-category.top_of_page">XML Category Functions</refentrytitle>
   8 <manvolnum>3</manvolnum>
   9 <refmiscinfo>LIBGLABELS Library</refmiscinfo>
  10 </refmeta>
  11
  12 <refnamediv>
  13 <refname>XML Category Functions</refname>
  14 <refpurpose>Functions to parse glabels XML category definition files</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv id="libglabels-xml-category.synopsis" role="synopsis">
  18 <title role="synopsis.title">Synopsis</title>
  19
  20 <synopsis>
  21
  22 #include &lt;libglabels/xml-category.h&gt;
  23
  24 <link linkend="GList">GList</link> *             <link linkend="lgl-xml-category-read-categories-from-file">lgl_xml_category_read_categories_from_file</link>
  25                                                         (<link linkend="gchar">gchar</link> *utf8_filename);
  26 <link linkend="GList">GList</link> *             <link linkend="lgl-xml-category-parse-categories-doc">lgl_xml_category_parse_categories_doc</link>
  27                                                         (<link linkend="xmlDocPtr">xmlDocPtr</link> categories_doc);
  28 <link linkend="lglCategory">lglCategory</link> *       <link linkend="lgl-xml-category-parse-category-node">lgl_xml_category_parse_category_node</link>
  29                                                         (<link linkend="xmlNodePtr">xmlNodePtr</link> category_node);
  30 </synopsis>
  31 </refsynopsisdiv>
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41 <refsect1 id="libglabels-xml-category.description" role="desc">
  42 <title role="desc.title">Description</title>
  43 <para>
  44 This section describes a number of functions for parsing glabels
  45 XML category definition files.
  46 </para>
  47 </refsect1>
  48
  49 <refsect1 id="libglabels-xml-category.details" role="details">
  50 <title role="details.title">Details</title>
  51 <refsect2 id="lgl-xml-category-read-categories-from-file" role="function">
  52 <title>lgl_xml_category_read_categories_from_file ()</title>
  53 <indexterm zone="lgl-xml-category-read-categories-from-file"><primary sortas="lgl_xml_category_read_categories_from_file">lgl_xml_category_read_categories_from_file</primary></indexterm><programlisting><link linkend="GList">GList</link> *             lgl_xml_category_read_categories_from_file
  54                                                         (<link linkend="gchar">gchar</link> *utf8_filename);</programlisting>
  55 <para>
  56 Read category definitions from a file.</para>
  57 <para>
  58 </para><variablelist role="params">
  59 <varlistentry><term><parameter>utf8_filename</parameter>&#160;:</term>
  60 <listitem><simpara>       Filename of categories file (name encoded as UTF-8)
  61 </simpara></listitem></varlistentry>
  62 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a list of <link linkend="lglCategory"><type>lglCategory</type></link> structures.
  63
  64 </simpara></listitem></varlistentry>
  65 </variablelist></refsect2>
  66 <refsect2 id="lgl-xml-category-parse-categories-doc" role="function">
  67 <title>lgl_xml_category_parse_categories_doc ()</title>
  68 <indexterm zone="lgl-xml-category-parse-categories-doc"><primary sortas="lgl_xml_category_parse_categories_doc">lgl_xml_category_parse_categories_doc</primary></indexterm><programlisting><link linkend="GList">GList</link> *             lgl_xml_category_parse_categories_doc
  69                                                         (<link linkend="xmlDocPtr">xmlDocPtr</link> categories_doc);</programlisting>
  70 <para>
  71 Read category definitions from a libxml <link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> tree.</para>
  72 <para>
  73 </para><variablelist role="params">
  74 <varlistentry><term><parameter>categories_doc</parameter>&#160;:</term>
  75 <listitem><simpara>  libxml <link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> tree, representing a categories
  76 definition file.
  77 </simpara></listitem></varlistentry>
  78 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a list of <link linkend="lglCategory"><type>lglCategory</type></link> structures.
  79
  80 </simpara></listitem></varlistentry>
  81 </variablelist></refsect2>
  82 <refsect2 id="lgl-xml-category-parse-category-node" role="function">
  83 <title>lgl_xml_category_parse_category_node ()</title>
  84 <indexterm zone="lgl-xml-category-parse-category-node"><primary sortas="lgl_xml_category_parse_category_node">lgl_xml_category_parse_category_node</primary></indexterm><programlisting><link linkend="lglCategory">lglCategory</link> *       lgl_xml_category_parse_category_node
  85                                                         (<link linkend="xmlNodePtr">xmlNodePtr</link> category_node);</programlisting>
  86 <para>
  87 Read a single category definition from a libxml <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> node.</para>
  88 <para>
  89 </para><variablelist role="params">
  90 <varlistentry><term><parameter>category_node</parameter>&#160;:</term>
  91 <listitem><simpara>  libxml <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> category node from a <link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> tree.
  92 </simpara></listitem></varlistentry>
  93 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a pointer to a newly created <link linkend="lglCategory"><type>lglCategory</type></link> structure.
  94
  95 </simpara></listitem></varlistentry>
  96 </variablelist></refsect2>
  97
  98 </refsect1>
  99
 100
 101
 102
 103 </refentry>