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>LibGlabels 3.0 Reference Manual: The lglCategory Structure</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="ch01.html" title="Basic LibGlabels Usage">
9 <link rel="prev" href="libglabels-3.0-paper.html" title="The lglPaper Structure">
10 <link rel="next" href="libglabels-3.0-vendor.html" title="The lglVendor Structure">
11 <meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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-category.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19 <a href="#libglabels-3.0-category.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="libglabels-3.0-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-vendor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26 <div class="refentry">
27 <a name="libglabels-3.0-category"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
30 <h2><span class="refentrytitle"><a name="libglabels-3.0-category.top_of_page"></a>The lglCategory Structure</span></h2>
31 <p>The lglCategory Structure — Template category definitions</p>
33 <td class="gallery_image" valign="top" align="right"></td>
35 <div class="refsect1">
36 <a name="libglabels-3.0-category.functions"></a><h2>Functions</h2>
37 <div class="informaltable"><table width="100%" border="0">
39 <col width="150px" class="functions_return">
40 <col class="functions_name">
44 <td class="function_type">
45 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
47 <td class="function_name">
48 <a class="link" href="libglabels-3.0-category.html#lgl-category-new" title="lgl_category_new ()">lgl_category_new</a> <span class="c_punctuation">()</span>
52 <td class="function_type">
53 <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
55 <td class="function_name">
56 <a class="link" href="libglabels-3.0-category.html#lgl-category-dup" title="lgl_category_dup ()">lgl_category_dup</a> <span class="c_punctuation">()</span>
60 <td class="function_type">
61 <span class="returnvalue">void</span>
63 <td class="function_name">
64 <a class="link" href="libglabels-3.0-category.html#lgl-category-free" title="lgl_category_free ()">lgl_category_free</a> <span class="c_punctuation">()</span>
70 <div class="refsect1">
71 <a name="libglabels-3.0-category.other"></a><h2>Types and Values</h2>
72 <div class="informaltable"><table width="100%" border="0">
74 <col width="150px" class="name">
75 <col class="description">
78 <td class="datatype_keyword">struct</td>
79 <td class="function_name"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory">lglCategory</a></td>
83 <div class="refsect1">
84 <a name="libglabels-3.0-category.object-hierarchy"></a><h2>Object Hierarchy</h2>
88 <div class="refsect1">
89 <a name="libglabels-3.0-category.includes"></a><h2>Includes</h2>
90 <pre class="synopsis">#include <libglabels/lgl-category.h>
93 <div class="refsect1">
94 <a name="libglabels-3.0-category.description"></a><h2>Description</h2>
96 This section describes a structure for representing a category of stationary and related
100 <div class="refsect1">
101 <a name="libglabels-3.0-category.functions_details"></a><h2>Functions</h2>
102 <div class="refsect2">
103 <a name="lgl-category-new"></a><h3>lgl_category_new ()</h3>
104 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
105 lgl_category_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>,
106 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
107 <p>Allocates and constructs a new <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</p>
108 <div class="refsect3">
109 <a name="id-1.2.5.8.2.5"></a><h4>Parameters</h4>
110 <div class="informaltable"><table width="100%" border="0">
112 <col width="150px" class="parameters_name">
113 <col class="parameters_description">
114 <col width="200px" class="parameters_annotations">
118 <td class="parameter_name"><p>id</p></td>
119 <td class="parameter_description"><p>Id of category definition. (E.g. label, card, etc.) Should be
121 <td class="parameter_annotations"> </td>
124 <td class="parameter_name"><p>name</p></td>
125 <td class="parameter_description"><p>Localized name of category.</p></td>
126 <td class="parameter_annotations"> </td>
131 <div class="refsect3">
132 <a name="id-1.2.5.8.2.6"></a><h4>Returns</h4>
133 <p> a pointer to a newly allocated <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</p>
138 <div class="refsect2">
139 <a name="lgl-category-dup"></a><h3>lgl_category_dup ()</h3>
140 <pre class="programlisting"><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="returnvalue">lglCategory</span></a> *
141 lgl_category_dup (<em class="parameter"><code>const <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> *orig</code></em>);</pre>
142 <p>Duplicates an existing <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</p>
143 <div class="refsect3">
144 <a name="id-1.2.5.8.3.5"></a><h4>Parameters</h4>
145 <div class="informaltable"><table width="100%" border="0">
147 <col width="150px" class="parameters_name">
148 <col class="parameters_description">
149 <col width="200px" class="parameters_annotations">
152 <td class="parameter_name"><p>orig</p></td>
153 <td class="parameter_description"><p><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure to be duplicated.</p></td>
154 <td class="parameter_annotations"> </td>
158 <div class="refsect3">
159 <a name="id-1.2.5.8.3.6"></a><h4>Returns</h4>
160 <p> a pointer to a newly allocated <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</p>
165 <div class="refsect2">
166 <a name="lgl-category-free"></a><h3>lgl_category_free ()</h3>
167 <pre class="programlisting"><span class="returnvalue">void</span>
168 lgl_category_free (<em class="parameter"><code><a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> *category</code></em>);</pre>
169 <p>Free all memory associated with an existing <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure.</p>
170 <div class="refsect3">
171 <a name="id-1.2.5.8.4.5"></a><h4>Parameters</h4>
172 <div class="informaltable"><table width="100%" border="0">
174 <col width="150px" class="parameters_name">
175 <col class="parameters_description">
176 <col width="200px" class="parameters_annotations">
179 <td class="parameter_name"><p>category</p></td>
180 <td class="parameter_description"><p>pointer to <a class="link" href="libglabels-3.0-category.html#lglCategory" title="struct lglCategory"><span class="type">lglCategory</span></a> structure to be freed.</p></td>
181 <td class="parameter_annotations"> </td>
187 <div class="refsect1">
188 <a name="libglabels-3.0-category.other_details"></a><h2>Types and Values</h2>
189 <div class="refsect2">
190 <a name="lglCategory"></a><h3>struct lglCategory</h3>
191 <pre class="programlisting">struct lglCategory {
192 gchar *id; /* Unique ID of category */
193 gchar *name; /* Localized name of category */
197 This structure defines a category.
199 <div class="refsect3">
200 <a name="id-1.2.5.9.2.5"></a><h4>Members</h4>
201 <div class="informaltable"><table width="100%" border="0">
203 <col width="300px" class="struct_members_name">
204 <col class="struct_members_description">
205 <col width="200px" class="struct_members_annotations">
209 <td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="lglCategory.id"></a>id</code></em>;</p></td>
210 <td class="struct_member_description"><p>Category ID.</p></td>
211 <td class="struct_member_annotations"> </td>
214 <td class="struct_member_name"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="lglCategory.name"></a>name</code></em>;</p></td>
215 <td class="struct_member_description"><p>Localized category name.</p></td>
216 <td class="struct_member_annotations"> </td>
226 Generated by GTK-Doc V1.20</div>