1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>The lglCategory Structure</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="LibGlabels Reference Manual">
8 <link rel="up" href="ch01.html" title="Basic LibGlabels Usage">
9 <link rel="prev" href="libglabels-paper.html" title="The lglPaper Structure">
10 <link rel="next" href="ch02.html" title="Working Directly With LibGlabels XML">
11 <meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 <link rel="chapter" href="ch01.html" title="Basic LibGlabels Usage">
14 <link rel="chapter" href="ch02.html" title="Working Directly With LibGlabels XML">
15 <link rel="chapter" href="ch03.html" title="Miscellaneous">
17 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
18 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
20 <td><a accesskey="p" href="libglabels-paper.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
22 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
23 <th width="100%" align="center">LibGlabels Reference Manual</th>
24 <td><a accesskey="n" href="ch02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
26 <tr><td colspan="5" class="shortcuts">
27 <a href="#libglabels-category.synopsis" class="shortcut">Top</a>
29 <a href="#libglabels-category.description" class="shortcut">Description</a>
32 <div class="refentry" title="The lglCategory Structure">
33 <a name="libglabels-category"></a><div class="titlepage"></div>
34 <div class="refnamediv"><table width="100%"><tr>
36 <h2><span class="refentrytitle"><a name="libglabels-category.top_of_page"></a>The lglCategory Structure</span></h2>
37 <p>The lglCategory Structure — Template category definitions</p>
39 <td valign="top" align="right"></td>
41 <div class="refsynopsisdiv" title="Synopsis">
42 <a name="libglabels-category.synopsis"></a><h2>Synopsis</h2>
43 <pre class="synopsis">
45 #include <libglabels/category.h>
47 <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a>;
48 <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> * <a class="link" href="libglabels-category.html#lgl-category-new" title="lgl_category_new ()">lgl_category_new</a> (<a
49 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
52 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
54 <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> * <a class="link" href="libglabels-category.html#lgl-category-dup" title="lgl_category_dup ()">lgl_category_dup</a> (const <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *orig);
55 void <a class="link" href="libglabels-category.html#lgl-category-free" title="lgl_category_free ()">lgl_category_free</a> (<a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *category);
58 <div class="refsect1" title="Description">
59 <a name="libglabels-category.description"></a><h2>Description</h2>
61 This section describes a structure for representing a category of stationary and related
65 <div class="refsect1" title="Details">
66 <a name="libglabels-category.details"></a><h2>Details</h2>
67 <div class="refsect2" title="lglCategory">
68 <a name="lglCategory"></a><h3>lglCategory</h3>
69 <pre class="programlisting">typedef struct {
70 gchar *id; /* Unique ID of category */
71 gchar *name; /* Localized name of category */
75 This structure defines a category.
77 <div class="variablelist"><table border="0">
78 <col align="left" valign="top">
81 <td><p><span class="term"><a
82 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
83 >gchar</a> *<em class="structfield"><code>id</code></em>;</span></p></td>
88 <td><p><span class="term"><a
89 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
90 >gchar</a> *<em class="structfield"><code>name</code></em>;</span></p></td>
91 <td>Localized category name.
98 <div class="refsect2" title="lgl_category_new ()">
99 <a name="lgl-category-new"></a><h3>lgl_category_new ()</h3>
100 <pre class="programlisting"><a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> * lgl_category_new (<a
101 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
104 href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
105 >gchar</a> *name);</pre>
107 Allocates and constructs a new <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure.</p>
110 <div class="variablelist"><table border="0">
111 <col align="left" valign="top">
114 <td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
115 <td> Id of category definition. (E.g. label, card, etc.) Should be
120 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
121 <td> Localized name of category.
125 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
126 <td> a pointer to a newly allocated <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure.
134 <div class="refsect2" title="lgl_category_dup ()">
135 <a name="lgl-category-dup"></a><h3>lgl_category_dup ()</h3>
136 <pre class="programlisting"><a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> * lgl_category_dup (const <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *orig);</pre>
138 Duplicates an existing <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure.</p>
141 <div class="variablelist"><table border="0">
142 <col align="left" valign="top">
145 <td><p><span class="term"><em class="parameter"><code>orig</code></em> :</span></p></td>
146 <td> <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure to be duplicated.
150 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
151 <td> a pointer to a newly allocated <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure.
159 <div class="refsect2" title="lgl_category_free ()">
160 <a name="lgl-category-free"></a><h3>lgl_category_free ()</h3>
161 <pre class="programlisting">void lgl_category_free (<a class="link" href="libglabels-category.html#lglCategory" title="lglCategory">lglCategory</a> *category);</pre>
163 Free all memory associated with an existing <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure.</p>
166 <div class="variablelist"><table border="0">
167 <col align="left" valign="top">
169 <td><p><span class="term"><em class="parameter"><code>category</code></em> :</span></p></td>
170 <td> pointer to <a class="link" href="libglabels-category.html#lglCategory" title="lglCategory"><span class="type">lglCategory</span></a> structure to be freed.
179 Generated by GTK-Doc V1.11</div>