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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ESourceList</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="prev" href="ESourceGroup.html" title="ESourceGroup">
<link rel="next" href="libedataserver-e-time-utils.html" title="e-time-utils">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="ESourceGroup.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-Data-Server Manual: Utilities (libedataserver)</th>
<td><a accesskey="n" href="libedataserver-e-time-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ESourceList.synopsis" class="shortcut">Top</a>
|
<a href="#ESourceList.description" class="shortcut">Description</a>
|
<a href="#ESourceList.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#ESourceList.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="ESourceList"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ESourceList.top_of_page"></a>ESourceList</span></h2>
<p>ESourceList</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ESourceList.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="ESourceList.html#ESourceList-struct" title="struct ESourceList">ESourceList</a>;
<a class="link" href="ESourceList.html" title="ESourceList"><span class="returnvalue">ESourceList</span></a> * <a class="link" href="ESourceList.html#e-source-list-new" title="e_source_list_new ()">e_source_list_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="ESourceList.html" title="ESourceList"><span class="returnvalue">ESourceList</span></a> * <a class="link" href="ESourceList.html#e-source-list-new-for-gconf" title="e_source_list_new_for_gconf ()">e_source_list_new_for_gconf</a> (<em class="parameter"><code><span class="type">GConfClient</span> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);
<a class="link" href="ESourceList.html" title="ESourceList"><span class="returnvalue">ESourceList</span></a> * <a class="link" href="ESourceList.html#e-source-list-new-for-gconf-default" title="e_source_list_new_for_gconf_default ()">e_source_list_new_for_gconf_default</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="ESourceList.html#e-source-list-peek-groups" title="e_source_list_peek_groups ()">e_source_list_peek_groups</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>);
<a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> * <a class="link" href="ESourceList.html#e-source-list-peek-group-by-uid" title="e_source_list_peek_group_by_uid ()">e_source_list_peek_group_by_uid</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);
<a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> * <a class="link" href="ESourceList.html#e-source-list-peek-group-by-base-uri" title="e_source_list_peek_group_by_base_uri ()">e_source_list_peek_group_by_base_uri</a>
(<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_uri</code></em>);
<a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> * <a class="link" href="ESourceList.html#e-source-list-peek-group-by-properties" title="e_source_list_peek_group_by_properties ()">e_source_list_peek_group_by_properties</a>
(<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
<em class="parameter"><code>...</code></em>);
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> * <a class="link" href="ESourceList.html#e-source-list-peek-source-by-uid" title="e_source_list_peek_source_by_uid ()">e_source_list_peek_source_by_uid</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> * <a class="link" href="ESourceList.html#e-source-list-peek-source-any" title="e_source_list_peek_source_any ()">e_source_list_peek_source_any</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>);
<a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> * <a class="link" href="ESourceList.html#e-source-list-peek-default-source" title="e_source_list_peek_default_source ()">e_source_list_peek_default_source</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ESourceList.html#e-source-list-add-group" title="e_source_list_add_group ()">e_source_list_add_group</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> *group</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> position</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ESourceList.html#e-source-list-remove-group" title="e_source_list_remove_group ()">e_source_list_remove_group</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> *group</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ESourceList.html#e-source-list-remove-group-by-uid" title="e_source_list_remove_group_by_uid ()">e_source_list_remove_group_by_uid</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);
<a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> * <a class="link" href="ESourceList.html#e-source-list-ensure-group" title="e_source_list_ensure_group ()">e_source_list_ensure_group</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_uri</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> ret_it</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ESourceList.html#e-source-list-remove-group-by-base-uri" title="e_source_list_remove_group_by_base_uri ()">e_source_list_remove_group_by_base_uri</a>
(<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_uri</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ESourceList.html#e-source-list-remove-source-by-uid" title="e_source_list_remove_source_by_uid ()">e_source_list_remove_source_by_uid</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ESourceList.html#e-source-list-sync" title="e_source_list_sync ()">e_source_list_sync</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ESourceList.html#e-source-list-is-gconf-updated" title="e_source_list_is_gconf_updated ()">e_source_list_is_gconf_updated</a> (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ESourceList.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----ESourceList
</pre>
</div>
<div class="refsect1">
<a name="ESourceList.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="ESourceList.html#ESourceList-changed" title='The "changed" signal'>changed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="ESourceList.html#ESourceList-group-added" title='The "group-added" signal'>group-added</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="ESourceList.html#ESourceList-group-removed" title='The "group-removed" signal'>group-removed</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="ESourceList.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="ESourceList.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ESourceList-struct"></a><h3>struct ESourceList</h3>
<pre class="programlisting">struct ESourceList;</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-new"></a><h3>e_source_list_new ()</h3>
<pre class="programlisting"><a class="link" href="ESourceList.html" title="ESourceList"><span class="returnvalue">ESourceList</span></a> * e_source_list_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-new-for-gconf"></a><h3>e_source_list_new_for_gconf ()</h3>
<pre class="programlisting"><a class="link" href="ESourceList.html" title="ESourceList"><span class="returnvalue">ESourceList</span></a> * e_source_list_new_for_gconf (<em class="parameter"><code><span class="type">GConfClient</span> *client</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-new-for-gconf-default"></a><h3>e_source_list_new_for_gconf_default ()</h3>
<pre class="programlisting"><a class="link" href="ESourceList.html" title="ESourceList"><span class="returnvalue">ESourceList</span></a> * e_source_list_new_for_gconf_default (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-peek-groups"></a><h3>e_source_list_peek_groups ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * e_source_list_peek_groups (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> ESourceGroup]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-peek-group-by-uid"></a><h3>e_source_list_peek_group_by_uid ()</h3>
<pre class="programlisting"><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> * e_source_list_peek_group_by_uid (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-peek-group-by-base-uri"></a><h3>e_source_list_peek_group_by_base_uri ()</h3>
<pre class="programlisting"><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> * e_source_list_peek_group_by_base_uri
(<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_uri</code></em>);</pre>
<p>
Returns the first <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> having the given base URI.
The base URI is usually just the URI scheme, such as "http://".
If no such group is present in <em class="parameter"><code>list</code></em>, the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td>
<td>a group base URI</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> with a matching base URI, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-peek-group-by-properties"></a><h3>e_source_list_peek_group_by_properties ()</h3>
<pre class="programlisting"><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> * e_source_list_peek_group_by_properties
(<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *property_name</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Peeks group by its properties. Parameters are pairs of strings
property_name, property_value, terminated by NULL! ESourceGroup
is returned only if matches all the properties. Values are compared
case insensitively.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-peek-source-by-uid"></a><h3>e_source_list_peek_source_by_uid ()</h3>
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> * e_source_list_peek_source_by_uid (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-peek-source-any"></a><h3>e_source_list_peek_source_any ()</h3>
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> * e_source_list_peek_source_any (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-peek-default-source"></a><h3>e_source_list_peek_default_source ()</h3>
<pre class="programlisting"><a class="link" href="ESource.html" title="ESource"><span class="returnvalue">ESource</span></a> * e_source_list_peek_default_source (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>);</pre>
<p>
Attempts to find a default <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> in <em class="parameter"><code>list</code></em> by looking for
a source with a property named "default", or else a source with a
property named "system". If no such <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> exists, the function
returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the default <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> in <em class="parameter"><code>list</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-add-group"></a><h3>e_source_list_add_group ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> e_source_list_add_group (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> *group</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> position</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-remove-group"></a><h3>e_source_list_remove_group ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> e_source_list_remove_group (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> *group</code></em>);</pre>
<p>
Removes the first <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> with a unique ID matching <em class="parameter"><code>group</code></em>
(possibly <em class="parameter"><code>group</code></em> itself) from <em class="parameter"><code>list</code></em>. The function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a
matching group was found, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if an <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> was removed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-remove-group-by-uid"></a><h3>e_source_list_remove_group_by_uid ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> e_source_list_remove_group_by_uid (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);</pre>
<p>
Removes the first <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> with the given unique ID from <em class="parameter"><code>list</code></em>.
The function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a matching group was found, otherwise
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
<td>the unique ID of an <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if an <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> was removed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-ensure-group"></a><h3>e_source_list_ensure_group ()</h3>
<pre class="programlisting"><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> * e_source_list_ensure_group (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_uri</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> ret_it</code></em>);</pre>
<p>
Ensures an <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> with the given base URI exists in <em class="parameter"><code>list</code></em>, and
renames its to the given name. If <em class="parameter"><code>ret_it</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the matching group
will be returned and should be unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a localized group name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td>
<td>a group base URI</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ret_it</code></em> :</span></p></td>
<td>whether to return the group</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the matching <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> if <em class="parameter"><code>ret_it</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>,
otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-remove-group-by-base-uri"></a><h3>e_source_list_remove_group_by_base_uri ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> e_source_list_remove_group_by_base_uri
(<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *base_uri</code></em>);</pre>
<p>
Removes the first <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> having the given base URI from <em class="parameter"><code>list</code></em>.
The base URI is usually just the URI scheme, such as "http://". The
function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a matching group was found, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>base_uri</code></em> :</span></p></td>
<td>a group base URI</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if an <a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> was removed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-remove-source-by-uid"></a><h3>e_source_list_remove_source_by_uid ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> e_source_list_remove_source_by_uid (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);</pre>
<p>
Removes the first <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> with the given unique ID from <em class="parameter"><code>list</code></em>. The
function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a matching source was found, otherwise <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
<td>the unique ID of an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> was removed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-sync"></a><h3>e_source_list_sync ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> e_source_list_sync (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Writes the contents of <em class="parameter"><code>list</code></em> to GConf. If an error occurs, such as
the GConf daemon not responding, the function sets <em class="parameter"><code>error</code></em> and returns
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-source-list-is-gconf-updated"></a><h3>e_source_list_is_gconf_updated ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> e_source_list_is_gconf_updated (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>);</pre>
<p>
Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the GConf data for <em class="parameter"><code>list</code></em> is up-to-date, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if
<a class="link" href="ESourceList.html#e-source-list-sync" title="e_source_list_sync ()"><code class="function">e_source_list_sync()</code></a> should be called.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>an <a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the GConf data for <em class="parameter"><code>list</code></em> is up-to-date</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="ESourceList.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ESourceList-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *esourcelist,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
</div>
<hr>
<div class="refsect2">
<a name="ESourceList-group-added"></a><h3>The <code class="literal">"group-added"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *esourcelist,
<a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> *arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
</div>
<hr>
<div class="refsect2">
<a name="ESourceList-group-removed"></a><h3>The <code class="literal">"group-removed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *esourcelist,
<a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> *arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
