← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/html/ESourceList.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/html/ESourceList.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ESourceList</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
9
9
<link rel="prev" href="ESourceGroup.html" title="ESourceGroup">
30
30
                  <a href="#ESourceList.signals" class="shortcut">Signals</a>
31
31
</td></tr>
32
32
</table>
33
 
<div class="refentry" lang="en">
 
33
<div class="refentry" title="ESourceList">
34
34
<a name="ESourceList"></a><div class="titlepage"></div>
35
35
<div class="refnamediv"><table width="100%"><tr>
36
36
<td valign="top">
39
39
</td>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
42
 
<div class="refsynopsisdiv">
 
42
<div class="refsynopsisdiv" title="Synopsis">
43
43
<a name="ESourceList.synopsis"></a><h2>Synopsis</h2>
44
44
<pre class="synopsis">                    <a class="link" href="ESourceList.html#ESourceList-struct" title="ESourceList">ESourceList</a>;
45
45
<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>);
82
82
<span class="returnvalue">gboolean</span>            <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>);
83
83
</pre>
84
84
</div>
85
 
<div class="refsect1" lang="en">
 
85
<div class="refsect1" title="Object Hierarchy">
86
86
<a name="ESourceList.object-hierarchy"></a><h2>Object Hierarchy</h2>
87
87
<pre class="synopsis">
88
88
  GObject
89
89
   +----ESourceList
90
90
</pre>
91
91
</div>
92
 
<div class="refsect1" lang="en">
 
92
<div class="refsect1" title="Signals">
93
93
<a name="ESourceList.signals"></a><h2>Signals</h2>
94
94
<pre class="synopsis">
95
95
  "<a class="link" href="ESourceList.html#ESourceList-changed" title='The "changed" signal'>changed</a>"                                        : Run Last
97
97
  "<a class="link" href="ESourceList.html#ESourceList-group-removed" title='The "group-removed" signal'>group-removed</a>"                                  : Run Last
98
98
</pre>
99
99
</div>
100
 
<div class="refsect1" lang="en">
 
100
<div class="refsect1" title="Description">
101
101
<a name="ESourceList.description"></a><h2>Description</h2>
102
102
<p>
103
103
</p>
104
104
</div>
105
 
<div class="refsect1" lang="en">
 
105
<div class="refsect1" title="Details">
106
106
<a name="ESourceList.details"></a><h2>Details</h2>
107
 
<div class="refsect2" lang="en">
 
107
<div class="refsect2" title="ESourceList">
108
108
<a name="ESourceList-struct"></a><h3>ESourceList</h3>
109
109
<pre class="programlisting">typedef struct _ESourceList ESourceList;</pre>
110
110
<p>
111
111
</p>
112
112
</div>
113
113
<hr>
114
 
<div class="refsect2" lang="en">
 
114
<div class="refsect2" title="e_source_list_new ()">
115
115
<a name="e-source-list-new"></a><h3>e_source_list_new ()</h3>
116
116
<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>
117
117
<p>
126
126
</table></div>
127
127
</div>
128
128
<hr>
129
 
<div class="refsect2" lang="en">
 
129
<div class="refsect2" title="e_source_list_new_for_gconf ()">
130
130
<a name="e-source-list-new-for-gconf"></a><h3>e_source_list_new_for_gconf ()</h3>
131
131
<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>,
132
132
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
154
154
</table></div>
155
155
</div>
156
156
<hr>
157
 
<div class="refsect2" lang="en">
 
157
<div class="refsect2" title="e_source_list_new_for_gconf_default ()">
158
158
<a name="e-source-list-new-for-gconf-default"></a><h3>e_source_list_new_for_gconf_default ()</h3>
159
159
<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 <span class="type">gchar</span> *path</code></em>);</pre>
160
160
<p>
176
176
</table></div>
177
177
</div>
178
178
<hr>
179
 
<div class="refsect2" lang="en">
 
179
<div class="refsect2" title="e_source_list_peek_groups ()">
180
180
<a name="e-source-list-peek-groups"></a><h3>e_source_list_peek_groups ()</h3>
181
181
<pre class="programlisting"><span class="returnvalue">GSList</span> *            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>
182
182
<p>
198
198
</table></div>
199
199
</div>
200
200
<hr>
201
 
<div class="refsect2" lang="en">
 
201
<div class="refsect2" title="e_source_list_peek_group_by_uid ()">
202
202
<a name="e-source-list-peek-group-by-uid"></a><h3>e_source_list_peek_group_by_uid ()</h3>
203
203
<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>,
204
204
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);</pre>
226
226
</table></div>
227
227
</div>
228
228
<hr>
229
 
<div class="refsect2" lang="en">
 
229
<div class="refsect2" title="e_source_list_peek_group_by_name ()">
230
230
<a name="e-source-list-peek-group-by-name"></a><h3>e_source_list_peek_group_by_name ()</h3>
231
231
<pre class="programlisting"><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> *      e_source_list_peek_group_by_name    (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
232
232
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
233
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
233
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
234
234
<h3 class="title">Warning</h3>
235
235
<p><code class="literal">e_source_list_peek_group_by_name</code> is deprecated and should not be used in newly-written code.</p>
236
236
</div>
258
258
</table></div>
259
259
</div>
260
260
<hr>
261
 
<div class="refsect2" lang="en">
 
261
<div class="refsect2" title="e_source_list_peek_group_by_base_uri ()">
262
262
<a name="e-source-list-peek-group-by-base-uri"></a><h3>e_source_list_peek_group_by_base_uri ()</h3>
263
263
<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
264
264
                                                        (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
278
278
</tr>
279
279
<tr>
280
280
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
281
 
<td>
 
281
<td>the first group which base uri begins with a base_uri.
 
282
 
282
283
</td>
283
284
</tr>
284
285
</tbody>
285
286
</table></div>
 
287
<p class="since">Since 2.28</p>
286
288
</div>
287
289
<hr>
288
 
<div class="refsect2" lang="en">
 
290
<div class="refsect2" title="e_source_list_peek_group_by_properties ()">
289
291
<a name="e-source-list-peek-group-by-properties"></a><h3>e_source_list_peek_group_by_properties ()</h3>
290
292
<pre class="programlisting"><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="returnvalue">ESourceGroup</span></a> *      e_source_list_peek_group_by_properties
291
293
                                                        (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
292
294
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *property_name</code></em>,
293
295
                                                         <em class="parameter"><code>...</code></em>);</pre>
 
296
<p>
 
297
Peeks group by its properties. Parameters are pairs of strings
 
298
property_name, property_value, terminated by NULL! ESourceGroup
 
299
is returned only if matches all the properties. Values are compared
 
300
case insensitively.
 
301
</p>
294
302
<div class="variablelist"><table border="0">
295
303
<col align="left" valign="top">
296
304
<tbody>
316
324
</tr>
317
325
</tbody>
318
326
</table></div>
 
327
<p class="since">Since 2.28</p>
319
328
</div>
320
329
<hr>
321
 
<div class="refsect2" lang="en">
 
330
<div class="refsect2" title="e_source_list_peek_source_by_uid ()">
322
331
<a name="e-source-list-peek-source-by-uid"></a><h3>e_source_list_peek_source_by_uid ()</h3>
323
332
<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>,
324
333
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);</pre>
346
355
</table></div>
347
356
</div>
348
357
<hr>
349
 
<div class="refsect2" lang="en">
 
358
<div class="refsect2" title="e_source_list_peek_source_any ()">
350
359
<a name="e-source-list-peek-source-any"></a><h3>e_source_list_peek_source_any ()</h3>
351
360
<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>
352
361
<p>
368
377
</table></div>
369
378
</div>
370
379
<hr>
371
 
<div class="refsect2" lang="en">
 
380
<div class="refsect2" title="e_source_list_add_group ()">
372
381
<a name="e-source-list-add-group"></a><h3>e_source_list_add_group ()</h3>
373
382
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>,
374
383
                                                         <em class="parameter"><code><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> *group</code></em>,
402
411
</table></div>
403
412
</div>
404
413
<hr>
405
 
<div class="refsect2" lang="en">
 
414
<div class="refsect2" title="e_source_list_remove_group ()">
406
415
<a name="e-source-list-remove-group"></a><h3>e_source_list_remove_group ()</h3>
407
416
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>,
408
417
                                                         <em class="parameter"><code><a class="link" href="ESourceGroup.html" title="ESourceGroup"><span class="type">ESourceGroup</span></a> *group</code></em>);</pre>
430
439
</table></div>
431
440
</div>
432
441
<hr>
433
 
<div class="refsect2" lang="en">
 
442
<div class="refsect2" title="e_source_list_remove_group_by_uid ()">
434
443
<a name="e-source-list-remove-group-by-uid"></a><h3>e_source_list_remove_group_by_uid ()</h3>
435
444
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>,
436
445
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);</pre>
458
467
</table></div>
459
468
</div>
460
469
<hr>
461
 
<div class="refsect2" lang="en">
 
470
<div class="refsect2" title="e_source_list_ensure_group ()">
462
471
<a name="e-source-list-ensure-group"></a><h3>e_source_list_ensure_group ()</h3>
463
472
<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>,
464
473
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
465
474
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *base_uri</code></em>,
466
475
                                                         <em class="parameter"><code><span class="type">gboolean</span> ret_it</code></em>);</pre>
 
476
<p>
 
477
Ensures group with the <em class="parameter"><code>base_uri</code></em> will exists in the <em class="parameter"><code>list</code></em> and its name will be <em class="parameter"><code>name</code></em>.
 
478
If ret_it will be TRUE the group will be also returned, in that case caller should
 
479
g_object_unref the group. Otherwise it returns NULL.
 
480
</p>
467
481
<div class="variablelist"><table border="0">
468
482
<col align="left" valign="top">
469
483
<tbody>
494
508
</tr>
495
509
</tbody>
496
510
</table></div>
 
511
<p class="since">Since 2.28</p>
497
512
</div>
498
513
<hr>
499
 
<div class="refsect2" lang="en">
 
514
<div class="refsect2" title="e_source_list_remove_group_by_base_uri ()">
500
515
<a name="e-source-list-remove-group-by-base-uri"></a><h3>e_source_list_remove_group_by_base_uri ()</h3>
501
516
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_source_list_remove_group_by_base_uri
502
517
                                                        (<em class="parameter"><code><a class="link" href="ESourceList.html" title="ESourceList"><span class="type">ESourceList</span></a> *list</code></em>,
503
518
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *base_uri</code></em>);</pre>
 
519
<p>
 
520
Removes group with given base_uri.
 
521
</p>
504
522
<div class="variablelist"><table border="0">
505
523
<col align="left" valign="top">
506
524
<tbody>
516
534
</tr>
517
535
<tr>
518
536
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
519
 
<td>
 
537
<td>TRUE if group was found.
 
538
 
520
539
</td>
521
540
</tr>
522
541
</tbody>
523
542
</table></div>
 
543
<p class="since">Since 2.28</p>
524
544
</div>
525
545
<hr>
526
 
<div class="refsect2" lang="en">
 
546
<div class="refsect2" title="e_source_list_remove_source_by_uid ()">
527
547
<a name="e-source-list-remove-source-by-uid"></a><h3>e_source_list_remove_source_by_uid ()</h3>
528
548
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>,
529
549
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *uidj</code></em>);</pre>
551
571
</table></div>
552
572
</div>
553
573
<hr>
554
 
<div class="refsect2" lang="en">
 
574
<div class="refsect2" title="e_source_list_sync ()">
555
575
<a name="e-source-list-sync"></a><h3>e_source_list_sync ()</h3>
556
576
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>,
557
577
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
579
599
</table></div>
580
600
</div>
581
601
<hr>
582
 
<div class="refsect2" lang="en">
 
602
<div class="refsect2" title="e_source_list_is_gconf_updated ()">
583
603
<a name="e-source-list-is-gconf-updated"></a><h3>e_source_list_is_gconf_updated ()</h3>
584
604
<pre class="programlisting"><span class="returnvalue">gboolean</span>            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>
585
605
<p>
601
621
</table></div>
602
622
</div>
603
623
</div>
604
 
<div class="refsect1" lang="en">
 
624
<div class="refsect1" title="Signal Details">
605
625
<a name="ESourceList.signal-details"></a><h2>Signal Details</h2>
606
 
<div class="refsect2" lang="en">
 
626
<div class="refsect2" title='The "changed" signal'>
607
627
<a name="ESourceList-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
608
628
<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,
609
629
                                                        <span class="type">gpointer</span>     user_data)        : Run Last</pre>
625
645
</table></div>
626
646
</div>
627
647
<hr>
628
 
<div class="refsect2" lang="en">
 
648
<div class="refsect2" title='The "group-added" signal'>
629
649
<a name="ESourceList-group-added"></a><h3>The <code class="literal">"group-added"</code> signal</h3>
630
650
<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,
631
651
                                                        <span class="type">gpointer</span>     arg1,
653
673
</table></div>
654
674
</div>
655
675
<hr>
656
 
<div class="refsect2" lang="en">
 
676
<div class="refsect2" title='The "group-removed" signal'>
657
677
<a name="ESourceList-group-removed"></a><h3>The <code class="literal">"group-removed"</code> signal</h3>
658
678
<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,
659
679
                                                        <span class="type">gpointer</span>     arg1,