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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>EAccountList</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="Evolution API Reference: libedataserver, utility library">
<link rel="up" href="ch01.html" title="Evolution API Reference: libedataserver, utility library">
<link rel="prev" href="ch01.html" title="Evolution API Reference: libedataserver, utility library">
<link rel="next" href="libedataserver-EAccount.html" title="EAccount">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Evolution API Reference: libedataserver, utility library">
</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="ch01.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 API Reference: libedataserver, utility library</th>
<td><a accesskey="n" href="libedataserver-EAccount.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2558557" class="shortcut">Top</a>
 | 
<a href="#id2491394" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libedataserver-EAccountList"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2558557"></a><span class="refentrytitle">EAccountList</span>
</h2>
<p>EAccountList — </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
typedef <a href="libedataserver-EAccountList.html#EAccountListPrivate">EAccountListPrivate</a>;
enum <a href="libedataserver-EAccountList.html#e-account-find-t">e_account_find_t</a>;
EAccountList* <a href="libedataserver-EAccountList.html#e-account-list-new">e_account_list_new</a> (GConfClient *gconf);
void <a href="libedataserver-EAccountList.html#e-account-list-construct">e_account_list_construct</a> (EAccountList *account_list,
GConfClient *gconf);
void <a href="libedataserver-EAccountList.html#e-account-list-save">e_account_list_save</a> (EAccountList *account_list);
void <a href="libedataserver-EAccountList.html#e-account-list-add">e_account_list_add</a> (EAccountList *,
EAccount *);
void <a href="libedataserver-EAccountList.html#e-account-list-change">e_account_list_change</a> (EAccountList *,
EAccount *);
void <a href="libedataserver-EAccountList.html#e-account-list-remove">e_account_list_remove</a> (EAccountList *,
EAccount *);
const EAccount* <a href="libedataserver-EAccountList.html#e-account-list-get-default">e_account_list_get_default</a> (EAccountList *);
void <a href="libedataserver-EAccountList.html#e-account-list-set-default">e_account_list_set_default</a> (EAccountList *,
EAccount *);
const EAccount* <a href="libedataserver-EAccountList.html#e-account-list-find">e_account_list_find</a> (EAccountList *,
<a href="libedataserver-EAccountList.html#e-account-find-t">e_account_find_t</a> type,
const char *key);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2491394"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2491410"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2491421"></a><h3>
<a name="EAccountListPrivate"></a>EAccountListPrivate</h3>
<a class="indexterm" name="id2491433"></a><pre class="programlisting">typedef struct EAccountListPrivate EAccountListPrivate;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2491450"></a><h3>
<a name="e-account-find-t"></a>enum e_account_find_t</h3>
<a class="indexterm" name="id2491462"></a><pre class="programlisting">typedef enum _e_account_find_t {
E_ACCOUNT_FIND_NAME,
E_ACCOUNT_FIND_UID,
E_ACCOUNT_FIND_ID_NAME,
E_ACCOUNT_FIND_ID_ADDRESS,
E_ACCOUNT_FIND_PARENT_UID,
} e_account_find_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2491480"></a><h3>
<a name="e-account-list-new"></a>e_account_list_new ()</h3>
<a class="indexterm" name="id2549653"></a><pre class="programlisting">EAccountList* e_account_list_new (GConfClient *gconf);</pre>
<p>
Reads the list of accounts from <em class="parameter"><code>gconf</code></em> and listens for changes.
Will emit <code class="literal">account_added</code>, <code class="literal">account_changed</code>, and <code class="literal">account_removed</code>
signals according to notifications from GConf.
</p>
<p>
You can modify the list using <a href="libedataserver-EList.html#e-list-append"><code class="function">e_list_append()</code></a>, <a href="libedataserver-EList.html#e-list-remove"><code class="function">e_list_remove()</code></a>, and
<a href="libedataserver-EIterator.html#e-iterator-delete"><code class="function">e_iterator_delete()</code></a>. After adding, removing, or changing accounts,
you must call <a href="libedataserver-EAccountList.html#e-account-list-save"><code class="function">e_account_list_save()</code></a> to push the changes back to
GConf.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gconf</code></em> :</span></td>
<td> a <span class="type">GConfClient</span>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the list of accounts
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2549796"></a><h3>
<a name="e-account-list-construct"></a>e_account_list_construct ()</h3>
<a class="indexterm" name="id2549807"></a><pre class="programlisting">void e_account_list_construct (EAccountList *account_list,
GConfClient *gconf);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>account_list</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>gconf</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2549873"></a><h3>
<a name="e-account-list-save"></a>e_account_list_save ()</h3>
<a class="indexterm" name="id2549886"></a><pre class="programlisting">void e_account_list_save (EAccountList *account_list);</pre>
<p>
Saves <em class="parameter"><code>account_list</code></em> to GConf. Signals will be emitted for changes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>account_list</code></em> :</span></td>
<td> an <span class="type">EAccountList</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2490753"></a><h3>
<a name="e-account-list-add"></a>e_account_list_add ()</h3>
<a class="indexterm" name="id2490766"></a><pre class="programlisting">void e_account_list_add (EAccountList *,
EAccount *);</pre>
<p>
Add an account to the account list. Will emit the account-changed
event.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>Param1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>Param2</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2490836"></a><h3>
<a name="e-account-list-change"></a>e_account_list_change ()</h3>
<a class="indexterm" name="id2490848"></a><pre class="programlisting">void e_account_list_change (EAccountList *,
EAccount *);</pre>
<p>
Signal that the details of an account have changed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>Param1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>Param2</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2490918"></a><h3>
<a name="e-account-list-remove"></a>e_account_list_remove ()</h3>
<a class="indexterm" name="id2490929"></a><pre class="programlisting">void e_account_list_remove (EAccountList *,
EAccount *);</pre>
<p>
Remove an account from the account list, and emit the
account-removed signal. If the account was the default account,
then reset the default to the first account.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>Param1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>Param2</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572525"></a><h3>
<a name="e-account-list-get-default"></a>e_account_list_get_default ()</h3>
<a class="indexterm" name="id2572535"></a><pre class="programlisting">const EAccount* e_account_list_get_default (EAccountList *);</pre>
<p>
Get the default account. If no default is specified, or the default
has become stale, then the first account is made the default.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>Param1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The account or NULL if no accounts are defined.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572592"></a><h3>
<a name="e-account-list-set-default"></a>e_account_list_set_default ()</h3>
<a class="indexterm" name="id2572602"></a><pre class="programlisting">void e_account_list_set_default (EAccountList *,
EAccount *);</pre>
<p>
Set the account <em class="parameter"><code>account</code></em> to be the default account.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>Param1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>Param2</code></em> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2572672"></a><h3>
<a name="e-account-list-find"></a>e_account_list_find ()</h3>
<a class="indexterm" name="id2572684"></a><pre class="programlisting">const EAccount* e_account_list_find (EAccountList *,
<a href="libedataserver-EAccountList.html#e-account-find-t">e_account_find_t</a> type,
const char *key);</pre>
<p>
Perform a search of the account list on a single key.
</p>
<p>
<em class="parameter"><code>type</code></em> must be set from one of the following search types:
E_ACCOUNT_FIND_NAME - Find an account by account name.
E_ACCOUNT_FIND_ID_NAME - Find an account by the owner's identity name.
E_ACCOUNT_FIND_ID_ADDRESS - Find an account by the owner's identity address.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>Param1</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td> Type of search.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>key</code></em> :</span></td>
<td> Search key.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> The account or NULL if it doesn't exist.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|
