Mercurial > pidgin
annotate src/account.h @ 5687:ae626f0b68ef
[gaim-migrate @ 6108]
The rest of the proxy options are added, and modifying the Proxy type box
shows or hides the detailed options, depending on the item chosen.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Tue, 03 Jun 2003 05:09:54 +0000 |
parents | 46d7ad0dfa26 |
children | 2d0d96c5a7a7 |
rev | line source |
---|---|
5563 | 1 /** |
2 * @file account.h Account API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Copyright (C) 2003 Christian Hammond <chipx86@gnupdate.org> | |
8 * | |
9 * This program is free software; you can redistribute it and/or modify | |
10 * it under the terms of the GNU General Public License as published by | |
11 * the Free Software Foundation; either version 2 of the License, or | |
12 * (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, | |
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 * GNU General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU General Public License | |
20 * along with this program; if not, write to the Free Software | |
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
22 */ | |
23 #ifndef _GAIM_ACCOUNTS_H_ | |
24 #define _GAIM_ACCOUNTS_H_ | |
25 | |
26 typedef struct _GaimAccount GaimAccount; | |
27 | |
28 #include "connection.h" | |
5681
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
29 #include "proxy.h" |
5563 | 30 #include "prpl.h" |
31 | |
32 struct _GaimAccount | |
33 { | |
34 char *username; /**< The username. */ | |
35 char *alias; /**< The current alias. */ | |
36 char *password; /**< The account password. */ | |
37 char *user_info; /**< User information. */ | |
38 | |
39 char *buddy_icon; /**< The buddy icon. */ | |
40 | |
41 gboolean remember_pass; /**< Remember the password. */ | |
5565
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
42 gboolean check_mail; /**< Check for mail. */ |
5563 | 43 |
44 GaimProtocol protocol; /**< The account protocol. */ | |
5643
eb685809108b
[gaim-migrate @ 6057]
Christian Hammond <chipx86@chipx86.com>
parents:
5580
diff
changeset
|
45 char *protocol_id; /**< The ID of the protocol. */ |
5563 | 46 |
47 GaimConnection *gc; /**< The connection handle. */ | |
48 | |
49 GHashTable *settings; /**< Protocol-specific settings. */ | |
50 | |
5681
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
51 GaimProxyInfo *proxy_info; /**< Proxy information. */ |
5563 | 52 |
53 GSList *permit; /**< Permit list. */ | |
54 GSList *deny; /**< Deny list. */ | |
55 int perm_deny; /**< The permit/deny setting. */ | |
56 }; | |
57 | |
58 /** | |
59 * Creates a new account. | |
60 * | |
61 * @param username The username. | |
62 * @param protocol The protocol. | |
63 */ | |
64 GaimAccount *gaim_account_new(const char *username, GaimProtocol protocol); | |
65 | |
66 /** | |
67 * Destroys an account. | |
68 * | |
69 * @param account The account to destroy. | |
70 */ | |
71 void gaim_account_destroy(GaimAccount *account); | |
72 | |
73 /** | |
74 * Connects to an account. | |
75 * | |
76 * @param account The account to connect to. | |
77 * | |
78 * @return The gaim connection. | |
79 */ | |
80 GaimConnection *gaim_account_connect(GaimAccount *account); | |
81 | |
82 /** | |
83 * Disconnects from an account. | |
84 * | |
85 * @param account The account to disconnect from. | |
86 * | |
87 * @return The gaim connection. | |
88 */ | |
89 void gaim_account_disconnect(GaimAccount *account); | |
90 | |
91 /** | |
92 * Sets the account's username. | |
93 * | |
94 * @param account The account. | |
95 * @param username The username. | |
96 */ | |
97 void gaim_account_set_username(GaimAccount *account, const char *username); | |
98 | |
99 /** | |
100 * Sets the account's password. | |
101 * | |
102 * @param account The account. | |
103 * @param password The password. | |
104 */ | |
105 void gaim_account_set_password(GaimAccount *account, const char *password); | |
106 | |
107 /** | |
108 * Sets the account's alias. | |
109 * | |
110 * @param account The account. | |
111 * @param alias The alias. | |
112 */ | |
113 void gaim_account_set_alias(GaimAccount *account, const char *alias); | |
114 | |
115 /** | |
116 * Sets the account's user information | |
117 * | |
118 * @param account The account. | |
119 * @param info The user information. | |
120 */ | |
121 void gaim_account_set_user_info(GaimAccount *account, const char *user_info); | |
122 | |
123 /** | |
124 * Sets the account's buddy icon. | |
125 * | |
126 * @param account The account. | |
127 * @param icon The buddy icon file. | |
128 */ | |
129 void gaim_account_set_buddy_icon(GaimAccount *account, const char *icon); | |
130 | |
131 /** | |
132 * Sets the account's protocol. | |
133 * | |
134 * @param account The account. | |
135 * @param protocol The protocol. | |
136 */ | |
137 void gaim_account_set_protocol(GaimAccount *account, GaimProtocol protocol); | |
138 | |
139 /** | |
140 * Sets the account's connection. | |
141 * | |
142 * @param account The account. | |
143 * @param gc The connection. | |
144 */ | |
145 void gaim_account_set_connection(GaimAccount *account, GaimConnection *gc); | |
146 | |
147 /** | |
148 * Sets whether or not this account should save its password. | |
149 * | |
150 * @param account The account. | |
151 * @param value @c TRUE if it should remember the password. | |
152 */ | |
153 void gaim_account_set_remember_password(GaimAccount *account, gboolean value); | |
154 | |
155 /** | |
5565
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
156 * Sets whether or not this account should check for mail. |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
157 * |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
158 * @param account The account. |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
159 * @param value @c TRUE if it should check for mail. |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
160 */ |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
161 void gaim_account_set_check_mail(GaimAccount *account, gboolean value); |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
162 |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
163 /** |
5681
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
164 * Sets the account's proxy information. |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
165 * |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
166 * @param account The account. |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
167 * @param info The proxy information. |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
168 */ |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
169 void gaim_account_set_proxy_info(GaimAccount *account, GaimProxyInfo *info); |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
170 |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
171 /** |
5563 | 172 * Sets a protocol-specific integer setting for an account. |
173 * | |
174 * @param account The account. | |
175 * @param name The name of the setting. | |
176 * @param value The setting's value. | |
177 */ | |
178 void gaim_account_set_int(GaimAccount *account, const char *name, int value); | |
179 | |
180 /** | |
181 * Sets a protocol-specific string setting for an account. | |
182 * | |
183 * @param account The account. | |
184 * @param name The name of the setting. | |
185 * @param value The setting's value. | |
186 */ | |
187 void gaim_account_set_string(GaimAccount *account, const char *name, | |
188 const char *string); | |
189 | |
190 /** | |
191 * Sets a protocol-specific boolean setting for an account. | |
192 * | |
193 * @param account The account. | |
194 * @param name The name of the setting. | |
195 * @param value The setting's value. | |
196 */ | |
197 void gaim_account_set_bool(GaimAccount *account, const char *name, | |
198 gboolean value); | |
199 | |
200 | |
201 /** | |
202 * Returns whether or not the account is connected. | |
203 * | |
204 * @param account The account. | |
205 * | |
206 * @return @c TRUE if connected, or @c FALSE otherwise. | |
207 */ | |
208 gboolean gaim_account_is_connected(const GaimAccount *account); | |
209 | |
210 /** | |
211 * Returns the account's username. | |
212 * | |
213 * @param account The account. | |
214 * | |
215 * @return The username. | |
216 */ | |
217 const char *gaim_account_get_username(const GaimAccount *account); | |
218 | |
219 /** | |
220 * Returns the account's password. | |
221 * | |
222 * @param account The account. | |
223 * | |
224 * @return The password. | |
225 */ | |
226 const char *gaim_account_get_password(const GaimAccount *account); | |
227 | |
228 /** | |
229 * Returns the account's alias. | |
230 * | |
231 * @param account The account. | |
232 * | |
233 * @return The alias. | |
234 */ | |
235 const char *gaim_account_get_alias(const GaimAccount *account); | |
236 | |
237 /** | |
238 * Returns the account's user information. | |
239 * | |
240 * @param account The account. | |
241 * | |
242 * @return The user information. | |
243 */ | |
244 const char *gaim_account_get_user_info(const GaimAccount *account); | |
245 | |
246 /** | |
247 * Returns the account's buddy icon filename. | |
248 * | |
249 * @param account The account. | |
250 * | |
251 * @return The buddy icon filename. | |
252 */ | |
253 const char *gaim_account_get_buddy_icon(const GaimAccount *account); | |
254 | |
255 /** | |
256 * Returns the account's protocol. | |
257 * | |
258 * @param account The account. | |
259 * | |
260 * @return The protocol. | |
261 */ | |
262 GaimProtocol gaim_account_get_protocol(const GaimAccount *account); | |
263 | |
264 /** | |
265 * Returns the account's connection. | |
266 * | |
267 * @param account The account. | |
268 * | |
269 * @return The connection. | |
270 */ | |
271 GaimConnection *gaim_account_get_connection(const GaimAccount *account); | |
272 | |
273 /** | |
274 * Returns whether or not this account should save its password. | |
275 * | |
276 * @param account The account. | |
277 * | |
278 * @return @c TRUE if it should remember the password. | |
279 */ | |
280 gboolean gaim_account_get_remember_password(const GaimAccount *account); | |
281 | |
282 /** | |
5565
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
283 * Returns whether or not this account should check for mail. |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
284 * |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
285 * @param account The account. |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
286 * |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
287 * @return @c TRUE if it should check for mail. |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
288 */ |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
289 gboolean gaim_account_get_check_mail(const GaimAccount *account); |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
290 |
c3c4aaf69f65
[gaim-migrate @ 5967]
Christian Hammond <chipx86@chipx86.com>
parents:
5564
diff
changeset
|
291 /** |
5681
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
292 * Returns the account's proxy information. |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
293 * |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
294 * @param account The account. |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
295 * |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
296 * @return The proxy information. |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
297 */ |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
298 GaimProxyInfo *gaim_account_get_proxy_info(const GaimAccount *account); |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
299 |
46d7ad0dfa26
[gaim-migrate @ 6100]
Christian Hammond <chipx86@chipx86.com>
parents:
5643
diff
changeset
|
300 /** |
5563 | 301 * Returns a protocol-specific integer setting for an account. |
302 * | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
303 * @param account The account. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
304 * @param name The name of the setting. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
305 * @param default_value The default value. |
5563 | 306 * |
307 * @return The value. | |
308 */ | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
309 int gaim_account_get_int(const GaimAccount *account, const char *name, |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
310 int default_value); |
5563 | 311 |
312 /** | |
313 * Returns a protocol-specific string setting for an account. | |
314 * | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
315 * @param account The account. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
316 * @param name The name of the setting. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
317 * @param default_value The default value. |
5563 | 318 * |
319 * @return The value. | |
320 */ | |
321 const char *gaim_account_get_string(const GaimAccount *account, | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
322 const char *name, |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
323 const char *default_value); |
5563 | 324 |
325 /** | |
326 * Returns a protocol-specific boolean setting for an account. | |
327 * | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
328 * @param account The account. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
329 * @param name The name of the setting. |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
330 * @param default_value The default value. |
5563 | 331 * |
332 * @return The value. | |
333 */ | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
334 gboolean gaim_account_get_bool(const GaimAccount *account, const char *name, |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
335 gboolean default_value); |
5563 | 336 |
337 /** | |
5573
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
338 * Loads the accounts. |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
339 */ |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
340 gboolean gaim_accounts_load(); |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
341 |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
342 /** |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
343 * Force an immediate write of accounts. |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
344 */ |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
345 void gaim_accounts_sync(); |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
346 |
5e7de337a053
[gaim-migrate @ 5976]
Christian Hammond <chipx86@chipx86.com>
parents:
5565
diff
changeset
|
347 /** |
5580
86456ec3ca25
[gaim-migrate @ 5984]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
348 * Reorders an account. |
86456ec3ca25
[gaim-migrate @ 5984]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
349 * |
86456ec3ca25
[gaim-migrate @ 5984]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
350 * @param account The account to reorder. |
86456ec3ca25
[gaim-migrate @ 5984]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
351 * @param new_index The new index for the account. |
86456ec3ca25
[gaim-migrate @ 5984]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
352 */ |
86456ec3ca25
[gaim-migrate @ 5984]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
353 void gaim_accounts_reorder(GaimAccount *account, size_t new_index); |
86456ec3ca25
[gaim-migrate @ 5984]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
354 |
86456ec3ca25
[gaim-migrate @ 5984]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
355 /** |
5563 | 356 * Returns a list of all accounts. |
357 * | |
358 * @return A list of all accounts. | |
359 */ | |
360 GList *gaim_accounts_get_all(void); | |
361 | |
362 #endif /* _GAIM_ACCOUNTS_H_ */ |