← Back to branch summary

~ubuntu-branches/ubuntu/dapper/evolution-data-server/dapper-updates

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/html/libedataserver-e-categories.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2006-02-27 22:17:31 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20060227221731-8qmgp0o0d2ooncle
Tags: 1.5.92-0ubuntu1
* New upstream version
* debian/patches/01_weather_calendar_fix.patch:
  - fixed with the new version
* debian/patches/04_external_libdb_autoconf.patch:
  - updated

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/html/libedataserver-e-categories.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html xmlns:cf="http://docbook.sourceforge.net/xmlns/chunkfast/1.0">
 
1
<html>
3
2
<head>
4
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
4
<title>e-categories</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.69.0">
 
5
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
7
6
<link rel="start" href="index.html" title="Evolution API Reference: libedataserver, utility library">
8
7
<link rel="up" href="ch01.html" title="Evolution API Reference: libedataserver, utility library">
9
8
<link rel="prev" href="libedataserver-EAccount.html" title="EAccount">
13
12
<link rel="chapter" href="ch01.html" title="Evolution API Reference: libedataserver, utility library">
14
13
</head>
15
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
 
<tr valign="middle">
 
15
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
18
16
<td><a accesskey="p" href="libedataserver-EAccount.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
19
17
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
18
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
19
<th width="100%" align="center">Evolution API Reference: libedataserver, utility library</th>
22
20
<td><a accesskey="n" href="libedataserver-EComponentListener.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
 
</tr>
24
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
25
 
                  &#160;|&#160;
26
 
                  <a href="#desc" class="shortcut">Description</a></nobr></td></tr>
27
 
</table>
 
21
</tr></table>
28
22
<div class="refentry" lang="en">
29
23
<a name="libedataserver-e-categories"></a><div class="titlepage"></div>
30
24
<div class="refnamediv"><table width="100%"><tr>
31
25
<td valign="top">
32
 
<h2><span class="refentrytitle"><a name="top_of_page"></a>e-categories</span></h2>
 
26
<h2><span class="refentrytitle">e-categories</span></h2>
33
27
<p>e-categories &#8212; </p>
34
28
</td>
35
29
<td valign="top" align="right"></td>
36
30
</tr></table></div>
37
31
<div class="refsynopsisdiv">
38
 
<a name="synopsis"></a><h2>Synopsis</h2>
 
32
<h2>Synopsis</h2>
39
33
<pre class="synopsis">
40
34
 
41
35
 
42
36
 
43
37
<a
44
 
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
38
href="/opt/gnome/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
45
39
>GList</a>*      <a href="libedataserver-e-categories.html#e-categories-get-list">e_categories_get_list</a>           (void);
46
40
void        <a href="libedataserver-e-categories.html#e-categories-add">e_categories_add</a>                (const char *category,
47
41
                                             const char *color,
48
42
                                             const char *icon_file,
49
43
                                             <a
50
 
href="../glib/glib-Basic-Types.html#gboolean"
 
44
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
51
45
>gboolean</a> searchable);
52
46
void        <a href="libedataserver-e-categories.html#e-categories-remove">e_categories_remove</a>             (const char *category);
53
47
<a
54
 
href="../glib/glib-Basic-Types.html#gboolean"
 
48
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
55
49
>gboolean</a>    <a href="libedataserver-e-categories.html#e-categories-exist">e_categories_exist</a>              (const char *category);
56
50
const char* <a href="libedataserver-e-categories.html#e-categories-get-color-for">e_categories_get_color_for</a>      (const char *category);
57
51
void        <a href="libedataserver-e-categories.html#e-categories-set-color-for">e_categories_set_color_for</a>      (const char *category,
60
54
void        <a href="libedataserver-e-categories.html#e-categories-set-icon-file-for">e_categories_set_icon_file_for</a>  (const char *category,
61
55
                                             const char *icon_file);
62
56
<a
63
 
href="../glib/glib-Basic-Types.html#gboolean"
 
57
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
64
58
>gboolean</a>    <a href="libedataserver-e-categories.html#e-categories-is-searchable">e_categories_is_searchable</a>      (const char *category);
65
59
</pre>
66
60
</div>
67
61
<div class="refsect1" lang="en">
68
 
<a name="desc"></a><h2>Description</h2>
 
62
<a name="id2543734"></a><h2>Description</h2>
69
63
<p>
70
64
 
71
65
</p>
72
66
</div>
73
67
<div class="refsect1" lang="en">
74
 
<a name="details"></a><h2>Details</h2>
 
68
<a name="id2543745"></a><h2>Details</h2>
75
69
<div class="refsect2" lang="en">
76
 
<a name="id2566360"></a><h3>
 
70
<a name="id2543751"></a><h3>
77
71
<a name="e-categories-get-list"></a>e_categories_get_list ()</h3>
78
 
<a class="indexterm" name="id2566371"></a><pre class="programlisting"><a
79
 
href="../glib/glib-Doubly-Linked-Lists.html#GList"
 
72
<a class="indexterm" name="id2543760"></a><pre class="programlisting"><a
 
73
href="/opt/gnome/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
80
74
>GList</a>*      e_categories_get_list           (void);</pre>
81
75
<p>
82
76
Returns a list of all the category names currently configured.</p>
97
91
</div>
98
92
<hr>
99
93
<div class="refsect2" lang="en">
100
 
<a name="id2566414"></a><h3>
 
94
<a name="id2543804"></a><h3>
101
95
<a name="e-categories-add"></a>e_categories_add ()</h3>
102
 
<a class="indexterm" name="id2566426"></a><pre class="programlisting">void        e_categories_add                (const char *category,
 
96
<a class="indexterm" name="id2543814"></a><pre class="programlisting">void        e_categories_add                (const char *category,
103
97
                                             const char *color,
104
98
                                             const char *icon_file,
105
99
                                             <a
106
 
href="../glib/glib-Basic-Types.html#gboolean"
 
100
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
107
101
>gboolean</a> searchable);</pre>
108
102
<p>
109
103
Adds a new category, with its corresponding color and icon, to the
143
137
</div>
144
138
<hr>
145
139
<div class="refsect2" lang="en">
146
 
<a name="id2538766"></a><h3>
 
140
<a name="id2546971"></a><h3>
147
141
<a name="e-categories-remove"></a>e_categories_remove ()</h3>
148
 
<a class="indexterm" name="id2538778"></a><pre class="programlisting">void        e_categories_remove             (const char *category);</pre>
 
142
<a class="indexterm" name="id2546981"></a><pre class="programlisting">void        e_categories_remove             (const char *category);</pre>
149
143
<p>
150
144
Removes the given category from the configuration.</p>
151
145
<p>
163
157
</div>
164
158
<hr>
165
159
<div class="refsect2" lang="en">
166
 
<a name="id2538828"></a><h3>
 
160
<a name="id2547031"></a><h3>
167
161
<a name="e-categories-exist"></a>e_categories_exist ()</h3>
168
 
<a class="indexterm" name="id2538841"></a><pre class="programlisting"><a
169
 
href="../glib/glib-Basic-Types.html#gboolean"
 
162
<a class="indexterm" name="id2547041"></a><pre class="programlisting"><a
 
163
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
170
164
>gboolean</a>    e_categories_exist              (const char *category);</pre>
171
165
<p>
172
166
Checks whether the given category is available in the configuration.</p>
193
187
</div>
194
188
<hr>
195
189
<div class="refsect2" lang="en">
196
 
<a name="id2538913"></a><h3>
 
190
<a name="id2547113"></a><h3>
197
191
<a name="e-categories-get-color-for"></a>e_categories_get_color_for ()</h3>
198
 
<a class="indexterm" name="id2538924"></a><pre class="programlisting">const char* e_categories_get_color_for      (const char *category);</pre>
 
192
<a class="indexterm" name="id2547122"></a><pre class="programlisting">const char* e_categories_get_color_for      (const char *category);</pre>
199
193
<p>
200
194
Gets the color associated with the given category.</p>
201
195
<p>
221
215
</div>
222
216
<hr>
223
217
<div class="refsect2" lang="en">
224
 
<a name="id2549712"></a><h3>
 
218
<a name="id2556038"></a><h3>
225
219
<a name="e-categories-set-color-for"></a>e_categories_set_color_for ()</h3>
226
 
<a class="indexterm" name="id2549723"></a><pre class="programlisting">void        e_categories_set_color_for      (const char *category,
 
220
<a class="indexterm" name="id2556047"></a><pre class="programlisting">void        e_categories_set_color_for      (const char *category,
227
221
                                             const char *color);</pre>
228
222
<p>
229
223
Sets the color associated with the given category.</p>
250
244
</div>
251
245
<hr>
252
246
<div class="refsect2" lang="en">
253
 
<a name="id2549794"></a><h3>
 
247
<a name="id2556118"></a><h3>
254
248
<a name="e-categories-get-icon-file-for"></a>e_categories_get_icon_file_for ()</h3>
255
 
<a class="indexterm" name="id2549806"></a><pre class="programlisting">const char* e_categories_get_icon_file_for  (const char *category);</pre>
 
249
<a class="indexterm" name="id2556127"></a><pre class="programlisting">const char* e_categories_get_icon_file_for  (const char *category);</pre>
256
250
<p>
257
251
Gets the icon file associated with the given category.</p>
258
252
<p>
278
272
</div>
279
273
<hr>
280
274
<div class="refsect2" lang="en">
281
 
<a name="id2549868"></a><h3>
 
275
<a name="id2556188"></a><h3>
282
276
<a name="e-categories-set-icon-file-for"></a>e_categories_set_icon_file_for ()</h3>
283
 
<a class="indexterm" name="id2549880"></a><pre class="programlisting">void        e_categories_set_icon_file_for  (const char *category,
 
277
<a class="indexterm" name="id2556198"></a><pre class="programlisting">void        e_categories_set_icon_file_for  (const char *category,
284
278
                                             const char *icon_file);</pre>
285
279
<p>
286
280
Sets the icon file associated with the given category.</p>
309
303
</div>
310
304
<hr>
311
305
<div class="refsect2" lang="en">
312
 
<a name="id2569298"></a><h3>
 
306
<a name="id2556271"></a><h3>
313
307
<a name="e-categories-is-searchable"></a>e_categories_is_searchable ()</h3>
314
 
<a class="indexterm" name="id2569310"></a><pre class="programlisting"><a
315
 
href="../glib/glib-Basic-Types.html#gboolean"
 
308
<a class="indexterm" name="id2556280"></a><pre class="programlisting"><a
 
309
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
316
310
>gboolean</a>    e_categories_is_searchable      (const char *category);</pre>
317
311
<p>
318
312
Gets whether the given calendar is to be used for searches in the GUI.
344
338
</div>
345
339
</div>
346
340
</div>
 
341
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
342
<td align="left"><a accesskey="p" href="libedataserver-EAccount.html"><b>&lt;&lt;&#160;EAccount</b></a></td>
 
343
<td align="right"><a accesskey="n" href="libedataserver-EComponentListener.html"><b>EComponentListener&#160;&gt;&gt;</b></a></td>
 
344
</tr></table>
347
345
</body>
348
346
</html>