Mercurial > pidgin.yaz
annotate src/blist.h @ 6762:818ce550d2ce
[gaim-migrate @ 7294]
Added gaim_ssl_connect_fd().
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sat, 06 Sep 2003 01:57:18 +0000 |
parents | ea289c6f2382 |
children | 549a0bbbf73d |
rev | line source |
---|---|
5228 | 1 /** |
5497 | 2 * @file blist.h Buddy List API |
5228 | 3 * @ingroup core |
4 * | |
5 * gaim | |
6 * | |
7 * Copyright (C) 2003, Sean Egan <sean.egan@binghamton.edu> | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
8 * |
5228 | 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 | |
24 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */ | |
25 | |
6695 | 26 #ifndef _BLIST_H_ |
27 #define _BLIST_H_ | |
5228 | 28 |
29 #include <glib.h> | |
30 | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
31 typedef struct _GaimBlistNode GaimBlistNode; |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
32 |
6695 | 33 typedef struct _GaimBlistChat GaimBlistChat; |
34 typedef struct _GaimGroup GaimGroup; | |
35 typedef struct _GaimContact GaimContact; | |
36 typedef struct _GaimBuddy GaimBuddy; | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
37 |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
38 #include "account.h" |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
39 |
5228 | 40 /**************************************************************************/ |
41 /* Enumerations */ | |
42 /**************************************************************************/ | |
43 enum gaim_blist_node_type { | |
44 GAIM_BLIST_GROUP_NODE, | |
6695 | 45 GAIM_BLIST_CONTACT_NODE, |
5228 | 46 GAIM_BLIST_BUDDY_NODE, |
5234 | 47 GAIM_BLIST_CHAT_NODE, |
6063 | 48 GAIM_BLIST_OTHER_NODE |
5228 | 49 }; |
50 | |
5234 | 51 #define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE) |
5228 | 52 #define GAIM_BLIST_NODE_IS_BUDDY(n) ((n)->type == GAIM_BLIST_BUDDY_NODE) |
6695 | 53 #define GAIM_BLIST_NODE_IS_CONTACT(n) ((n)->type == GAIM_BLIST_CONTACT_NODE) |
5228 | 54 #define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE) |
55 | |
56 enum gaim_buddy_presence_state { | |
57 GAIM_BUDDY_SIGNING_OFF = -1, | |
58 GAIM_BUDDY_OFFLINE = 0, | |
59 GAIM_BUDDY_ONLINE, | |
6063 | 60 GAIM_BUDDY_SIGNING_ON |
5228 | 61 }; |
62 | |
6695 | 63 #define GAIM_BUDDY_IS_ONLINE(b) ((b)->account->gc && \ |
64 ((b)->present == GAIM_BUDDY_ONLINE || \ | |
65 (b)->present == GAIM_BUDDY_SIGNING_ON)) | |
5228 | 66 |
67 | |
68 /**************************************************************************/ | |
69 /* Data Structures */ | |
70 /**************************************************************************/ | |
71 | |
72 /** | |
73 * A Buddy list node. This can represent a group, a buddy, or anything else. This is a base class for struct buddy and | |
74 * struct group and for anything else that wants to put itself in the buddy list. */ | |
75 struct _GaimBlistNode { | |
76 enum gaim_blist_node_type type; /**< The type of node this is */ | |
77 GaimBlistNode *prev; /**< The sibling before this buddy. */ | |
78 GaimBlistNode *next; /**< The sibling after this buddy. */ | |
79 GaimBlistNode *parent; /**< The parent of this node */ | |
80 GaimBlistNode *child; /**< The child of this node */ | |
81 void *ui_data; /**< The UI can put data here. */ | |
82 }; | |
83 | |
84 /** | |
85 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
86 */ | |
6695 | 87 struct _GaimBuddy { |
5228 | 88 GaimBlistNode node; /**< The node that this buddy inherits from */ |
89 char *name; /**< The screenname of the buddy. */ | |
90 char *alias; /**< The user-set alias of the buddy */ | |
6695 | 91 char *server_alias; /**< The server-specified alias of the buddy. (i.e. MSN "Friendly Names") */ |
5228 | 92 enum gaim_buddy_presence_state present; /**< This is 0 if the buddy appears offline, 1 if he appears online, and 2 if |
93 he has recently signed on */ | |
94 int evil; /**< The warning level */ | |
95 time_t signon; /**< The time the buddy signed on. */ | |
96 int idle; /**< The time the buddy has been idle in minutes. */ | |
97 int uc; /**< This is a cryptic bitmask that makes sense only to the prpl. This will get changed */ | |
98 void *proto_data; /**< This allows the prpl to associate whatever data it wants with a buddy */ | |
6695 | 99 GaimAccount *account; /**< the account this buddy belongs to */ |
5228 | 100 GHashTable *settings; /**< per-buddy settings from the XML buddy list, set by plugins and the likes. */ |
101 guint timer; /**< The timer handle. */ | |
102 }; | |
103 | |
104 /** | |
6695 | 105 * A contact. This contains everything Gaim will ever need to know about a contact. |
106 */ | |
107 struct _GaimContact { | |
6755 | 108 GaimBlistNode node; /**< The node that this contact inherits from. */ |
109 char *alias; /**< The user-set alias of the contact */ | |
110 int totalsize; /**< The number of buddies in this contact */ | |
111 int currentsize; /**< The number of buddies in this contact corresponding to online accounts */ | |
112 int online; /**< The number of buddies in this contact who are currently online */ | |
6695 | 113 }; |
114 | |
115 | |
116 /** | |
5228 | 117 * A group. This contains everything Gaim will ever need to know about a group. |
118 */ | |
6695 | 119 struct _GaimGroup { |
5228 | 120 GaimBlistNode node; /**< The node that this group inherits from */ |
121 char *name; /**< The name of this group. */ | |
6695 | 122 int totalsize; /**< The number of chats and contacts in this group */ |
123 int currentsize; /**< The number of chats and contacts in this group corresponding to online accounts */ | |
124 int online; /**< The number of chats and contacts in this group who are currently online */ | |
5228 | 125 GHashTable *settings; /**< per-group settings from the XML buddy list, set by plugins and the likes. */ |
126 }; | |
127 | |
5234 | 128 /** |
6695 | 129 * A chat. This contains everything Gaim needs to put a chat room in the |
5234 | 130 * buddy list. |
131 */ | |
6695 | 132 struct _GaimBlistChat { |
5234 | 133 GaimBlistNode node; /**< The node that this chat inherits from */ |
134 char *alias; /**< The display name of this chat. */ | |
135 GHashTable *components; /**< the stuff the protocol needs to know to join the chat */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
136 GaimAccount *account; /**< The account this chat is attached to */ |
5906 | 137 GHashTable *settings; /**< per-chat settings from the XML buddy list, set by plugins and the likes. */ |
5234 | 138 }; |
139 | |
5228 | 140 |
141 /** | |
142 * The Buddy List | |
143 */ | |
144 struct gaim_buddy_list { | |
145 GaimBlistNode *root; /**< The first node in the buddy list */ | |
5247 | 146 GHashTable *buddies; /**< Every buddy in this list */ |
5228 | 147 struct gaim_blist_ui_ops *ui_ops; /**< The UI operations for the buddy list */ |
148 | |
149 void *ui_data; /**< UI-specific data. */ | |
150 }; | |
151 | |
152 /** | |
153 * Buddy list UI operations. | |
154 * | |
155 * Any UI representing a buddy list must assign a filled-out gaim_window_ops | |
156 * structure to the buddy list core. | |
157 */ | |
158 struct gaim_blist_ui_ops | |
159 { | |
160 void (*new_list)(struct gaim_buddy_list *list); /**< Sets UI-specific data on a buddy list. */ | |
161 void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */ | |
162 void (*show)(struct gaim_buddy_list *list); /**< The core will call this when its finished doing it's core stuff */ | |
6695 | 163 void (*update)(struct gaim_buddy_list *list, |
5228 | 164 GaimBlistNode *node); /**< This will update a node in the buddy list. */ |
165 void (*remove)(struct gaim_buddy_list *list, | |
166 GaimBlistNode *node); /**< This removes a node from the list */ | |
167 void (*destroy)(struct gaim_buddy_list *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ | |
168 void (*set_visible)(struct gaim_buddy_list *list, | |
169 gboolean show); /**< Hides or unhides the buddy list */ | |
170 | |
171 }; | |
172 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
173 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
174 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
175 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
176 |
5228 | 177 /**************************************************************************/ |
178 /** @name Buddy List API */ | |
179 /**************************************************************************/ | |
180 /*@{*/ | |
181 | |
182 /** | |
183 * Creates a new buddy list | |
184 */ | |
185 struct gaim_buddy_list *gaim_blist_new(); | |
186 | |
187 /** | |
188 * Sets the main buddy list. | |
189 * | |
190 * @return The main buddy list. | |
191 */ | |
192 void gaim_set_blist(struct gaim_buddy_list *blist); | |
193 | |
194 /** | |
195 * Returns the main buddy list. | |
196 * | |
197 * @return The main buddy list. | |
198 */ | |
199 struct gaim_buddy_list *gaim_get_blist(void); | |
200 | |
201 /** | |
202 * Shows the buddy list, creating a new one if necessary. | |
203 * | |
204 */ | |
205 void gaim_blist_show(); | |
206 | |
207 | |
208 /** | |
209 * Destroys the buddy list window. | |
210 */ | |
211 void gaim_blist_destroy(); | |
212 | |
213 /** | |
214 * Hides or unhides the buddy list. | |
215 * | |
216 * @param show Whether or not to show the buddy list | |
217 */ | |
218 void gaim_blist_set_visible(gboolean show); | |
219 | |
220 /** | |
221 * Updates a buddy's status. | |
5234 | 222 * |
5228 | 223 * This needs to not take an int. |
224 * | |
225 * @param buddy The buddy whose status has changed | |
226 * @param status The new status in cryptic prpl-understood code | |
227 */ | |
6695 | 228 void gaim_blist_update_buddy_status(GaimBuddy *buddy, int status); |
5228 | 229 |
230 | |
231 /** | |
232 * Updates a buddy's presence. | |
233 * | |
234 * @param buddy The buddy whose presence has changed | |
235 * @param presence The new presence | |
236 */ | |
6695 | 237 void gaim_blist_update_buddy_presence(GaimBuddy *buddy, int presence); |
5228 | 238 |
239 | |
240 /** | |
241 * Updates a buddy's idle time. | |
242 * | |
243 * @param buddy The buddy whose idle time has changed | |
244 * @param idle The buddy's idle time in minutes. | |
245 */ | |
6695 | 246 void gaim_blist_update_buddy_idle(GaimBuddy *buddy, int idle); |
5228 | 247 |
248 | |
249 /** | |
250 * Updates a buddy's warning level. | |
251 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
252 * @param buddy The buddy whose warning level has changed. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
253 * @param warning The warning level as an int from 0 to 100. |
5228 | 254 */ |
6695 | 255 void gaim_blist_update_buddy_evil(GaimBuddy *buddy, int warning); |
5228 | 256 |
257 /** | |
258 * Updates a buddy's icon. | |
259 * | |
260 * @param buddy The buddy whose buddy icon has changed | |
261 */ | |
6695 | 262 void gaim_blist_update_buddy_icon(GaimBuddy *buddy); |
5228 | 263 |
264 | |
265 | |
266 /** | |
267 * Renames a buddy in the buddy list. | |
268 * | |
269 * @param buddy The buddy whose name will be changed. | |
270 * @param name The new name of the buddy. | |
271 */ | |
6695 | 272 void gaim_blist_rename_buddy(GaimBuddy *buddy, const char *name); |
5228 | 273 |
274 | |
275 /** | |
276 * Aliases a buddy in the buddy list. | |
277 * | |
278 * @param buddy The buddy whose alias will be changed. | |
279 * @param alias The buddy's alias. | |
280 */ | |
6695 | 281 void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias); |
5228 | 282 |
5234 | 283 /** |
6059 | 284 * Sets the server-sent alias of a buddy in the buddy list. |
6058 | 285 * |
286 * @param buddy The buddy whose alias will be changed. | |
287 * @param alias The buddy's "official" alias. | |
288 */ | |
6695 | 289 void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias); |
6058 | 290 |
291 /** | |
5234 | 292 * Aliases a chat in the buddy list. |
293 * | |
294 * @param chat The chat whose alias will be changed. | |
295 * @param alias The chat's new alias. | |
296 */ | |
6695 | 297 void gaim_blist_alias_chat(GaimBlistChat *chat, const char *alias); |
5228 | 298 |
299 /** | |
300 * Renames a group | |
301 * | |
302 * @param group The group to rename | |
303 * @param name The new name | |
304 */ | |
6695 | 305 void gaim_blist_rename_group(GaimGroup *group, const char *name); |
5228 | 306 |
5234 | 307 /** |
308 * Creates a new chat for the buddy list | |
309 * | |
310 * @param account The account this chat will get added to | |
311 * @param alias The alias of the new chat | |
312 * @param components The info the prpl needs to join the chat | |
313 * @return A newly allocated chat | |
314 */ | |
6695 | 315 GaimBlistChat *gaim_blist_chat_new(GaimAccount *account, const char *alias, GHashTable *components); |
5234 | 316 |
317 /** | |
6034 | 318 * Gets the alias of the chat, or the chat name if the alias does not exist |
319 * | |
320 * @param chat The chat | |
321 * @return The display name of the chat | |
322 */ | |
6695 | 323 char *gaim_blist_chat_get_display_name(GaimBlistChat *chat); |
6034 | 324 |
325 /** | |
5234 | 326 * Adds a new chat to the buddy list. |
327 * | |
328 * The chat will be inserted right after node or appended to the end | |
329 * of group if node is NULL. If both are NULL, the buddy will be added to | |
330 * the "Chats" group. | |
331 * | |
332 * @param chat The new chat who gets added | |
333 * @param group The group to add the new chat to. | |
334 * @param node The insertion point | |
335 */ | |
6695 | 336 void gaim_blist_add_chat(GaimBlistChat *chat, GaimGroup *group, GaimBlistNode *node); |
5228 | 337 |
338 /** | |
339 * Creates a new buddy | |
340 * | |
341 * @param account The account this buddy will get added to | |
342 * @param screenname The screenname of the new buddy | |
343 * @param alias The alias of the new buddy (or NULL if unaliased) | |
344 * @return A newly allocated buddy | |
345 */ | |
6695 | 346 GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); |
5228 | 347 |
348 /** | |
349 * Adds a new buddy to the buddy list. | |
350 * | |
6695 | 351 * The buddy will be inserted right after node or prepended to the |
352 * group if node is NULL. If both are NULL, the buddy will be added to | |
5228 | 353 * the "Buddies" group. |
354 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
355 * @param buddy The new buddy who gets added |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
356 * @param contact The optional contact to place the buddy in. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
357 * @param group The group to add the new buddy to. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
358 * @param node The insertion point |
5228 | 359 */ |
6695 | 360 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); |
5228 | 361 |
362 /** | |
363 * Creates a new group | |
364 * | |
6695 | 365 * You can't have more than one group with the same name. Sorry. If you pass |
366 * this the * name of a group that already exists, it will return that group. | |
5228 | 367 * |
368 * @param name The name of the new group | |
6695 | 369 * @return A new group struct |
5228 | 370 */ |
6695 | 371 GaimGroup *gaim_group_new(const char *name); |
5228 | 372 |
373 /** | |
374 * Adds a new group to the buddy list. | |
375 * | |
6695 | 376 * The new group will be inserted after insert or prepended to the list if |
377 * node is NULL. | |
378 * | |
379 * @param group The group | |
380 * @param node The insertion point | |
381 */ | |
382 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
383 | |
384 /** | |
385 * Creates a new contact | |
5228 | 386 * |
6695 | 387 * @return A new contact struct |
5228 | 388 */ |
6695 | 389 GaimContact *gaim_contact_new(); |
390 | |
391 /** | |
392 * Adds a new contact to the buddy list. | |
393 * | |
394 * The new contact will be inserted after insert or prepended to the list if | |
395 * node is NULL. | |
396 * | |
397 * @param contact The contact | |
398 * @param group The group to add the contact to | |
399 * @param node The insertion point | |
400 */ | |
401 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
402 | |
403 /** | |
404 * Returns the highest priority buddy for a given contact. | |
405 * | |
406 * @param contact The contact | |
407 * @return The highest priority buddy | |
408 */ | |
409 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
5228 | 410 |
411 /** | |
6755 | 412 * Sets the alias for a contact. |
413 * | |
414 * @param contact The contact | |
415 * @param alias The alias to set, or NULL to unset | |
416 */ | |
417 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
418 | |
419 /** | |
420 * Gets the alias for a contact. | |
421 * | |
422 * @param contact The contact | |
423 * @return The alias, or NULL if it is not set. | |
424 */ | |
425 const char *gaim_contact_get_alias(GaimContact *contact); | |
426 | |
427 /** | |
5228 | 428 * Removes a buddy from the buddy list and frees the memory allocated to it. |
429 * | |
430 * @param buddy The buddy to be removed | |
431 */ | |
6695 | 432 void gaim_blist_remove_buddy(GaimBuddy *buddy); |
433 | |
434 /** | |
435 * Removes a contact, and any buddies it contains, and frees the memory | |
436 * allocated to it. | |
437 * | |
438 * @param contact The contact to be removed | |
439 */ | |
440 void gaim_blist_remove_contact(GaimContact *contact); | |
5228 | 441 |
442 /** | |
5234 | 443 * Removes a chat from the buddy list and frees the memory allocated to it. |
444 * | |
445 * @param chat The chat to be removed | |
446 */ | |
6695 | 447 void gaim_blist_remove_chat(GaimBlistChat *chat); |
5234 | 448 |
449 /** | |
5228 | 450 * Removes a group from the buddy list and frees the memory allocated to it and to |
451 * its children | |
452 * | |
453 * @param group The group to be removed | |
454 */ | |
6695 | 455 void gaim_blist_remove_group(GaimGroup *group); |
5228 | 456 |
457 /** | |
458 * Returns the alias of a buddy. | |
459 * | |
460 * @param buddy The buddy whose name will be returned. | |
461 * @return The alias (if set), server alias (if option is set), or NULL. | |
462 */ | |
6695 | 463 const char *gaim_get_buddy_alias_only(GaimBuddy *buddy); |
5228 | 464 |
465 | |
466 /** | |
467 * Returns the correct name to display for a buddy. | |
468 * | |
469 * @param buddy The buddy whose name will be returned. | |
470 * @return The alias (if set), server alias (if option is set), screenname, or "Unknown" | |
471 */ | |
6695 | 472 const char *gaim_get_buddy_alias(GaimBuddy *buddy); |
5228 | 473 |
474 /** | |
6744 | 475 * Returns the correct name to display for a blist chat. |
476 * | |
477 * @param chat The chat whose name will be returned. | |
478 * @return The alias (if set), or first component value. | |
479 */ | |
480 const char *gaim_blist_chat_get_name(GaimBlistChat *chat); | |
481 | |
482 /** | |
5228 | 483 * Finds the buddy struct given a screenname and an account |
484 * | |
5758 | 485 * @param name The buddy's screenname or NULL to search for more buddies with the same screenname |
486 * as the previous search | |
5228 | 487 * @param account The account this buddy belongs to |
488 * @return The buddy or NULL if the buddy does not exist | |
489 */ | |
6695 | 490 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); |
6245 | 491 |
492 /** | |
493 * Finds all buddies struct given a screenname and an account | |
494 * | |
495 * @param name The buddy's screenname | |
496 * @param account The account this buddy belongs to | |
497 * | |
498 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist | |
499 */ | |
500 GSList *gaim_find_buddies(GaimAccount *account, const char *name); | |
501 | |
5228 | 502 |
503 /** | |
504 * Finds a group by name | |
505 * | |
506 * @param name The groups name | |
507 * @return The group or NULL if the group does not exist | |
508 */ | |
6695 | 509 GaimGroup *gaim_find_group(const char *name); |
510 | |
511 /** | |
512 * Finds a contact | |
513 * | |
514 * @param group The group to look in | |
515 * @param name The name to look for | |
516 * @return The contact or NULL if the contact does not exist | |
517 */ | |
518 GaimContact *gaim_find_contact(GaimGroup *group, const char *name); | |
5228 | 519 |
520 /** | |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
521 * Finds a chat by name. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
522 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
523 * @param account The chat's account. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
524 * @param name The chat's name. |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
525 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
526 * @return The chat, or @c NULL if the chat does not exist. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
527 */ |
6695 | 528 GaimBlistChat *gaim_blist_find_chat(GaimAccount *account, const char *name); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
529 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
530 /** |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
531 * Returns the group of which the chat is a member. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
532 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
533 * @param chat The chat. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
534 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
535 * @return The parent group, or @c NULL if the chat is not in a group. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
536 */ |
6695 | 537 GaimGroup *gaim_blist_chat_get_group(GaimBlistChat *chat); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
538 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
539 /** |
5228 | 540 * Returns the group of which the buddy is a member. |
541 * | |
542 * @param buddy The buddy | |
543 * @return The group or NULL if the buddy is not in a group | |
544 */ | |
6695 | 545 GaimGroup *gaim_find_buddys_group(GaimBuddy *buddy); |
5228 | 546 |
547 | |
548 /** | |
549 * Returns a list of accounts that have buddies in this group | |
550 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
551 * @param g The group |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
552 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
553 * @return A list of gaim_accounts |
5228 | 554 */ |
6695 | 555 GSList *gaim_group_get_accounts(GaimGroup *g); |
5228 | 556 |
557 /** | |
558 * Determines whether an account owns any buddies in a given group | |
559 * | |
560 * @param g The group to search through. | |
561 * @param account The account. | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
562 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
563 * @return TRUE if there are any buddies in the group, or FALSE otherwise. |
5228 | 564 */ |
6695 | 565 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); |
5228 | 566 |
567 /** | |
5234 | 568 * Called when an account gets signed on. Tells the UI to update all the |
569 * buddies. | |
570 * | |
571 * @param account The account | |
572 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
573 void gaim_blist_add_account(GaimAccount *account); |
5234 | 574 |
575 | |
576 /** | |
5228 | 577 * Called when an account gets signed off. Sets the presence of all the buddies to 0 |
578 * and tells the UI to update them. | |
579 * | |
6695 | 580 * @param account The account |
5228 | 581 */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
582 void gaim_blist_remove_account(GaimAccount *account); |
5228 | 583 |
584 | |
585 /** | |
586 * Determines the total size of a group | |
587 * | |
588 * @param group The group | |
589 * @param offline Count buddies in offline accounts | |
590 * @return The number of buddies in the group | |
591 */ | |
6695 | 592 int gaim_blist_get_group_size(GaimGroup *group, gboolean offline); |
5228 | 593 |
594 /** | |
595 * Determines the number of online buddies in a group | |
596 * | |
597 * @param group The group | |
598 * @return The number of online buddies in the group, or 0 if the group is NULL | |
599 */ | |
6695 | 600 int gaim_blist_get_group_online_count(GaimGroup *group); |
5228 | 601 |
602 /*@}*/ | |
603 | |
604 /****************************************************************************************/ | |
605 /** @name Buddy list file management API */ | |
606 /****************************************************************************************/ | |
607 | |
608 /*@{*/ | |
609 /** | |
610 * Saves the buddy list to file | |
611 */ | |
612 void gaim_blist_save(); | |
613 | |
614 /** | |
615 * Parses the toc-style buddy list used in older versions of Gaim and for SSI in toc.c | |
616 * | |
617 * @param account This is the account that the buddies and groups from config will get added to | |
618 * @param config This is the toc-style buddy list data | |
619 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
620 void parse_toc_buddy_list(GaimAccount *account, char *config); |
5228 | 621 |
622 | |
623 /** | |
624 * Loads the buddy list from ~/.gaim/blist.xml. | |
625 */ | |
626 void gaim_blist_load(); | |
627 | |
628 /** | |
629 * Associates some data with the group in the xml buddy list | |
630 * | |
631 * @param g The group the data is associated with | |
632 * @param key The key used to retrieve the data | |
633 * @param value The data to set | |
634 */ | |
6695 | 635 void gaim_group_set_setting(GaimGroup *g, const char *key, const char *value); |
5228 | 636 |
637 /** | |
638 * Retrieves data from the XML buddy list set by gaim_group_set_setting()) | |
639 * | |
640 * @param g The group to retrieve data from | |
641 * @param key The key to retrieve the data with | |
642 * @return The associated data or NULL if no data is associated | |
643 */ | |
6695 | 644 char *gaim_group_get_setting(GaimGroup *g, const char *key); |
5228 | 645 |
5906 | 646 /** |
647 * Associates some data with the chat in the xml buddy list | |
648 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
649 * @param c The chat the data is associated with |
5906 | 650 * @param key The key used to retrieve the data |
651 * @param value The data to set | |
652 */ | |
6695 | 653 void gaim_blist_chat_set_setting(GaimBlistChat *c, const char *key, const char *value); |
5906 | 654 |
655 /** | |
6735 | 656 * Retrieves data from the XML buddy list set by gaim_blist_chat_set_setting()) |
5906 | 657 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
658 * @param c The chat to retrieve data from |
5906 | 659 * @param key The key to retrieve the data with |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
660 * |
5906 | 661 * @return The associated data or NULL if no data is associated |
662 */ | |
6695 | 663 char *gaim_blist_chat_get_setting(GaimBlistChat *c, const char *key); |
5228 | 664 |
665 /** | |
666 * Associates some data with the buddy in the xml buddy list | |
667 * | |
668 * @param b The buddy the data is associated with | |
669 * @param key The key used to retrieve the data | |
670 * @param value The data to set | |
671 */ | |
6695 | 672 void gaim_buddy_set_setting(GaimBuddy *b, const char *key, const char *value); |
5228 | 673 |
674 /** | |
675 * Retrieves data from the XML buddy list set by gaim_buddy_set_setting()) | |
676 * | |
677 * @param b The buddy to retrieve data from | |
678 * @param key The key to retrieve the data with | |
679 * @return The associated data or NULL if no data is associated | |
680 */ | |
6695 | 681 char *gaim_buddy_get_setting(GaimBuddy *b, const char *key); |
5228 | 682 |
683 /*@}*/ | |
684 | |
685 /**************************************************************************/ | |
686 /** @name UI Registration Functions */ | |
687 /**************************************************************************/ | |
688 /*@{*/ | |
689 | |
690 /** | |
691 * Sets the UI operations structure to be used for the buddy list. | |
692 * | |
693 * @param ops The ops struct. | |
694 */ | |
695 void gaim_set_blist_ui_ops(struct gaim_blist_ui_ops *ops); | |
696 | |
697 /** | |
698 * Returns the UI operations structure to be used for the buddy list. | |
699 * | |
700 * @return The UI operations structure. | |
701 */ | |
702 struct gaim_blist_ui_ops *gaim_get_blist_ui_ops(void); | |
703 | |
704 /*@}*/ | |
705 | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
706 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
707 /** @name Buddy List Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
708 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
709 /*@{*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
710 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
711 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
712 * Returns the handle for the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
713 * |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
714 * @return The buddy list subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
715 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
716 void *gaim_blist_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
717 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
718 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
719 * Initializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
720 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
721 void gaim_blist_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
722 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
723 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
724 * Uninitializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
725 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
726 void gaim_blist_uninit(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
727 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
728 /*@}*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
729 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
730 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
731 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
732 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
733 |
6695 | 734 #endif /* _BLIST_H_ */ |