← Back to branch summary

~ubuntu-branches/ubuntu/hardy/evolution-data-server/hardy-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: 2007-11-13 10:59:20 UTC
  • mfrom: (1.1.38 upstream)
  • Revision ID: james.westby@ubuntu.com-20071113105920-nb6w14udvgx0ghi3
Tags: 2.21.2-0ubuntu1
https://launchpad.net/bugs/23912
* New upstream version:
  Bug Fixes:
  - #318842: Task lists should be sorted (LP: #23912)
  - #345135: Disable SSLv2 compatible HELLO on SSL stream when 
    SSLv2 is disabled
  - #359267: Not all memos are showed in calendar view
  - #430420: Returned size <= 0 is an error
  - #460649: Meeting UI Needs To Show Color Of Selected Calendar Source
  - #487229: Use GKeyFile instead of gnome-config to access stored passwords
  - #488156: Minimize use of the WITH_GNOME_KEYRING macro
  - #492130: ESourceSelector uses pointers to ESource
  - #494304: Fix leak
  Updated Translations
  New in 2.21.1:
  - Support for Google Calendar
  Bug Fixes:
  - #203480: (Novell Bugzilla) Compiler warning fix 
    for usage ofunintialized variable
  - #231178: New symbol 'set-label' defined and added corresponding callback
  - #271777: Keep character's case as user types
  - #417999: Don't use deprecated GTK+ symbols
  - #420167: e-d-s now exits with gnome-session
  - #469657: Better use of GHashTable
  - #474000: Use GLib's Base64 API instead of Camel's
  - #475487: When creating the default contact, print errors to the console
  - #475493: Use G_DEFINE_TYPE
  - #475494: Use G_LOCK instead of a static mutex for clearer code
  - #478404: Reset the id to zero
  - #483301: Remove an unused variable
  - #487270: Fix typo in documentation
  - #488173: Remove __FUNCTION__, which is a gcc-ism
  - #488351: Fix an addressbook error on a fresh install
  Other Contributors:
  - Protect against a NULL subject string. 
* debian/*.preinst:
  - On upgrades from Gutsy, remove the symlinks introduced in Gutsy. They
    break upgrades all over, and current cdbs just symlinks individual files.
* Sync with Debian
* debian/control:
  - evolution-data-server Breaks evolution (<< 2.9), 
    evolution-exchange (<= 2.8.1-0ubuntu1),
    evolution-jescs (<= 2.8.2-0ubuntu3), 
    evolution-scalix (<= 10.0.0.357-0ubuntu6)
  - updated maintainer to desktop team
* debian/rules:
  - don't specify the paths for nspr and nss since the package is built 
    with firefox
  - don't build documentation, it's distributed in the upstream tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/html/libedataserver-e-categories.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>e-categories</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.1">
7
7
<link rel="start" href="index.html" title="Evolution API Reference: libedataserver, utility library">
8
8
<link rel="up" href="ch01.html" title="Evolution API Reference: libedataserver, utility library">
9
9
<link rel="prev" href="EAccountList.html" title="EAccountList">
10
10
<link rel="next" href="EComponentListener.html" title="EComponentListener">
11
 
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="Evolution API Reference: libedataserver, utility library">
14
14
<link rel="index" href="ix01.html" title="Index">
22
22
<th width="100%" align="center">Evolution API Reference: libedataserver, utility library</th>
23
23
<td><a accesskey="n" href="EComponentListener.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
24
24
</tr>
25
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2560803" class="shortcut">Top</a>
 
25
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2606803" class="shortcut">Top</a>
26
26
                  &#160;|&#160;
27
 
                  <a href="#id2575656" class="shortcut">Description</a></nobr></td></tr>
 
27
                  <a href="#id2577699" class="shortcut">Description</a></nobr></td></tr>
28
28
</table>
29
29
<div class="refentry" lang="en">
30
30
<a name="libedataserver-e-categories"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
33
33
<h2>
34
 
<a name="id2560803"></a><span class="refentrytitle">e-categories</span>
 
34
<a name="id2606803"></a><span class="refentrytitle">e-categories</span>
35
35
</h2>
36
36
<p>e-categories</p>
37
37
</td>
43
43
 
44
44
 
45
45
 
46
 
<a
47
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
48
 
>GList</a>*              <a href="libedataserver-e-categories.html#e-categories-get-list">e_categories_get_list</a>               (void);
49
 
void                <a href="libedataserver-e-categories.html#e-categories-add">e_categories_add</a>                    (const char *category,
 
46
GList*              <a class="link" href="libedataserver-e-categories.html#e-categories-get-list">e_categories_get_list</a>               (void);
 
47
void                <a class="link" href="libedataserver-e-categories.html#e-categories-add">e_categories_add</a>                    (const char *category,
50
48
                                                         const char *color,
51
49
                                                         const char *icon_file,
52
 
                                                         <a
53
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
54
 
>gboolean</a> searchable);
55
 
void                <a href="libedataserver-e-categories.html#e-categories-remove">e_categories_remove</a>                 (const char *category);
56
 
<a
57
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
58
 
>gboolean</a>            <a href="libedataserver-e-categories.html#e-categories-exist">e_categories_exist</a>                  (const char *category);
59
 
const char*         <a href="libedataserver-e-categories.html#e-categories-get-color-for">e_categories_get_color_for</a>          (const char *category);
60
 
void                <a href="libedataserver-e-categories.html#e-categories-set-color-for">e_categories_set_color_for</a>          (const char *category,
 
50
                                                         gboolean searchable);
 
51
void                <a class="link" href="libedataserver-e-categories.html#e-categories-remove">e_categories_remove</a>                 (const char *category);
 
52
gboolean            <a class="link" href="libedataserver-e-categories.html#e-categories-exist">e_categories_exist</a>                  (const char *category);
 
53
const char*         <a class="link" href="libedataserver-e-categories.html#e-categories-get-color-for">e_categories_get_color_for</a>          (const char *category);
 
54
void                <a class="link" href="libedataserver-e-categories.html#e-categories-set-color-for">e_categories_set_color_for</a>          (const char *category,
61
55
                                                         const char *color);
62
 
const char*         <a href="libedataserver-e-categories.html#e-categories-get-icon-file-for">e_categories_get_icon_file_for</a>      (const char *category);
63
 
void                <a href="libedataserver-e-categories.html#e-categories-set-icon-file-for">e_categories_set_icon_file_for</a>      (const char *category,
 
56
const char*         <a class="link" href="libedataserver-e-categories.html#e-categories-get-icon-file-for">e_categories_get_icon_file_for</a>      (const char *category);
 
57
void                <a class="link" href="libedataserver-e-categories.html#e-categories-set-icon-file-for">e_categories_set_icon_file_for</a>      (const char *category,
64
58
                                                         const char *icon_file);
65
 
<a
66
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
67
 
>gboolean</a>            <a href="libedataserver-e-categories.html#e-categories-is-searchable">e_categories_is_searchable</a>          (const char *category);
 
59
gboolean            <a class="link" href="libedataserver-e-categories.html#e-categories-is-searchable">e_categories_is_searchable</a>          (const char *category);
68
60
</pre>
69
61
</div>
70
62
<div class="refsect1" lang="en">
71
 
<a name="id2575656"></a><h2>Description</h2>
 
63
<a name="id2577699"></a><h2>Description</h2>
72
64
<p>
73
65
 
74
66
</p>
75
67
</div>
76
68
<div class="refsect1" lang="en">
77
 
<a name="id2575672"></a><h2>Details</h2>
 
69
<a name="id2577714"></a><h2>Details</h2>
78
70
<div class="refsect2" lang="en">
79
 
<a name="id2575683"></a><h3>
 
71
<a name="id2577725"></a><h3>
80
72
<a name="e-categories-get-list"></a>e_categories_get_list ()</h3>
81
 
<a class="indexterm" name="id2575694"></a><pre class="programlisting"><a
82
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
83
 
>GList</a>*              e_categories_get_list               (void);</pre>
 
73
<a class="indexterm" name="id2577736"></a><pre class="programlisting">GList*              e_categories_get_list               (void);</pre>
84
74
<p>
85
75
Returns a sorted list of all the category names currently configured.</p>
86
76
<p>
89
79
<div class="variablelist"><table border="0">
90
80
<col align="left" valign="top">
91
81
<tbody><tr>
92
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
82
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
93
83
<td> a sorted GList containing the names of the categories. The
94
84
list should be freed using g_list_free, but the names of the categories
95
85
should not be touched at all, they are internal strings.
99
89
</div>
100
90
<hr>
101
91
<div class="refsect2" lang="en">
102
 
<a name="id2575738"></a><h3>
 
92
<a name="id2577780"></a><h3>
103
93
<a name="e-categories-add"></a>e_categories_add ()</h3>
104
 
<a class="indexterm" name="id2575750"></a><pre class="programlisting">void                e_categories_add                    (const char *category,
 
94
<a class="indexterm" name="id2577793"></a><pre class="programlisting">void                e_categories_add                    (const char *category,
105
95
                                                         const char *color,
106
96
                                                         const char *icon_file,
107
 
                                                         <a
108
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
109
 
>gboolean</a> searchable);</pre>
 
97
                                                         gboolean searchable);</pre>
110
98
<p>
111
99
Adds a new category, with its corresponding color and icon, to the
112
100
configuration database.</p>
117
105
<col align="left" valign="top">
118
106
<tbody>
119
107
<tr>
120
 
<td><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></td>
 
108
<td><p><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></p></td>
121
109
<td> name of category to add.
122
110
</td>
123
111
</tr>
124
112
<tr>
125
 
<td><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
 
113
<td><p><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></p></td>
126
114
<td> associated color.
127
115
</td>
128
116
</tr>
129
117
<tr>
130
 
<td><span class="term"><em class="parameter"><code>icon_file</code></em>&#160;:</span></td>
 
118
<td><p><span class="term"><em class="parameter"><code>icon_file</code></em>&#160;:</span></p></td>
131
119
<td> full path of the icon associated to the category.
132
120
</td>
133
121
</tr>
134
122
<tr>
135
 
<td><span class="term"><em class="parameter"><code>searchable</code></em>&#160;:</span></td>
 
123
<td><p><span class="term"><em class="parameter"><code>searchable</code></em>&#160;:</span></p></td>
136
124
<td> whether the category can be used for searching in the GUI.
137
125
</td>
138
126
</tr>
141
129
</div>
142
130
<hr>
143
131
<div class="refsect2" lang="en">
144
 
<a name="id2579163"></a><h3>
 
132
<a name="id2582040"></a><h3>
145
133
<a name="e-categories-remove"></a>e_categories_remove ()</h3>
146
 
<a class="indexterm" name="id2579175"></a><pre class="programlisting">void                e_categories_remove                 (const char *category);</pre>
 
134
<a class="indexterm" name="id2582052"></a><pre class="programlisting">void                e_categories_remove                 (const char *category);</pre>
147
135
<p>
148
136
Removes the given category from the configuration.</p>
149
137
<p>
152
140
<div class="variablelist"><table border="0">
153
141
<col align="left" valign="top">
154
142
<tbody><tr>
155
 
<td><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></td>
 
143
<td><p><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></p></td>
156
144
<td> category to be removed.
157
145
</td>
158
146
</tr></tbody>
160
148
</div>
161
149
<hr>
162
150
<div class="refsect2" lang="en">
163
 
<a name="id2579225"></a><h3>
 
151
<a name="id2582102"></a><h3>
164
152
<a name="e-categories-exist"></a>e_categories_exist ()</h3>
165
 
<a class="indexterm" name="id2579238"></a><pre class="programlisting"><a
166
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
167
 
>gboolean</a>            e_categories_exist                  (const char *category);</pre>
 
153
<a class="indexterm" name="id2582115"></a><pre class="programlisting">gboolean            e_categories_exist                  (const char *category);</pre>
168
154
<p>
169
155
Checks whether the given category is available in the configuration.</p>
170
156
<p>
174
160
<col align="left" valign="top">
175
161
<tbody>
176
162
<tr>
177
 
<td><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></td>
 
163
<td><p><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></p></td>
178
164
<td> category to be searched.
179
165
</td>
180
166
</tr>
181
167
<tr>
182
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
183
 
<td> <a
184
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
185
 
><code class="literal">TRUE</code></a> if the category is available, <a
186
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
187
 
><code class="literal">FALSE</code></a> otherwise.
 
168
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
169
<td> <code class="literal">TRUE</code> if the category is available, <code class="literal">FALSE</code> otherwise.
188
170
</td>
189
171
</tr>
190
172
</tbody>
192
174
</div>
193
175
<hr>
194
176
<div class="refsect2" lang="en">
195
 
<a name="id2579317"></a><h3>
 
177
<a name="id2582194"></a><h3>
196
178
<a name="e-categories-get-color-for"></a>e_categories_get_color_for ()</h3>
197
 
<a class="indexterm" name="id2579328"></a><pre class="programlisting">const char*         e_categories_get_color_for          (const char *category);</pre>
 
179
<a class="indexterm" name="id2582205"></a><pre class="programlisting">const char*         e_categories_get_color_for          (const char *category);</pre>
198
180
<p>
199
181
Gets the color associated with the given category.</p>
200
182
<p>
204
186
<col align="left" valign="top">
205
187
<tbody>
206
188
<tr>
207
 
<td><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></td>
 
189
<td><p><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></p></td>
208
190
<td> category to retrieve the color for.
209
191
</td>
210
192
</tr>
211
193
<tr>
212
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
194
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
213
195
<td> a string representation of the color.
214
196
</td>
215
197
</tr>
218
200
</div>
219
201
<hr>
220
202
<div class="refsect2" lang="en">
221
 
<a name="id2568550"></a><h3>
 
203
<a name="id2583737"></a><h3>
222
204
<a name="e-categories-set-color-for"></a>e_categories_set_color_for ()</h3>
223
 
<a class="indexterm" name="id2568561"></a><pre class="programlisting">void                e_categories_set_color_for          (const char *category,
 
205
<a class="indexterm" name="id2583749"></a><pre class="programlisting">void                e_categories_set_color_for          (const char *category,
224
206
                                                         const char *color);</pre>
225
207
<p>
226
208
Sets the color associated with the given category.</p>
231
213
<col align="left" valign="top">
232
214
<tbody>
233
215
<tr>
234
 
<td><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></td>
 
216
<td><p><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></p></td>
235
217
<td> category to set the color for.
236
218
</td>
237
219
</tr>
238
220
<tr>
239
 
<td><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
 
221
<td><p><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></p></td>
240
222
<td> X color.
241
223
</td>
242
224
</tr>
245
227
</div>
246
228
<hr>
247
229
<div class="refsect2" lang="en">
248
 
<a name="id2568632"></a><h3>
 
230
<a name="id2583820"></a><h3>
249
231
<a name="e-categories-get-icon-file-for"></a>e_categories_get_icon_file_for ()</h3>
250
 
<a class="indexterm" name="id2568643"></a><pre class="programlisting">const char*         e_categories_get_icon_file_for      (const char *category);</pre>
 
232
<a class="indexterm" name="id2583831"></a><pre class="programlisting">const char*         e_categories_get_icon_file_for      (const char *category);</pre>
251
233
<p>
252
234
Gets the icon file associated with the given category.</p>
253
235
<p>
257
239
<col align="left" valign="top">
258
240
<tbody>
259
241
<tr>
260
 
<td><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></td>
 
242
<td><p><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></p></td>
261
243
<td> category to retrieve the icon file for.
262
244
</td>
263
245
</tr>
264
246
<tr>
265
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
247
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
266
248
<td> a string representation of the color.
267
249
</td>
268
250
</tr>
271
253
</div>
272
254
<hr>
273
255
<div class="refsect2" lang="en">
274
 
<a name="id2568706"></a><h3>
 
256
<a name="id2583893"></a><h3>
275
257
<a name="e-categories-set-icon-file-for"></a>e_categories_set_icon_file_for ()</h3>
276
 
<a class="indexterm" name="id2568718"></a><pre class="programlisting">void                e_categories_set_icon_file_for      (const char *category,
 
258
<a class="indexterm" name="id2583906"></a><pre class="programlisting">void                e_categories_set_icon_file_for      (const char *category,
277
259
                                                         const char *icon_file);</pre>
278
260
<p>
279
261
Sets the icon file associated with the given category.</p>
284
266
<col align="left" valign="top">
285
267
<tbody>
286
268
<tr>
287
 
<td><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></td>
 
269
<td><p><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></p></td>
288
270
<td> category to set the icon file for.
289
271
</td>
290
272
</tr>
291
273
<tr>
292
 
<td><span class="term"><em class="parameter"><code>icon_file</code></em>&#160;:</span></td>
 
274
<td><p><span class="term"><em class="parameter"><code>icon_file</code></em>&#160;:</span></p></td>
293
275
<td>
294
276
 
295
277
 
300
282
</div>
301
283
<hr>
302
284
<div class="refsect2" lang="en">
303
 
<a name="id2592913"></a><h3>
 
285
<a name="id2619251"></a><h3>
304
286
<a name="e-categories-is-searchable"></a>e_categories_is_searchable ()</h3>
305
 
<a class="indexterm" name="id2592924"></a><pre class="programlisting"><a
306
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
307
 
>gboolean</a>            e_categories_is_searchable          (const char *category);</pre>
 
287
<a class="indexterm" name="id2619262"></a><pre class="programlisting">gboolean            e_categories_is_searchable          (const char *category);</pre>
308
288
<p>
309
289
Gets whether the given calendar is to be used for searches in the GUI.
310
290
</p>
311
291
<p>
312
 
Return value; <a
313
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
314
 
><code class="literal">TRUE</code></a>% if the category is searchable, <a
315
 
href="/opt/gnome/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
316
 
><code class="literal">FALSE</code></a>% if not.</p>
 
292
Return value; <code class="literal">TRUE</code>% if the category is searchable, <code class="literal">FALSE</code>% if not.</p>
317
293
<p>
318
294
 
319
295
</p>
321
297
<col align="left" valign="top">
322
298
<tbody>
323
299
<tr>
324
 
<td><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></td>
 
300
<td><p><span class="term"><em class="parameter"><code>category</code></em>&#160;:</span></p></td>
325
301
<td> category name.
326
302
</td>
327
303
</tr>
328
304
<tr>
329
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
305
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
330
306
<td>
331
307
 
332
308
 
337
313
</div>
338
314
</div>
339
315
<div class="refsect1" lang="en">
340
 
<a name="id2593000"></a><div class="refsect2" lang="en"><a name="id2593001"></a></div>
 
316
<a name="id2619337"></a><div class="refsect2" lang="en"><a name="id2619338"></a></div>
341
317
<hr>
342
 
<div class="refsect2" lang="en"><a name="id2593002"></a></div>
 
318
<div class="refsect2" lang="en"><a name="id2619340"></a></div>
343
319
</div>
344
320
</div>
345
321
</body>