git.sur5r.net Git - glabels/blob - docs/libglabels/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-category">
   6 <refmeta>
   7 <refentrytitle role="top_of_page" id="libglabels-category.top_of_page">The lglCategory Structure</refentrytitle>
   8 <manvolnum>3</manvolnum>
   9 <refmiscinfo>LIBGLABELS Library</refmiscinfo>
  10 </refmeta>
  11
  12 <refnamediv>
  13 <refname>The lglCategory Structure</refname>
  14 <refpurpose>Template category definitions</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv id="libglabels-category.synopsis" role="synopsis">
  18 <title role="synopsis.title">Synopsis</title>
  19
  20 <synopsis>
  21
  22 #include &lt;libglabels/category.h&gt;
  23
  24                     <link linkend="lglCategory">lglCategory</link>;
  25 <link linkend="lglCategory">lglCategory</link> *       <link linkend="lgl-category-new">lgl_category_new</link>                    (<link linkend="gchar">gchar</link> *id,
  26                                                          <link linkend="gchar">gchar</link> *name);
  27 <link linkend="lglCategory">lglCategory</link> *       <link linkend="lgl-category-dup">lgl_category_dup</link>                    (const <link linkend="lglCategory">lglCategory</link> *orig);
  28 <link linkend="void">void</link>                <link linkend="lgl-category-free">lgl_category_free</link>                   (<link linkend="lglCategory">lglCategory</link> *category);
  29 </synopsis>
  30 </refsynopsisdiv>
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40 <refsect1 id="libglabels-category.description" role="desc">
  41 <title role="desc.title">Description</title>
  42 <para>
  43 This section describes a structure for representing a category of stationary and related
  44 functions.
  45 </para>
  46 </refsect1>
  47
  48 <refsect1 id="libglabels-category.details" role="details">
  49 <title role="details.title">Details</title>
  50 <refsect2 id="lglCategory" role="struct">
  51 <title>lglCategory</title>
  52 <indexterm zone="lglCategory"><primary sortas="lglCategory">lglCategory</primary></indexterm><programlisting>typedef struct {
  53         gchar               *id;     /* Unique ID of category */
  54         gchar               *name;   /* Localized name of category */
  55 } lglCategory;
  56 </programlisting>
  57 <para>
  58 This structure defines a category.
  59 </para><variablelist role="struct">
  60 <varlistentry>
  61 <term><link linkend="gchar">gchar</link>&#160;*<structfield>id</structfield>;</term>
  62 <listitem><simpara>Category ID.
  63 </simpara></listitem>
  64 </varlistentry>
  65 <varlistentry>
  66 <term><link linkend="gchar">gchar</link>&#160;*<structfield>name</structfield>;</term>
  67 <listitem><simpara>Localized category name.
  68 </simpara></listitem>
  69 </varlistentry>
  70 </variablelist></refsect2>
  71 <refsect2 id="lgl-category-new" role="function">
  72 <title>lgl_category_new ()</title>
  73 <indexterm zone="lgl-category-new"><primary sortas="lgl_category_new">lgl_category_new</primary></indexterm><programlisting><link linkend="lglCategory">lglCategory</link> *       lgl_category_new                    (<link linkend="gchar">gchar</link> *id,
  74                                                          <link linkend="gchar">gchar</link> *name);</programlisting>
  75 <para>
  76 Allocates and constructs a new <link linkend="lglCategory"><type>lglCategory</type></link> structure.</para>
  77 <para>
  78 </para><variablelist role="params">
  79 <varlistentry><term><parameter>id</parameter>&#160;:</term>
  80 <listitem><simpara>     Id of category definition. (E.g. label, card, etc.)  Should be
  81          unique.
  82 </simpara></listitem></varlistentry>
  83 <varlistentry><term><parameter>name</parameter>&#160;:</term>
  84 <listitem><simpara>   Localized name of category.
  85 </simpara></listitem></varlistentry>
  86 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a pointer to a newly allocated <link linkend="lglCategory"><type>lglCategory</type></link> structure.
  87
  88 </simpara></listitem></varlistentry>
  89 </variablelist></refsect2>
  90 <refsect2 id="lgl-category-dup" role="function">
  91 <title>lgl_category_dup ()</title>
  92 <indexterm zone="lgl-category-dup"><primary sortas="lgl_category_dup">lgl_category_dup</primary></indexterm><programlisting><link linkend="lglCategory">lglCategory</link> *       lgl_category_dup                    (const <link linkend="lglCategory">lglCategory</link> *orig);</programlisting>
  93 <para>
  94 Duplicates an existing <link linkend="lglCategory"><type>lglCategory</type></link> structure.</para>
  95 <para>
  96 </para><variablelist role="params">
  97 <varlistentry><term><parameter>orig</parameter>&#160;:</term>
  98 <listitem><simpara>  <link linkend="lglCategory"><type>lglCategory</type></link> structure to be duplicated.
  99 </simpara></listitem></varlistentry>
 100 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a pointer to a newly allocated <link linkend="lglCategory"><type>lglCategory</type></link> structure.
 101
 102 </simpara></listitem></varlistentry>
 103 </variablelist></refsect2>
 104 <refsect2 id="lgl-category-free" role="function">
 105 <title>lgl_category_free ()</title>
 106 <indexterm zone="lgl-category-free"><primary sortas="lgl_category_free">lgl_category_free</primary></indexterm><programlisting><link linkend="void">void</link>                lgl_category_free                   (<link linkend="lglCategory">lglCategory</link> *category);</programlisting>
 107 <para>
 108 Free all memory associated with an existing <link linkend="lglCategory"><type>lglCategory</type></link> structure.</para>
 109 <para>
 110 </para><variablelist role="params">
 111 <varlistentry><term><parameter>category</parameter>&#160;:</term>
 112 <listitem><simpara>  pointer to <link linkend="lglCategory"><type>lglCategory</type></link> structure to be freed.
 113 </simpara></listitem></varlistentry>
 114 </variablelist></refsect2>
 115
 116 </refsect1>
 117
 118
 119
 120
 121 </refentry>