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">
5 <refentry id="libglabels-category">
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>
13 <refname>The lglCategory Structure</refname>
14 <refpurpose>Template category definitions</refpurpose>
17 <refsynopsisdiv id="libglabels-category.synopsis" role="synopsis">
18 <title role="synopsis.title">Synopsis</title>
22 #include <libglabels/category.h>
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);
40 <refsect1 id="libglabels-category.description" role="desc">
41 <title role="desc.title">Description</title>
43 This section describes a structure for representing a category of stationary and related
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 */
58 This structure defines a category.
59 </para><variablelist role="struct">
61 <term><link linkend="gchar">gchar</link> *<structfield>id</structfield>;</term>
62 <listitem><simpara>Category ID.
66 <term><link linkend="gchar">gchar</link> *<structfield>name</structfield>;</term>
67 <listitem><simpara>Localized category name.
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>
76 Allocates and constructs a new <link linkend="lglCategory"><type>lglCategory</type></link> structure.</para>
78 </para><variablelist role="params">
79 <varlistentry><term><parameter>id</parameter> :</term>
80 <listitem><simpara> Id of category definition. (E.g. label, card, etc.) Should be
82 </simpara></listitem></varlistentry>
83 <varlistentry><term><parameter>name</parameter> :</term>
84 <listitem><simpara> Localized name of category.
85 </simpara></listitem></varlistentry>
86 <varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to a newly allocated <link linkend="lglCategory"><type>lglCategory</type></link> structure.
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>
94 Duplicates an existing <link linkend="lglCategory"><type>lglCategory</type></link> structure.</para>
96 </para><variablelist role="params">
97 <varlistentry><term><parameter>orig</parameter> :</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> :</term><listitem><simpara> a pointer to a newly allocated <link linkend="lglCategory"><type>lglCategory</type></link> structure.
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>
108 Free all memory associated with an existing <link linkend="lglCategory"><type>lglCategory</type></link> structure.</para>
110 </para><variablelist role="params">
111 <varlistentry><term><parameter>category</parameter> :</term>
112 <listitem><simpara> pointer to <link linkend="lglCategory"><type>lglCategory</type></link> structure to be freed.
113 </simpara></listitem></varlistentry>
114 </variablelist></refsect2>