← 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/EAccountList.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/EAccountList.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>EAccountList</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="EAccount.html" title="EAccount">
30
30
                  <a href="#EAccountList.signals" class="shortcut">Signals</a>
31
31
</td></tr>
32
32
</table>
33
 
<div class="refentry" lang="en">
 
33
<div class="refentry" title="EAccountList">
34
34
<a name="EAccountList"></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="EAccountList.synopsis"></a><h2>Synopsis</h2>
44
44
<pre class="synopsis">                    <a class="link" href="EAccountList.html#EAccountList-struct" title="EAccountList">EAccountList</a>;
45
45
enum                <a class="link" href="EAccountList.html#e-account-find-t" title="enum e_account_find_t">e_account_find_t</a>;
67
67
                                                         <em class="parameter"><code><a class="link" href="EAccount.html" title="EAccount"><span class="type">EAccount</span></a> *Param2</code></em>);
68
68
</pre>
69
69
</div>
70
 
<div class="refsect1" lang="en">
 
70
<div class="refsect1" title="Object Hierarchy">
71
71
<a name="EAccountList.object-hierarchy"></a><h2>Object Hierarchy</h2>
72
72
<pre class="synopsis">
73
73
  GObject
75
75
         +----EAccountList
76
76
</pre>
77
77
</div>
78
 
<div class="refsect1" lang="en">
 
78
<div class="refsect1" title="Signals">
79
79
<a name="EAccountList.signals"></a><h2>Signals</h2>
80
80
<pre class="synopsis">
81
81
  "<a class="link" href="EAccountList.html#EAccountList-account-added" title='The "account-added" signal'>account-added</a>"                                  : Run Last
83
83
  "<a class="link" href="EAccountList.html#EAccountList-account-removed" title='The "account-removed" signal'>account-removed</a>"                                : Run Last
84
84
</pre>
85
85
</div>
86
 
<div class="refsect1" lang="en">
 
86
<div class="refsect1" title="Description">
87
87
<a name="EAccountList.description"></a><h2>Description</h2>
88
88
<p>
89
89
</p>
90
90
</div>
91
 
<div class="refsect1" lang="en">
 
91
<div class="refsect1" title="Details">
92
92
<a name="EAccountList.details"></a><h2>Details</h2>
93
 
<div class="refsect2" lang="en">
 
93
<div class="refsect2" title="EAccountList">
94
94
<a name="EAccountList-struct"></a><h3>EAccountList</h3>
95
95
<pre class="programlisting">typedef struct _EAccountList EAccountList;</pre>
96
96
<p>
97
97
</p>
98
98
</div>
99
99
<hr>
100
 
<div class="refsect2" lang="en">
 
100
<div class="refsect2" title="enum e_account_find_t">
101
101
<a name="e-account-find-t"></a><h3>enum e_account_find_t</h3>
102
102
<pre class="programlisting">typedef enum _e_account_find_t {
103
103
        E_ACCOUNT_FIND_NAME,
111
111
</p>
112
112
</div>
113
113
<hr>
114
 
<div class="refsect2" lang="en">
 
114
<div class="refsect2" title="e_account_list_new ()">
115
115
<a name="e-account-list-new"></a><h3>e_account_list_new ()</h3>
116
116
<pre class="programlisting"><a class="link" href="EAccountList.html" title="EAccountList"><span class="returnvalue">EAccountList</span></a> *      e_account_list_new                  (<em class="parameter"><code><span class="type">GConfClient</span> *gconf</code></em>);</pre>
117
117
<p>
123
123
You can modify the list using <a class="link" href="EList.html#e-list-append" title="e_list_append ()"><code class="function">e_list_append()</code></a>, <a class="link" href="EList.html#e-list-remove" title="e_list_remove ()"><code class="function">e_list_remove()</code></a>, and
124
124
<a class="link" href="EIterator.html#e-iterator-delete" title="e_iterator_delete ()"><code class="function">e_iterator_delete()</code></a>. After adding, removing, or changing accounts,
125
125
you must call <a class="link" href="EAccountList.html#e-account-list-save" title="e_account_list_save ()"><code class="function">e_account_list_save()</code></a> to push the changes back to
126
 
GConf.</p>
 
126
GConf.
 
127
</p>
127
128
<div class="variablelist"><table border="0">
128
129
<col align="left" valign="top">
129
130
<tbody>
141
142
</table></div>
142
143
</div>
143
144
<hr>
144
 
<div class="refsect2" lang="en">
 
145
<div class="refsect2" title="e_account_list_construct ()">
145
146
<a name="e-account-list-construct"></a><h3>e_account_list_construct ()</h3>
146
147
<pre class="programlisting"><span class="returnvalue">void</span>                e_account_list_construct            (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *account_list</code></em>,
147
148
                                                         <em class="parameter"><code><span class="type">GConfClient</span> *gconf</code></em>);</pre>
164
165
</table></div>
165
166
</div>
166
167
<hr>
167
 
<div class="refsect2" lang="en">
 
168
<div class="refsect2" title="e_account_list_save ()">
168
169
<a name="e-account-list-save"></a><h3>e_account_list_save ()</h3>
169
170
<pre class="programlisting"><span class="returnvalue">void</span>                e_account_list_save                 (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *account_list</code></em>);</pre>
170
171
<p>
171
 
Saves <em class="parameter"><code>account_list</code></em> to GConf. Signals will be emitted for changes.</p>
 
172
Saves <em class="parameter"><code>account_list</code></em> to GConf. Signals will be emitted for changes.
 
173
</p>
172
174
<div class="variablelist"><table border="0">
173
175
<col align="left" valign="top">
174
176
<tbody><tr>
179
181
</table></div>
180
182
</div>
181
183
<hr>
182
 
<div class="refsect2" lang="en">
 
184
<div class="refsect2" title="e_account_list_add ()">
183
185
<a name="e-account-list-add"></a><h3>e_account_list_add ()</h3>
184
186
<pre class="programlisting"><span class="returnvalue">void</span>                e_account_list_add                  (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *Param1</code></em>,
185
187
                                                         <em class="parameter"><code><a class="link" href="EAccount.html" title="EAccount"><span class="type">EAccount</span></a> *Param2</code></em>);</pre>
186
188
<p>
187
189
Add an account to the account list.  Will emit the account-changed
188
 
event.</p>
 
190
event.
 
191
</p>
189
192
<div class="variablelist"><table border="0">
190
193
<col align="left" valign="top">
191
194
<tbody>
203
206
</table></div>
204
207
</div>
205
208
<hr>
206
 
<div class="refsect2" lang="en">
 
209
<div class="refsect2" title="e_account_list_change ()">
207
210
<a name="e-account-list-change"></a><h3>e_account_list_change ()</h3>
208
211
<pre class="programlisting"><span class="returnvalue">void</span>                e_account_list_change               (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *Param1</code></em>,
209
212
                                                         <em class="parameter"><code><a class="link" href="EAccount.html" title="EAccount"><span class="type">EAccount</span></a> *Param2</code></em>);</pre>
210
213
<p>
211
 
Signal that the details of an account have changed.</p>
 
214
Signal that the details of an account have changed.
 
215
</p>
212
216
<div class="variablelist"><table border="0">
213
217
<col align="left" valign="top">
214
218
<tbody>
226
230
</table></div>
227
231
</div>
228
232
<hr>
229
 
<div class="refsect2" lang="en">
 
233
<div class="refsect2" title="e_account_list_remove ()">
230
234
<a name="e-account-list-remove"></a><h3>e_account_list_remove ()</h3>
231
235
<pre class="programlisting"><span class="returnvalue">void</span>                e_account_list_remove               (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *Param1</code></em>,
232
236
                                                         <em class="parameter"><code><a class="link" href="EAccount.html" title="EAccount"><span class="type">EAccount</span></a> *Param2</code></em>);</pre>
233
237
<p>
234
238
Remove an account from the account list, and emit the
235
239
account-removed signal.  If the account was the default account,
236
 
then reset the default to the first account.</p>
 
240
then reset the default to the first account.
 
241
</p>
237
242
<div class="variablelist"><table border="0">
238
243
<col align="left" valign="top">
239
244
<tbody>
251
256
</table></div>
252
257
</div>
253
258
<hr>
254
 
<div class="refsect2" lang="en">
 
259
<div class="refsect2" title="e_account_list_get_default ()">
255
260
<a name="e-account-list-get-default"></a><h3>e_account_list_get_default ()</h3>
256
261
<pre class="programlisting">const <a class="link" href="EAccount.html" title="EAccount"><span class="returnvalue">EAccount</span></a> *    e_account_list_get_default          (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *Param1</code></em>);</pre>
257
262
<p>
258
263
Get the default account.  If no default is specified, or the default
259
 
has become stale, then the first account is made the default.</p>
 
264
has become stale, then the first account is made the default.
 
265
</p>
260
266
<div class="variablelist"><table border="0">
261
267
<col align="left" valign="top">
262
268
<tbody>
274
280
</table></div>
275
281
</div>
276
282
<hr>
277
 
<div class="refsect2" lang="en">
 
283
<div class="refsect2" title="e_account_list_set_default ()">
278
284
<a name="e-account-list-set-default"></a><h3>e_account_list_set_default ()</h3>
279
285
<pre class="programlisting"><span class="returnvalue">void</span>                e_account_list_set_default          (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *Param1</code></em>,
280
286
                                                         <em class="parameter"><code><a class="link" href="EAccount.html" title="EAccount"><span class="type">EAccount</span></a> *Param2</code></em>);</pre>
281
287
<p>
282
 
Set the account <em class="parameter"><code>account</code></em> to be the default account.</p>
 
288
Set the account <em class="parameter"><code>account</code></em> to be the default account.
 
289
</p>
283
290
<div class="variablelist"><table border="0">
284
291
<col align="left" valign="top">
285
292
<tbody>
297
304
</table></div>
298
305
</div>
299
306
<hr>
300
 
<div class="refsect2" lang="en">
 
307
<div class="refsect2" title="e_account_list_find ()">
301
308
<a name="e-account-list-find"></a><h3>e_account_list_find ()</h3>
302
309
<pre class="programlisting">const <a class="link" href="EAccount.html" title="EAccount"><span class="returnvalue">EAccount</span></a> *    e_account_list_find                 (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *Param1</code></em>,
303
310
                                                         <em class="parameter"><code><a class="link" href="EAccountList.html#e-account-find-t" title="enum e_account_find_t"><span class="type">e_account_find_t</span></a> type</code></em>,
309
316
<em class="parameter"><code>type</code></em> must be set from one of the following search types:
310
317
E_ACCOUNT_FIND_NAME - Find an account by account name.
311
318
E_ACCOUNT_FIND_ID_NAME - Find an account by the owner's identity name.
312
 
E_ACCOUNT_FIND_ID_ADDRESS - Find an account by the owner's identity address.</p>
 
319
E_ACCOUNT_FIND_ID_ADDRESS - Find an account by the owner's identity address.
 
320
</p>
313
321
<div class="variablelist"><table border="0">
314
322
<col align="left" valign="top">
315
323
<tbody>
337
345
</table></div>
338
346
</div>
339
347
<hr>
340
 
<div class="refsect2" lang="en">
 
348
<div class="refsect2" title="e_account_list_prune_proxies ()">
341
349
<a name="e-account-list-prune-proxies"></a><h3>e_account_list_prune_proxies ()</h3>
342
350
<pre class="programlisting"><span class="returnvalue">void</span>                e_account_list_prune_proxies        (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *Param1</code></em>);</pre>
343
351
<p>
352
360
</table></div>
353
361
</div>
354
362
<hr>
355
 
<div class="refsect2" lang="en">
 
363
<div class="refsect2" title="e_account_list_remove_account_proxies ()">
356
364
<a name="e-account-list-remove-account-proxies"></a><h3>e_account_list_remove_account_proxies ()</h3>
357
365
<pre class="programlisting"><span class="returnvalue">void</span>                e_account_list_remove_account_proxies
358
366
                                                        (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *Param1</code></em>,
376
384
</table></div>
377
385
</div>
378
386
<hr>
379
 
<div class="refsect2" lang="en">
 
387
<div class="refsect2" title="e_account_list_account_has_proxies ()">
380
388
<a name="e-account-list-account-has-proxies"></a><h3>e_account_list_account_has_proxies ()</h3>
381
389
<pre class="programlisting"><span class="returnvalue">gint</span>                e_account_list_account_has_proxies  (<em class="parameter"><code><a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *Param1</code></em>,
382
390
                                                         <em class="parameter"><code><a class="link" href="EAccount.html" title="EAccount"><span class="type">EAccount</span></a> *Param2</code></em>);</pre>
404
412
</table></div>
405
413
</div>
406
414
</div>
407
 
<div class="refsect1" lang="en">
 
415
<div class="refsect1" title="Signal Details">
408
416
<a name="EAccountList.signal-details"></a><h2>Signal Details</h2>
409
 
<div class="refsect2" lang="en">
 
417
<div class="refsect2" title='The "account-added" signal'>
410
418
<a name="EAccountList-account-added"></a><h3>The <code class="literal">"account-added"</code> signal</h3>
411
419
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *eaccountlist,
412
420
                                                        <a class="link" href="EAccount.html" title="EAccount"><span class="type">EAccount</span></a>     *arg1,
434
442
</table></div>
435
443
</div>
436
444
<hr>
437
 
<div class="refsect2" lang="en">
 
445
<div class="refsect2" title='The "account-changed" signal'>
438
446
<a name="EAccountList-account-changed"></a><h3>The <code class="literal">"account-changed"</code> signal</h3>
439
447
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *eaccountlist,
440
448
                                                        <a class="link" href="EAccount.html" title="EAccount"><span class="type">EAccount</span></a>     *arg1,
462
470
</table></div>
463
471
</div>
464
472
<hr>
465
 
<div class="refsect2" lang="en">
 
473
<div class="refsect2" title='The "account-removed" signal'>
466
474
<a name="EAccountList-account-removed"></a><h3>The <code class="literal">"account-removed"</code> signal</h3>
467
475
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EAccountList.html" title="EAccountList"><span class="type">EAccountList</span></a> *eaccountlist,
468
476
                                                        <a class="link" href="EAccount.html" title="EAccount"><span class="type">EAccount</span></a>     *arg1,