1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>e-categories</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="Evolution API Reference: libedataserver, utility library">
<link rel="up" href="ch01.html" title="Evolution API Reference: libedataserver, utility library">
<link rel="prev" href="libedataserver-EAccount.html" title="EAccount">
<link rel="next" href="libedataserver-EComponentListener.html" title="EComponentListener">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Evolution API Reference: libedataserver, utility library">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libedataserver-EAccount.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution API Reference: libedataserver, utility library</th>
<td><a accesskey="n" href="libedataserver-EComponentListener.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2554798" class="shortcut">Top</a>
 | 
<a href="#id2551055" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libedataserver-e-categories"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2554798"></a><span class="refentrytitle">e-categories</span>
</h2>
<p>e-categories — </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* <a href="libedataserver-e-categories.html#e-categories-get-list">e_categories_get_list</a> (void);
void <a href="libedataserver-e-categories.html#e-categories-add">e_categories_add</a> (const char *category,
const char *color,
const char *icon_file,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> searchable);
void <a href="libedataserver-e-categories.html#e-categories-remove">e_categories_remove</a> (const char *category);
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libedataserver-e-categories.html#e-categories-exist">e_categories_exist</a> (const char *category);
const char* <a href="libedataserver-e-categories.html#e-categories-get-color-for">e_categories_get_color_for</a> (const char *category);
void <a href="libedataserver-e-categories.html#e-categories-set-color-for">e_categories_set_color_for</a> (const char *category,
const char *color);
const char* <a href="libedataserver-e-categories.html#e-categories-get-icon-file-for">e_categories_get_icon_file_for</a> (const char *category);
void <a href="libedataserver-e-categories.html#e-categories-set-icon-file-for">e_categories_set_icon_file_for</a> (const char *category,
const char *icon_file);
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="libedataserver-e-categories.html#e-categories-is-searchable">e_categories_is_searchable</a> (const char *category);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2551055"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2551071"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2551082"></a><h3>
<a name="e-categories-get-list"></a>e_categories_get_list ()</h3>
<a class="indexterm" name="id2551093"></a><pre class="programlisting"><a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* e_categories_get_list (void);</pre>
<p>
Returns a list of all the category names currently configured.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a GList containing the names of the categories. The list
should be freed using g_list_free, but the names of the categories should
not be touched at all, they are internal strings.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2551136"></a><h3>
<a name="e-categories-add"></a>e_categories_add ()</h3>
<a class="indexterm" name="id2551149"></a><pre class="programlisting">void e_categories_add (const char *category,
const char *color,
const char *icon_file,
<a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> searchable);</pre>
<p>
Adds a new category, with its corresponding color and icon, to the
configuration database.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>category</code></em> :</span></td>
<td> name of category to add.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>color</code></em> :</span></td>
<td> associated color.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>icon_file</code></em> :</span></td>
<td> full path of the icon associated to the category.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>searchable</code></em> :</span></td>
<td> whether the category can be used for searching in the GUI.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2564972"></a><h3>
<a name="e-categories-remove"></a>e_categories_remove ()</h3>
<a class="indexterm" name="id2564984"></a><pre class="programlisting">void e_categories_remove (const char *category);</pre>
<p>
Removes the given category from the configuration.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>category</code></em> :</span></td>
<td> category to be removed.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565034"></a><h3>
<a name="e-categories-exist"></a>e_categories_exist ()</h3>
<a class="indexterm" name="id2565046"></a><pre class="programlisting"><a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> e_categories_exist (const char *category);</pre>
<p>
Checks whether the given category is available in the configuration.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>category</code></em> :</span></td>
<td> category to be searched.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the category is available, <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2565125"></a><h3>
<a name="e-categories-get-color-for"></a>e_categories_get_color_for ()</h3>
<a class="indexterm" name="id2565136"></a><pre class="programlisting">const char* e_categories_get_color_for (const char *category);</pre>
<p>
Gets the color associated with the given category.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>category</code></em> :</span></td>
<td> category to retrieve the color for.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a string representation of the color.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537816"></a><h3>
<a name="e-categories-set-color-for"></a>e_categories_set_color_for ()</h3>
<a class="indexterm" name="id2537828"></a><pre class="programlisting">void e_categories_set_color_for (const char *category,
const char *color);</pre>
<p>
Sets the color associated with the given category.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>category</code></em> :</span></td>
<td> category to set the color for.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>color</code></em> :</span></td>
<td> X color.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537899"></a><h3>
<a name="e-categories-get-icon-file-for"></a>e_categories_get_icon_file_for ()</h3>
<a class="indexterm" name="id2537910"></a><pre class="programlisting">const char* e_categories_get_icon_file_for (const char *category);</pre>
<p>
Gets the icon file associated with the given category.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>category</code></em> :</span></td>
<td> category to retrieve the icon file for.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a string representation of the color.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2537971"></a><h3>
<a name="e-categories-set-icon-file-for"></a>e_categories_set_icon_file_for ()</h3>
<a class="indexterm" name="id2537983"></a><pre class="programlisting">void e_categories_set_icon_file_for (const char *category,
const char *icon_file);</pre>
<p>
Sets the icon file associated with the given category.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>category</code></em> :</span></td>
<td> category to set the icon file for.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>icon_file</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574426"></a><h3>
<a name="e-categories-is-searchable"></a>e_categories_is_searchable ()</h3>
<a class="indexterm" name="id2574437"></a><pre class="programlisting"><a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> e_categories_is_searchable (const char *category);</pre>
<p>
Gets whether the given calendar is to be used for searches in the GUI.
</p>
<p>
Return value; <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>% if the category is searchable, <a
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>% if not.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>category</code></em> :</span></td>
<td> category name.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
