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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedataserver-EAccountList">
<refmeta>
<refentrytitle role="top_of_page">EAccountList</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>EAccountList</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="EAccountListPrivate">EAccountListPrivate</link>;
enum <link linkend="e-account-find-t">e_account_find_t</link>;
<link linkend="EAccountList">EAccountList</link>* <link linkend="e-account-list-new">e_account_list_new</link> (<link linkend="GConfClient">GConfClient</link> *gconf);
<link linkend="void">void</link> <link linkend="e-account-list-construct">e_account_list_construct</link> (<link linkend="EAccountList">EAccountList</link> *account_list,
<link linkend="GConfClient">GConfClient</link> *gconf);
<link linkend="void">void</link> <link linkend="e-account-list-save">e_account_list_save</link> (<link linkend="EAccountList">EAccountList</link> *account_list);
<link linkend="void">void</link> <link linkend="e-account-list-add">e_account_list_add</link> (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="EAccount">EAccount</link> *);
<link linkend="void">void</link> <link linkend="e-account-list-change">e_account_list_change</link> (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="EAccount">EAccount</link> *);
<link linkend="void">void</link> <link linkend="e-account-list-remove">e_account_list_remove</link> (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="EAccount">EAccount</link> *);
const <link linkend="EAccount">EAccount</link>* <link linkend="e-account-list-get-default">e_account_list_get_default</link> (<link linkend="EAccountList">EAccountList</link> *);
<link linkend="void">void</link> <link linkend="e-account-list-set-default">e_account_list_set_default</link> (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="EAccount">EAccount</link> *);
const <link linkend="EAccount">EAccount</link>* <link linkend="e-account-list-find">e_account_list_find</link> (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="e-account-find-t">e_account_find_t</link> type,
const <link linkend="char">char</link> *key);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="EAccountListPrivate" role="typedef"/>EAccountListPrivate</title>
<indexterm><primary>EAccountListPrivate</primary></indexterm><programlisting>typedef struct EAccountListPrivate EAccountListPrivate;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="e-account-find-t" role="enum"/>enum e_account_find_t</title>
<indexterm><primary>e_account_find_t</primary></indexterm><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;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="e-account-list-new" role="function"/>e_account_list_new ()</title>
<indexterm><primary>e_account_list_new</primary></indexterm><programlisting><link linkend="EAccountList">EAccountList</link>* e_account_list_new (<link linkend="GConfClient">GConfClient</link> *gconf);</programlisting>
<para>
Reads the list of accounts from <parameter>gconf</parameter> and listens for changes.
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>
signals according to notifications from GConf.
</para>
<para>
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
<link linkend="e-iterator-delete"><function>e_iterator_delete()</function></link>. After adding, removing, or changing accounts,
you must call <link linkend="e-account-list-save"><function>e_account_list_save()</function></link> to push the changes back to
GConf.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gconf</parameter> :</term>
<listitem><simpara> a <link linkend="GConfClient"><type>GConfClient</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the list of accounts
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-list-construct" role="function"/>e_account_list_construct ()</title>
<indexterm><primary>e_account_list_construct</primary></indexterm><programlisting><link linkend="void">void</link> e_account_list_construct (<link linkend="EAccountList">EAccountList</link> *account_list,
<link linkend="GConfClient">GConfClient</link> *gconf);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>account_list</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>gconf</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-list-save" role="function"/>e_account_list_save ()</title>
<indexterm><primary>e_account_list_save</primary></indexterm><programlisting><link linkend="void">void</link> e_account_list_save (<link linkend="EAccountList">EAccountList</link> *account_list);</programlisting>
<para>
Saves <parameter>account_list</parameter> to GConf. Signals will be emitted for changes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>account_list</parameter> :</term>
<listitem><simpara> an <link linkend="EAccountList"><type>EAccountList</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-list-add" role="function"/>e_account_list_add ()</title>
<indexterm><primary>e_account_list_add</primary></indexterm><programlisting><link linkend="void">void</link> e_account_list_add (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="EAccount">EAccount</link> *);</programlisting>
<para>
Add an account to the account list. Will emit the account-changed
event.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-list-change" role="function"/>e_account_list_change ()</title>
<indexterm><primary>e_account_list_change</primary></indexterm><programlisting><link linkend="void">void</link> e_account_list_change (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="EAccount">EAccount</link> *);</programlisting>
<para>
Signal that the details of an account have changed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-list-remove" role="function"/>e_account_list_remove ()</title>
<indexterm><primary>e_account_list_remove</primary></indexterm><programlisting><link linkend="void">void</link> e_account_list_remove (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="EAccount">EAccount</link> *);</programlisting>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-list-get-default" role="function"/>e_account_list_get_default ()</title>
<indexterm><primary>e_account_list_get_default</primary></indexterm><programlisting>const <link linkend="EAccount">EAccount</link>* e_account_list_get_default (<link linkend="EAccountList">EAccountList</link> *);</programlisting>
<para>
Get the default account. If no default is specified, or the default
has become stale, then the first account is made the default.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The account or NULL if no accounts are defined.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-list-set-default" role="function"/>e_account_list_set_default ()</title>
<indexterm><primary>e_account_list_set_default</primary></indexterm><programlisting><link linkend="void">void</link> e_account_list_set_default (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="EAccount">EAccount</link> *);</programlisting>
<para>
Set the account <parameter>account</parameter> to be the default account.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-account-list-find" role="function"/>e_account_list_find ()</title>
<indexterm><primary>e_account_list_find</primary></indexterm><programlisting>const <link linkend="EAccount">EAccount</link>* e_account_list_find (<link linkend="EAccountList">EAccountList</link> *,
<link linkend="e-account-find-t">e_account_find_t</link> type,
const <link linkend="char">char</link> *key);</programlisting>
<para>
Perform a search of the account list on a single key.
</para>
<para>
<parameter>type</parameter> 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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter> :</term>
<listitem><simpara> Type of search.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> Search key.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The account or NULL if it doesn't exist.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
