2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
<refentry id="EAccountList">
6
<refentrytitle role="top_of_page" id="EAccountList.top_of_page">EAccountList</refentrytitle>
7
<manvolnum>3</manvolnum>
13
<refname>EAccountList</refname>
14
<refpurpose></refpurpose>
17
<refsynopsisdiv id="EAccountList.synopsis" role="synopsis">
18
<title role="synopsis.title">Synopsis</title>
20
<synopsis> <link linkend="EAccountList-struct">EAccountList</link>;
21
enum <link linkend="e-account-find-t">e_account_find_t</link>;
22
<link linkend="EAccountList"><returnvalue>EAccountList</returnvalue></link> * <link linkend="e-account-list-new">e_account_list_new</link> (<parameter><link linkend="GConfClient"><type>GConfClient</type></link> *gconf</parameter>);
23
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-account-list-construct">e_account_list_construct</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *account_list</parameter>,
24
<parameter><link linkend="GConfClient"><type>GConfClient</type></link> *gconf</parameter>);
25
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-account-list-save">e_account_list_save</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *account_list</parameter>);
26
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-account-list-add">e_account_list_add</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
27
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);
28
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-account-list-change">e_account_list_change</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
29
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);
30
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-account-list-remove">e_account_list_remove</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
31
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);
32
const <link linkend="EAccount"><returnvalue>EAccount</returnvalue></link> * <link linkend="e-account-list-get-default">e_account_list_get_default</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>);
33
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-account-list-set-default">e_account_list_set_default</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
34
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);
35
const <link linkend="EAccount"><returnvalue>EAccount</returnvalue></link> * <link linkend="e-account-list-find">e_account_list_find</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
36
<parameter><link linkend="e-account-find-t"><type>e_account_find_t</type></link> type</parameter>,
37
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);
38
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-account-list-prune-proxies">e_account_list_prune_proxies</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>);
39
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-account-list-remove-account-proxies">e_account_list_remove_account_proxies</link>
40
(<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
41
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);
42
<link linkend="gint"><returnvalue>gint</returnvalue></link> <link linkend="e-account-list-account-has-proxies">e_account_list_account_has_proxies</link> (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
43
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);
46
<refsect1 id="EAccountList.object-hierarchy" role="object_hierarchy">
47
<title role="object_hierarchy.title">Object Hierarchy</title>
49
<link linkend="GObject">GObject</link>
50
+----<link linkend="EList">EList</link>
54
<refsect1 id="EAccountList.signals" role="signal_proto">
55
<title role="signal_proto.title">Signals</title>
57
"<link linkend="EAccountList-account-added">account-added</link>" : Run Last
58
"<link linkend="EAccountList-account-changed">account-changed</link>" : Run Last
59
"<link linkend="EAccountList-account-removed">account-removed</link>" : Run Last
63
<refsect1 id="EAccountList.description" role="desc">
64
<title role="desc.title">Description</title>
68
<refsect1 id="EAccountList.details" role="details">
69
<title role="details.title">Details</title>
70
<refsect2 id="EAccountList-struct" role="struct">
71
<title>EAccountList</title>
72
<indexterm zone="EAccountList-struct"><primary>EAccountList</primary></indexterm>
73
<programlisting>typedef struct _EAccountList EAccountList;</programlisting>
76
<refsect2 id="e-account-find-t" role="enum">
77
<title>enum e_account_find_t</title>
78
<indexterm zone="e-account-find-t"><primary>e_account_find_t</primary></indexterm>
79
<programlisting>typedef enum _e_account_find_t {
82
E_ACCOUNT_FIND_ID_NAME,
83
E_ACCOUNT_FIND_ID_ADDRESS,
84
E_ACCOUNT_FIND_PARENT_UID
89
<refsect2 id="e-account-list-new" role="function">
90
<title>e_account_list_new ()</title>
91
<indexterm zone="e-account-list-new"><primary>e_account_list_new</primary></indexterm>
92
<programlisting><link linkend="EAccountList"><returnvalue>EAccountList</returnvalue></link> * e_account_list_new (<parameter><link linkend="GConfClient"><type>GConfClient</type></link> *gconf</parameter>);</programlisting>
94
Reads the list of accounts from <parameter>gconf</parameter> and listens for changes.
95
Will emit <link linkend="account-added"><literal>account_added</literal></link>, <link linkend="account-changed"><literal>account_changed</literal></link>, and <link linkend="account-removed"><literal>account_removed</literal></link>
96
signals according to notifications from GConf.
99
You can modify the list using <link linkend="e-list-append"><function>e_list_append()</function></link>, <link linkend="e-list-remove"><function>e_list_remove()</function></link>, and
100
<link linkend="e-iterator-delete"><function>e_iterator_delete()</function></link>. After adding, removing, or changing accounts,
101
you must call <link linkend="e-account-list-save"><function>e_account_list_save()</function></link> to push the changes back to
103
<variablelist role="params">
104
<varlistentry><term><parameter>gconf</parameter> :</term>
105
<listitem><simpara>a <link linkend="GConfClient"><type>GConfClient</type></link>
106
</simpara></listitem></varlistentry>
107
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the list of accounts
108
</simpara></listitem></varlistentry>
109
</variablelist></refsect2>
110
<refsect2 id="e-account-list-construct" role="function">
111
<title>e_account_list_construct ()</title>
112
<indexterm zone="e-account-list-construct"><primary>e_account_list_construct</primary></indexterm>
113
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_account_list_construct (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *account_list</parameter>,
114
<parameter><link linkend="GConfClient"><type>GConfClient</type></link> *gconf</parameter>);</programlisting>
116
</para><variablelist role="params">
117
<varlistentry><term><parameter>account_list</parameter> :</term>
119
</simpara></listitem></varlistentry>
120
<varlistentry><term><parameter>gconf</parameter> :</term>
122
</simpara></listitem></varlistentry>
123
</variablelist></refsect2>
124
<refsect2 id="e-account-list-save" role="function">
125
<title>e_account_list_save ()</title>
126
<indexterm zone="e-account-list-save"><primary>e_account_list_save</primary></indexterm>
127
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_account_list_save (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *account_list</parameter>);</programlisting>
129
Saves <parameter>account_list</parameter> to GConf. Signals will be emitted for changes.</para>
130
<variablelist role="params">
131
<varlistentry><term><parameter>account_list</parameter> :</term>
132
<listitem><simpara>an <link linkend="EAccountList"><type>EAccountList</type></link>
133
</simpara></listitem></varlistentry>
134
</variablelist></refsect2>
135
<refsect2 id="e-account-list-add" role="function">
136
<title>e_account_list_add ()</title>
137
<indexterm zone="e-account-list-add"><primary>e_account_list_add</primary></indexterm>
138
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_account_list_add (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
139
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);</programlisting>
141
Add an account to the account list. Will emit the account-changed
143
<variablelist role="params">
144
<varlistentry><term><parameter>Param1</parameter> :</term>
146
</simpara></listitem></varlistentry>
147
<varlistentry><term><parameter>Param2</parameter> :</term>
149
</simpara></listitem></varlistentry>
150
</variablelist></refsect2>
151
<refsect2 id="e-account-list-change" role="function">
152
<title>e_account_list_change ()</title>
153
<indexterm zone="e-account-list-change"><primary>e_account_list_change</primary></indexterm>
154
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_account_list_change (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
155
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);</programlisting>
157
Signal that the details of an account have changed.</para>
158
<variablelist role="params">
159
<varlistentry><term><parameter>Param1</parameter> :</term>
161
</simpara></listitem></varlistentry>
162
<varlistentry><term><parameter>Param2</parameter> :</term>
164
</simpara></listitem></varlistentry>
165
</variablelist></refsect2>
166
<refsect2 id="e-account-list-remove" role="function">
167
<title>e_account_list_remove ()</title>
168
<indexterm zone="e-account-list-remove"><primary>e_account_list_remove</primary></indexterm>
169
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_account_list_remove (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
170
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);</programlisting>
172
Remove an account from the account list, and emit the
173
account-removed signal. If the account was the default account,
174
then reset the default to the first account.</para>
175
<variablelist role="params">
176
<varlistentry><term><parameter>Param1</parameter> :</term>
178
</simpara></listitem></varlistentry>
179
<varlistentry><term><parameter>Param2</parameter> :</term>
181
</simpara></listitem></varlistentry>
182
</variablelist></refsect2>
183
<refsect2 id="e-account-list-get-default" role="function">
184
<title>e_account_list_get_default ()</title>
185
<indexterm zone="e-account-list-get-default"><primary>e_account_list_get_default</primary></indexterm>
186
<programlisting>const <link linkend="EAccount"><returnvalue>EAccount</returnvalue></link> * e_account_list_get_default (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>);</programlisting>
188
Get the default account. If no default is specified, or the default
189
has become stale, then the first account is made the default.</para>
190
<variablelist role="params">
191
<varlistentry><term><parameter>Param1</parameter> :</term>
193
</simpara></listitem></varlistentry>
194
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The account or NULL if no accounts are defined.
195
</simpara></listitem></varlistentry>
196
</variablelist></refsect2>
197
<refsect2 id="e-account-list-set-default" role="function">
198
<title>e_account_list_set_default ()</title>
199
<indexterm zone="e-account-list-set-default"><primary>e_account_list_set_default</primary></indexterm>
200
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_account_list_set_default (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
201
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);</programlisting>
203
Set the account <parameter>account</parameter> to be the default account.</para>
204
<variablelist role="params">
205
<varlistentry><term><parameter>Param1</parameter> :</term>
207
</simpara></listitem></varlistentry>
208
<varlistentry><term><parameter>Param2</parameter> :</term>
210
</simpara></listitem></varlistentry>
211
</variablelist></refsect2>
212
<refsect2 id="e-account-list-find" role="function">
213
<title>e_account_list_find ()</title>
214
<indexterm zone="e-account-list-find"><primary>e_account_list_find</primary></indexterm>
215
<programlisting>const <link linkend="EAccount"><returnvalue>EAccount</returnvalue></link> * e_account_list_find (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
216
<parameter><link linkend="e-account-find-t"><type>e_account_find_t</type></link> type</parameter>,
217
<parameter>const <link linkend="gchar"><type>gchar</type></link> *key</parameter>);</programlisting>
219
Perform a search of the account list on a single key.
222
<parameter>type</parameter> must be set from one of the following search types:
223
E_ACCOUNT_FIND_NAME - Find an account by account name.
224
E_ACCOUNT_FIND_ID_NAME - Find an account by the owner's identity name.
225
E_ACCOUNT_FIND_ID_ADDRESS - Find an account by the owner's identity address.</para>
226
<variablelist role="params">
227
<varlistentry><term><parameter>Param1</parameter> :</term>
229
</simpara></listitem></varlistentry>
230
<varlistentry><term><parameter>type</parameter> :</term>
231
<listitem><simpara>Type of search.
232
</simpara></listitem></varlistentry>
233
<varlistentry><term><parameter>key</parameter> :</term>
234
<listitem><simpara>Search key.
235
</simpara></listitem></varlistentry>
236
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The account or NULL if it doesn't exist.
237
</simpara></listitem></varlistentry>
238
</variablelist></refsect2>
239
<refsect2 id="e-account-list-prune-proxies" role="function">
240
<title>e_account_list_prune_proxies ()</title>
241
<indexterm zone="e-account-list-prune-proxies"><primary>e_account_list_prune_proxies</primary></indexterm>
242
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_account_list_prune_proxies (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>);</programlisting>
244
</para><variablelist role="params">
245
<varlistentry><term><parameter>Param1</parameter> :</term>
247
</simpara></listitem></varlistentry>
248
</variablelist></refsect2>
249
<refsect2 id="e-account-list-remove-account-proxies" role="function">
250
<title>e_account_list_remove_account_proxies ()</title>
251
<indexterm zone="e-account-list-remove-account-proxies"><primary>e_account_list_remove_account_proxies</primary></indexterm>
252
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_account_list_remove_account_proxies
253
(<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
254
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);</programlisting>
256
</para><variablelist role="params">
257
<varlistentry><term><parameter>Param1</parameter> :</term>
259
</simpara></listitem></varlistentry>
260
<varlistentry><term><parameter>Param2</parameter> :</term>
262
</simpara></listitem></varlistentry>
263
</variablelist></refsect2>
264
<refsect2 id="e-account-list-account-has-proxies" role="function">
265
<title>e_account_list_account_has_proxies ()</title>
266
<indexterm zone="e-account-list-account-has-proxies"><primary>e_account_list_account_has_proxies</primary></indexterm>
267
<programlisting><link linkend="gint"><returnvalue>gint</returnvalue></link> e_account_list_account_has_proxies (<parameter><link linkend="EAccountList"><type>EAccountList</type></link> *Param1</parameter>,
268
<parameter><link linkend="EAccount"><type>EAccount</type></link> *Param2</parameter>);</programlisting>
270
</para><variablelist role="params">
271
<varlistentry><term><parameter>Param1</parameter> :</term>
273
</simpara></listitem></varlistentry>
274
<varlistentry><term><parameter>Param2</parameter> :</term>
276
</simpara></listitem></varlistentry>
277
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
278
</simpara></listitem></varlistentry>
279
</variablelist></refsect2>
282
<refsect1 id="EAccountList.signal-details" role="signals">
283
<title role="signals.title">Signal Details</title>
284
<refsect2 id="EAccountList-account-added" role="signal"><title>The <literal>"account-added"</literal> signal</title>
285
<indexterm zone="EAccountList-account-added"><primary>EAccountList::account-added</primary></indexterm>
286
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="EAccountList"><type>EAccountList</type></link> *eaccountlist,
287
<link linkend="EAccount"><type>EAccount</type></link> *arg1,
288
<link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting>
290
</para><variablelist role="params">
291
<varlistentry><term><parameter>eaccountlist</parameter> :</term>
292
<listitem><simpara>the object which received the signal.
293
</simpara></listitem></varlistentry>
294
<varlistentry><term><parameter>arg1</parameter> :</term>
296
</simpara></listitem></varlistentry>
297
<varlistentry><term><parameter>user_data</parameter> :</term>
298
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
299
</variablelist></refsect2><refsect2 id="EAccountList-account-changed" role="signal"><title>The <literal>"account-changed"</literal> signal</title>
300
<indexterm zone="EAccountList-account-changed"><primary>EAccountList::account-changed</primary></indexterm>
301
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="EAccountList"><type>EAccountList</type></link> *eaccountlist,
302
<link linkend="EAccount"><type>EAccount</type></link> *arg1,
303
<link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting>
305
</para><variablelist role="params">
306
<varlistentry><term><parameter>eaccountlist</parameter> :</term>
307
<listitem><simpara>the object which received the signal.
308
</simpara></listitem></varlistentry>
309
<varlistentry><term><parameter>arg1</parameter> :</term>
311
</simpara></listitem></varlistentry>
312
<varlistentry><term><parameter>user_data</parameter> :</term>
313
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
314
</variablelist></refsect2><refsect2 id="EAccountList-account-removed" role="signal"><title>The <literal>"account-removed"</literal> signal</title>
315
<indexterm zone="EAccountList-account-removed"><primary>EAccountList::account-removed</primary></indexterm>
316
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="EAccountList"><type>EAccountList</type></link> *eaccountlist,
317
<link linkend="EAccount"><type>EAccount</type></link> *arg1,
318
<link linkend="gpointer"><type>gpointer</type></link> user_data) : Run Last</programlisting>
320
</para><variablelist role="params">
321
<varlistentry><term><parameter>eaccountlist</parameter> :</term>
322
<listitem><simpara>the object which received the signal.
323
</simpara></listitem></varlistentry>
324
<varlistentry><term><parameter>arg1</parameter> :</term>
326
</simpara></listitem></varlistentry>
327
<varlistentry><term><parameter>user_data</parameter> :</term>
328
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
329
</variablelist></refsect2>