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