Mercurial > pidgin.yaz
annotate libgaim/blist.h @ 15142:66c857a355b4
[gaim-migrate @ 17927]
Stephen Pope in #gaim found a bug in our perl stuff where we were
creating some hash tables that used g_direct_hash instead of
g_str_hash
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sat, 09 Dec 2006 20:11:43 +0000 |
parents | 4124030c3f3a |
children |
rev | line source |
---|---|
14192 | 1 /** |
2 * @file blist.h Buddy List API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Gaim is the legal property of its developers, whose names are too numerous | |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 #ifndef _GAIM_BLIST_H_ | |
26 #define _GAIM_BLIST_H_ | |
27 | |
28 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */ | |
29 | |
30 #include <glib.h> | |
31 | |
32 typedef struct _GaimBuddyList GaimBuddyList; | |
33 typedef struct _GaimBlistUiOps GaimBlistUiOps; | |
34 typedef struct _GaimBlistNode GaimBlistNode; | |
35 | |
36 typedef struct _GaimChat GaimChat; | |
37 typedef struct _GaimGroup GaimGroup; | |
38 typedef struct _GaimContact GaimContact; | |
39 typedef struct _GaimBuddy GaimBuddy; | |
40 | |
41 /**************************************************************************/ | |
42 /* Enumerations */ | |
43 /**************************************************************************/ | |
44 typedef enum | |
45 { | |
46 GAIM_BLIST_GROUP_NODE, | |
47 GAIM_BLIST_CONTACT_NODE, | |
48 GAIM_BLIST_BUDDY_NODE, | |
49 GAIM_BLIST_CHAT_NODE, | |
50 GAIM_BLIST_OTHER_NODE | |
51 | |
52 } GaimBlistNodeType; | |
53 | |
54 #define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE) | |
55 #define GAIM_BLIST_NODE_IS_BUDDY(n) ((n)->type == GAIM_BLIST_BUDDY_NODE) | |
56 #define GAIM_BLIST_NODE_IS_CONTACT(n) ((n)->type == GAIM_BLIST_CONTACT_NODE) | |
57 #define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE) | |
58 | |
59 #define GAIM_BUDDY_IS_ONLINE(b) \ | |
60 ((b) != NULL && gaim_account_is_connected((b)->account) && \ | |
61 gaim_presence_is_online(gaim_buddy_get_presence(b))) | |
62 | |
63 typedef enum | |
64 { | |
65 GAIM_BLIST_NODE_FLAG_NO_SAVE = 1 /**< node should not be saved with the buddy list */ | |
66 | |
67 } GaimBlistNodeFlags; | |
68 | |
69 #define GAIM_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f)) | |
70 #define GAIM_BLIST_NODE_SHOULD_SAVE(b) (! GAIM_BLIST_NODE_HAS_FLAG(b, GAIM_BLIST_NODE_FLAG_NO_SAVE)) | |
71 | |
72 #define GAIM_BLIST_NODE_NAME(n) ((n)->type == GAIM_BLIST_CHAT_NODE ? gaim_chat_get_name((GaimChat*)n) : \ | |
73 (n)->type == GAIM_BLIST_BUDDY_NODE ? gaim_buddy_get_name((GaimBuddy*)n) : NULL) | |
74 | |
75 #include "account.h" | |
76 #include "buddyicon.h" | |
77 #include "status.h" | |
78 | |
79 /**************************************************************************/ | |
80 /* Data Structures */ | |
81 /**************************************************************************/ | |
82 | |
83 /** | |
84 * A Buddy list node. This can represent a group, a buddy, or anything else. | |
85 * This is a base class for struct buddy and struct group and for anything | |
86 * else that wants to put itself in the buddy list. */ | |
87 struct _GaimBlistNode { | |
88 GaimBlistNodeType type; /**< The type of node this is */ | |
89 GaimBlistNode *prev; /**< The sibling before this buddy. */ | |
90 GaimBlistNode *next; /**< The sibling after this buddy. */ | |
91 GaimBlistNode *parent; /**< The parent of this node */ | |
92 GaimBlistNode *child; /**< The child of this node */ | |
93 GHashTable *settings; /**< per-node settings */ | |
94 void *ui_data; /**< The UI can put data here. */ | |
95 GaimBlistNodeFlags flags; /**< The buddy flags */ | |
96 }; | |
97 | |
98 /** | |
99 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
100 */ | |
101 struct _GaimBuddy { | |
102 GaimBlistNode node; /**< The node that this buddy inherits from */ | |
103 char *name; /**< The screenname of the buddy. */ | |
104 char *alias; /**< The user-set alias of the buddy */ | |
105 char *server_alias; /**< The server-specified alias of the buddy. (i.e. MSN "Friendly Names") */ | |
106 void *proto_data; /**< This allows the prpl to associate whatever data it wants with a buddy */ | |
107 GaimBuddyIcon *icon; /**< The buddy icon. */ | |
108 GaimAccount *account; /**< the account this buddy belongs to */ | |
109 GaimPresence *presence; | |
110 }; | |
111 | |
112 /** | |
113 * A contact. This contains everything Gaim will ever need to know about a contact. | |
114 */ | |
115 struct _GaimContact { | |
116 GaimBlistNode node; /**< The node that this contact inherits from. */ | |
117 char *alias; /**< The user-set alias of the contact */ | |
118 int totalsize; /**< The number of buddies in this contact */ | |
119 int currentsize; /**< The number of buddies in this contact corresponding to online accounts */ | |
120 int online; /**< The number of buddies in this contact who are currently online */ | |
121 GaimBuddy *priority; /**< The "top" buddy for this contact */ | |
122 gboolean priority_valid; /**< Is priority valid? */ | |
123 }; | |
124 | |
125 | |
126 /** | |
127 * A group. This contains everything Gaim will ever need to know about a group. | |
128 */ | |
129 struct _GaimGroup { | |
130 GaimBlistNode node; /**< The node that this group inherits from */ | |
131 char *name; /**< The name of this group. */ | |
132 int totalsize; /**< The number of chats and contacts in this group */ | |
133 int currentsize; /**< The number of chats and contacts in this group corresponding to online accounts */ | |
134 int online; /**< The number of chats and contacts in this group who are currently online */ | |
135 }; | |
136 | |
137 /** | |
138 * A chat. This contains everything Gaim needs to put a chat room in the | |
139 * buddy list. | |
140 */ | |
141 struct _GaimChat { | |
142 GaimBlistNode node; /**< The node that this chat inherits from */ | |
143 char *alias; /**< The display name of this chat. */ | |
144 GHashTable *components; /**< the stuff the protocol needs to know to join the chat */ | |
145 GaimAccount *account; /**< The account this chat is attached to */ | |
146 }; | |
147 | |
148 | |
149 /** | |
150 * The Buddy List | |
151 */ | |
152 struct _GaimBuddyList { | |
153 GaimBlistNode *root; /**< The first node in the buddy list */ | |
154 GHashTable *buddies; /**< Every buddy in this list */ | |
155 void *ui_data; /**< UI-specific data. */ | |
156 }; | |
157 | |
158 /** | |
159 * Buddy list UI operations. | |
160 * | |
161 * Any UI representing a buddy list must assign a filled-out GaimBlistUiOps | |
162 * structure to the buddy list core. | |
163 */ | |
164 struct _GaimBlistUiOps | |
165 { | |
166 void (*new_list)(GaimBuddyList *list); /**< Sets UI-specific data on a buddy list. */ | |
167 void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */ | |
168 void (*show)(GaimBuddyList *list); /**< The core will call this when it's finished doing its core stuff */ | |
169 void (*update)(GaimBuddyList *list, | |
170 GaimBlistNode *node); /**< This will update a node in the buddy list. */ | |
171 void (*remove)(GaimBuddyList *list, | |
172 GaimBlistNode *node); /**< This removes a node from the list */ | |
173 void (*destroy)(GaimBuddyList *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ | |
174 void (*set_visible)(GaimBuddyList *list, | |
175 gboolean show); /**< Hides or unhides the buddy list */ | |
176 void (*request_add_buddy)(GaimAccount *account, const char *username, | |
177 const char *group, const char *alias); | |
178 void (*request_add_chat)(GaimAccount *account, GaimGroup *group, | |
179 const char *alias, const char *name); | |
180 void (*request_add_group)(void); | |
181 }; | |
182 | |
183 #ifdef __cplusplus | |
184 extern "C" { | |
185 #endif | |
186 | |
187 /**************************************************************************/ | |
188 /** @name Buddy List API */ | |
189 /**************************************************************************/ | |
190 /*@{*/ | |
191 | |
192 /** | |
193 * Creates a new buddy list | |
194 * | |
195 * @return The new buddy list. | |
196 */ | |
197 GaimBuddyList *gaim_blist_new(void); | |
198 | |
199 /** | |
200 * Sets the main buddy list. | |
201 * | |
202 * @param blist The buddy list you want to use. | |
203 */ | |
204 void gaim_set_blist(GaimBuddyList *blist); | |
205 | |
206 /** | |
207 * Returns the main buddy list. | |
208 * | |
209 * @return The main buddy list. | |
210 */ | |
211 GaimBuddyList *gaim_get_blist(void); | |
212 | |
213 /** | |
214 * Returns the root node of the main buddy list. | |
215 * | |
216 * @return The root node. | |
217 */ | |
218 GaimBlistNode *gaim_blist_get_root(void); | |
219 | |
220 /** | |
221 * Returns the next node of a given node. This function is to be used to iterate | |
222 * over the tree returned by gaim_get_blist. | |
223 * | |
224 * @param node A node. | |
225 * @param offline Whether to include nodes for offline accounts | |
226 * @return The next node | |
227 */ | |
228 GaimBlistNode *gaim_blist_node_next(GaimBlistNode *node, gboolean offline); | |
229 | |
230 /** | |
231 * Shows the buddy list, creating a new one if necessary. | |
232 */ | |
233 void gaim_blist_show(void); | |
234 | |
235 | |
236 /** | |
237 * Destroys the buddy list window. | |
238 */ | |
239 void gaim_blist_destroy(void); | |
240 | |
241 /** | |
242 * Hides or unhides the buddy list. | |
243 * | |
244 * @param show Whether or not to show the buddy list | |
245 */ | |
246 void gaim_blist_set_visible(gboolean show); | |
247 | |
248 /** | |
249 * Updates a buddy's status. | |
250 * | |
251 * @param buddy The buddy whose status has changed. | |
252 * @param old_status The status from which we are changing. | |
253 */ | |
254 void gaim_blist_update_buddy_status(GaimBuddy *buddy, GaimStatus *old_status); | |
255 | |
256 /** | |
257 * Updates a buddy's icon. | |
258 * | |
259 * @param buddy The buddy whose buddy icon has changed | |
260 */ | |
261 void gaim_blist_update_buddy_icon(GaimBuddy *buddy); | |
262 | |
263 /** | |
264 * Renames a buddy in the buddy list. | |
265 * | |
266 * @param buddy The buddy whose name will be changed. | |
267 * @param name The new name of the buddy. | |
268 */ | |
269 void gaim_blist_rename_buddy(GaimBuddy *buddy, const char *name); | |
270 | |
271 /** | |
272 * Aliases a contact in the buddy list. | |
273 * | |
274 * @param contact The contact whose alias will be changed. | |
275 * @param alias The contact's alias. | |
276 */ | |
277 void gaim_blist_alias_contact(GaimContact *contact, const char *alias); | |
278 | |
279 /** | |
280 * Aliases a buddy in the buddy list. | |
281 * | |
282 * @param buddy The buddy whose alias will be changed. | |
283 * @param alias The buddy's alias. | |
284 */ | |
285 void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias); | |
286 | |
287 /** | |
288 * Sets the server-sent alias of a buddy in the buddy list. | |
289 * PRPLs should call serv_got_alias() instead of this. | |
290 * | |
291 * @param buddy The buddy whose alias will be changed. | |
292 * @param alias The buddy's "official" alias. | |
293 */ | |
294 void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias); | |
295 | |
296 /** | |
297 * Aliases a chat in the buddy list. | |
298 * | |
299 * @param chat The chat whose alias will be changed. | |
300 * @param alias The chat's new alias. | |
301 */ | |
302 void gaim_blist_alias_chat(GaimChat *chat, const char *alias); | |
303 | |
304 /** | |
305 * Renames a group | |
306 * | |
307 * @param group The group to rename | |
308 * @param name The new name | |
309 */ | |
310 void gaim_blist_rename_group(GaimGroup *group, const char *name); | |
311 | |
312 /** | |
313 * Creates a new chat for the buddy list | |
314 * | |
315 * @param account The account this chat will get added to | |
316 * @param alias The alias of the new chat | |
15142 | 317 * @param components The info the prpl needs to join the chat. The |
318 * hash function should be g_str_hash() and the | |
319 * equal function should be g_str_equal(). | |
14192 | 320 * @return A newly allocated chat |
321 */ | |
322 GaimChat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); | |
323 | |
324 /** | |
325 * Adds a new chat to the buddy list. | |
326 * | |
327 * The chat will be inserted right after node or appended to the end | |
328 * of group if node is NULL. If both are NULL, the buddy will be added to | |
329 * the "Chats" group. | |
330 * | |
331 * @param chat The new chat who gets added | |
332 * @param group The group to add the new chat to. | |
333 * @param node The insertion point | |
334 */ | |
335 void gaim_blist_add_chat(GaimChat *chat, GaimGroup *group, GaimBlistNode *node); | |
336 | |
337 /** | |
338 * Creates a new buddy | |
339 * | |
340 * @param account The account this buddy will get added to | |
341 * @param screenname The screenname of the new buddy | |
342 * @param alias The alias of the new buddy (or NULL if unaliased) | |
343 * @return A newly allocated buddy | |
344 */ | |
345 GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); | |
346 | |
347 /** | |
348 * Sets a buddy's icon. | |
349 * | |
350 * This should only be called from within Gaim. You probably want to | |
351 * call gaim_buddy_icon_set_data(). | |
352 * | |
353 * @param buddy The buddy. | |
354 * @param icon The buddy icon. | |
355 * | |
356 * @see gaim_buddy_icon_set_data() | |
357 */ | |
358 void gaim_buddy_set_icon(GaimBuddy *buddy, GaimBuddyIcon *icon); | |
359 | |
360 /** | |
361 * Returns a buddy's account. | |
362 * | |
363 * @param buddy The buddy. | |
364 * | |
365 * @return The account | |
366 */ | |
367 GaimAccount *gaim_buddy_get_account(const GaimBuddy *buddy); | |
368 | |
369 /** | |
370 * Returns a buddy's name | |
371 * | |
372 * @param buddy The buddy. | |
373 * | |
374 * @return The name. | |
375 */ | |
376 const char *gaim_buddy_get_name(const GaimBuddy *buddy); | |
377 | |
378 /** | |
379 * Returns a buddy's icon. | |
380 * | |
381 * @param buddy The buddy. | |
382 * | |
383 * @return The buddy icon. | |
384 */ | |
385 GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy); | |
386 | |
387 /** | |
388 * Returns a buddy's contact. | |
389 * | |
390 * @param buddy The buddy. | |
391 * | |
392 * @return The buddy's contact. | |
393 */ | |
394 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); | |
395 | |
396 /** | |
397 * Returns a buddy's presence. | |
398 * | |
399 * @param buddy The buddy. | |
400 * | |
401 * @return The buddy's presence. | |
402 */ | |
403 GaimPresence *gaim_buddy_get_presence(const GaimBuddy *buddy); | |
404 | |
405 /** | |
406 * Adds a new buddy to the buddy list. | |
407 * | |
408 * The buddy will be inserted right after node or prepended to the | |
409 * group if node is NULL. If both are NULL, the buddy will be added to | |
410 * the "Buddies" group. | |
411 * | |
412 * @param buddy The new buddy who gets added | |
413 * @param contact The optional contact to place the buddy in. | |
414 * @param group The group to add the new buddy to. | |
415 * @param node The insertion point | |
416 */ | |
417 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
418 | |
419 /** | |
420 * Creates a new group | |
421 * | |
422 * You can't have more than one group with the same name. Sorry. If you pass | |
423 * this the * name of a group that already exists, it will return that group. | |
424 * | |
425 * @param name The name of the new group | |
426 * @return A new group struct | |
427 */ | |
428 GaimGroup *gaim_group_new(const char *name); | |
429 | |
430 /** | |
431 * Adds a new group to the buddy list. | |
432 * | |
433 * The new group will be inserted after insert or prepended to the list if | |
434 * node is NULL. | |
435 * | |
436 * @param group The group | |
437 * @param node The insertion point | |
438 */ | |
439 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
440 | |
441 /** | |
442 * Creates a new contact | |
443 * | |
444 * @return A new contact struct | |
445 */ | |
446 GaimContact *gaim_contact_new(void); | |
447 | |
448 /** | |
449 * Adds a new contact to the buddy list. | |
450 * | |
451 * The new contact will be inserted after insert or prepended to the list if | |
452 * node is NULL. | |
453 * | |
454 * @param contact The contact | |
455 * @param group The group to add the contact to | |
456 * @param node The insertion point | |
457 */ | |
458 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
459 | |
460 /** | |
461 * Merges two contacts | |
462 * | |
463 * All of the buddies from source will be moved to target | |
464 * | |
465 * @param source The contact to merge | |
466 * @param node The place to merge to (a buddy or contact) | |
467 */ | |
468 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); | |
469 | |
470 /** | |
471 * Returns the highest priority buddy for a given contact. | |
472 * | |
473 * @param contact The contact | |
474 * @return The highest priority buddy | |
475 */ | |
476 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
477 | |
478 /** | |
479 * Sets the alias for a contact. | |
480 * | |
481 * @param contact The contact | |
482 * @param alias The alias to set, or NULL to unset | |
483 */ | |
484 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
485 | |
486 /** | |
487 * Gets the alias for a contact. | |
488 * | |
489 * @param contact The contact | |
490 * @return The alias, or NULL if it is not set. | |
491 */ | |
492 const char *gaim_contact_get_alias(GaimContact *contact); | |
493 | |
494 /** | |
495 * Determines whether an account owns any buddies in a given contact | |
496 * | |
497 * @param contact The contact to search through. | |
498 * @param account The account. | |
499 * | |
500 * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise. | |
501 */ | |
502 gboolean gaim_contact_on_account(GaimContact *contact, GaimAccount *account); | |
503 | |
504 /** | |
505 * Invalidates the priority buddy so that the next call to | |
506 * gaim_contact_get_priority_buddy recomputes it. | |
507 * | |
508 * @param contact The contact | |
509 */ | |
510 void gaim_contact_invalidate_priority_buddy(GaimContact *contact); | |
511 /** | |
512 * Removes a buddy from the buddy list and frees the memory allocated to it. | |
513 * | |
514 * @param buddy The buddy to be removed | |
515 */ | |
516 void gaim_blist_remove_buddy(GaimBuddy *buddy); | |
517 | |
518 /** | |
519 * Removes a contact, and any buddies it contains, and frees the memory | |
520 * allocated to it. | |
521 * | |
522 * @param contact The contact to be removed | |
523 */ | |
524 void gaim_blist_remove_contact(GaimContact *contact); | |
525 | |
526 /** | |
527 * Removes a chat from the buddy list and frees the memory allocated to it. | |
528 * | |
529 * @param chat The chat to be removed | |
530 */ | |
531 void gaim_blist_remove_chat(GaimChat *chat); | |
532 | |
533 /** | |
534 * Removes a group from the buddy list and frees the memory allocated to it and to | |
535 * its children | |
536 * | |
537 * @param group The group to be removed | |
538 */ | |
539 void gaim_blist_remove_group(GaimGroup *group); | |
540 | |
541 /** | |
542 * Returns the alias of a buddy. | |
543 * | |
544 * @param buddy The buddy whose name will be returned. | |
545 * @return The alias (if set), server alias (if set), | |
546 * or NULL. | |
547 */ | |
548 const char *gaim_buddy_get_alias_only(GaimBuddy *buddy); | |
549 | |
14491
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
550 /** |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
551 * Gets the server alias for a buddy. |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
552 * |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
553 * @param buddy The buddy whose name will be returned |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
554 * @return The server alias, or NULL if it is not set. |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
555 */ |
8a1c6ed3dde6
[gaim-migrate @ 17210]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
556 const char *gaim_buddy_get_server_alias(GaimBuddy *buddy); |
14192 | 557 |
558 /** | |
559 * Returns the correct name to display for a buddy, taking the contact alias | |
560 * into account. In order of precedence: the buddy's alias; the buddy's | |
561 * contact alias; the buddy's server alias; the buddy's user name. | |
562 * | |
563 * @param buddy The buddy whose name will be returned | |
564 * @return The appropriate name or alias, or NULL. | |
565 * | |
566 */ | |
567 const char *gaim_buddy_get_contact_alias(GaimBuddy *buddy); | |
568 | |
569 /** | |
570 * Returns the correct alias for this user, ignoring server aliases. Used | |
571 * when a user-recognizable name is required. In order: buddy's alias; buddy's | |
572 * contact alias; buddy's user name. | |
573 * | |
574 * @param buddy The buddy whose alias will be returned. | |
575 * @return The appropriate name or alias. | |
576 */ | |
577 const char *gaim_buddy_get_local_alias(GaimBuddy *buddy); | |
578 | |
579 /** | |
580 * Returns the correct name to display for a buddy. In order of precedence: | |
581 * the buddy's alias; the buddy's server alias; the buddy's contact alias; | |
582 * the buddy's user name. | |
583 * | |
584 * @param buddy The buddy whose name will be returned. | |
585 * @return The appropriate name or alias, or NULL | |
586 */ | |
587 const char *gaim_buddy_get_alias(GaimBuddy *buddy); | |
588 | |
589 /** | |
590 * Returns the correct name to display for a blist chat. | |
591 * | |
592 * @param chat The chat whose name will be returned. | |
593 * @return The alias (if set), or first component value. | |
594 */ | |
595 const char *gaim_chat_get_name(GaimChat *chat); | |
596 | |
597 /** | |
598 * Finds the buddy struct given a screenname and an account | |
599 * | |
600 * @param account The account this buddy belongs to | |
601 * @param name The buddy's screenname | |
602 * @return The buddy or NULL if the buddy does not exist | |
603 */ | |
604 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); | |
605 | |
606 /** | |
607 * Finds the buddy struct given a screenname, an account, and a group | |
608 * | |
609 * @param account The account this buddy belongs to | |
610 * @param name The buddy's screenname | |
611 * @param group The group to look in | |
612 * @return The buddy or NULL if the buddy does not exist in the group | |
613 */ | |
614 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, | |
615 GaimGroup *group); | |
616 | |
617 /** | |
618 * Finds all GaimBuddy structs given a screenname and an account | |
619 * | |
620 * @param account The account this buddy belongs to | |
14752
4124030c3f3a
[gaim-migrate @ 17509]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
14491
diff
changeset
|
621 * @param name The buddy's screenname (or NULL to return all buddies in the account) |
14192 | 622 * |
623 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist | |
624 */ | |
625 GSList *gaim_find_buddies(GaimAccount *account, const char *name); | |
626 | |
627 | |
628 /** | |
629 * Finds a group by name | |
630 * | |
631 * @param name The groups name | |
632 * @return The group or NULL if the group does not exist | |
633 */ | |
634 GaimGroup *gaim_find_group(const char *name); | |
635 | |
636 /** | |
637 * Finds a chat by name. | |
638 * | |
639 * @param account The chat's account. | |
640 * @param name The chat's name. | |
641 * | |
642 * @return The chat, or @c NULL if the chat does not exist. | |
643 */ | |
644 GaimChat *gaim_blist_find_chat(GaimAccount *account, const char *name); | |
645 | |
646 /** | |
647 * Returns the group of which the chat is a member. | |
648 * | |
649 * @param chat The chat. | |
650 * | |
651 * @return The parent group, or @c NULL if the chat is not in a group. | |
652 */ | |
653 GaimGroup *gaim_chat_get_group(GaimChat *chat); | |
654 | |
655 /** | |
656 * Returns the group of which the buddy is a member. | |
657 * | |
658 * @param buddy The buddy | |
659 * @return The group or NULL if the buddy is not in a group | |
660 */ | |
661 GaimGroup *gaim_buddy_get_group(GaimBuddy *buddy); | |
662 | |
663 | |
664 /** | |
665 * Returns a list of accounts that have buddies in this group | |
666 * | |
667 * @param g The group | |
668 * | |
669 * @return A list of gaim_accounts | |
670 */ | |
671 GSList *gaim_group_get_accounts(GaimGroup *g); | |
672 | |
673 /** | |
674 * Determines whether an account owns any buddies in a given group | |
675 * | |
676 * @param g The group to search through. | |
677 * @param account The account. | |
678 * | |
679 * @return TRUE if there are any buddies in the group, or FALSE otherwise. | |
680 */ | |
681 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); | |
682 | |
683 /** | |
684 * Called when an account gets signed on. Tells the UI to update all the | |
685 * buddies. | |
686 * | |
687 * @param account The account | |
688 */ | |
689 void gaim_blist_add_account(GaimAccount *account); | |
690 | |
691 | |
692 /** | |
693 * Called when an account gets signed off. Sets the presence of all the buddies to 0 | |
694 * and tells the UI to update them. | |
695 * | |
696 * @param account The account | |
697 */ | |
698 void gaim_blist_remove_account(GaimAccount *account); | |
699 | |
700 | |
701 /** | |
702 * Determines the total size of a group | |
703 * | |
704 * @param group The group | |
705 * @param offline Count buddies in offline accounts | |
706 * @return The number of buddies in the group | |
707 */ | |
708 int gaim_blist_get_group_size(GaimGroup *group, gboolean offline); | |
709 | |
710 /** | |
711 * Determines the number of online buddies in a group | |
712 * | |
713 * @param group The group | |
714 * @return The number of online buddies in the group, or 0 if the group is NULL | |
715 */ | |
716 int gaim_blist_get_group_online_count(GaimGroup *group); | |
717 | |
718 /*@}*/ | |
719 | |
720 /****************************************************************************************/ | |
721 /** @name Buddy list file management API */ | |
722 /****************************************************************************************/ | |
723 | |
724 /** | |
725 * Loads the buddy list from ~/.gaim/blist.xml. | |
726 */ | |
727 void gaim_blist_load(void); | |
728 | |
729 /** | |
730 * Schedule a save of the blist.xml file. This is used by the privacy | |
731 * API whenever the privacy settings are changed. If you make a change | |
732 * to blist.xml using one of the functions in the buddy list API, then | |
733 * the buddy list is saved automatically, so you should not need to | |
734 * call this. | |
735 */ | |
736 void gaim_blist_schedule_save(void); | |
737 | |
738 /** | |
739 * Requests from the user information needed to add a buddy to the | |
740 * buddy list. | |
741 * | |
742 * @param account The account the buddy is added to. | |
743 * @param username The username of the buddy. | |
744 * @param group The name of the group to place the buddy in. | |
745 * @param alias The optional alias for the buddy. | |
746 */ | |
747 void gaim_blist_request_add_buddy(GaimAccount *account, const char *username, | |
748 const char *group, const char *alias); | |
749 | |
750 /** | |
751 * Requests from the user information needed to add a chat to the | |
752 * buddy list. | |
753 * | |
754 * @param account The account the buddy is added to. | |
755 * @param group The optional group to add the chat to. | |
756 * @param alias The optional alias for the chat. | |
757 * @param name The required chat name. | |
758 */ | |
759 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, | |
760 const char *alias, const char *name); | |
761 | |
762 /** | |
763 * Requests from the user information needed to add a group to the | |
764 * buddy list. | |
765 */ | |
766 void gaim_blist_request_add_group(void); | |
767 | |
768 /** | |
769 * Associates a boolean with a node in the buddy list | |
770 * | |
771 * @param node The node to associate the data with | |
772 * @param key The identifier for the data | |
773 * @param value The value to set | |
774 */ | |
775 void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value); | |
776 | |
777 /** | |
778 * Retrieves a named boolean setting from a node in the buddy list | |
779 * | |
780 * @param node The node to retrieve the data from | |
781 * @param key The identifier of the data | |
782 * | |
783 * @return The value, or FALSE if there is no setting | |
784 */ | |
785 gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key); | |
786 | |
787 /** | |
788 * Associates an integer with a node in the buddy list | |
789 * | |
790 * @param node The node to associate the data with | |
791 * @param key The identifier for the data | |
792 * @param value The value to set | |
793 */ | |
794 void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value); | |
795 | |
796 /** | |
797 * Retrieves a named integer setting from a node in the buddy list | |
798 * | |
799 * @param node The node to retrieve the data from | |
800 * @param key The identifier of the data | |
801 * | |
802 * @return The value, or 0 if there is no setting | |
803 */ | |
804 int gaim_blist_node_get_int(GaimBlistNode *node, const char *key); | |
805 | |
806 /** | |
807 * Associates a string with a node in the buddy list | |
808 * | |
809 * @param node The node to associate the data with | |
810 * @param key The identifier for the data | |
811 * @param value The value to set | |
812 */ | |
813 void gaim_blist_node_set_string(GaimBlistNode *node, const char *key, | |
814 const char *value); | |
815 | |
816 /** | |
817 * Retrieves a named string setting from a node in the buddy list | |
818 * | |
819 * @param node The node to retrieve the data from | |
820 * @param key The identifier of the data | |
821 * | |
822 * @return The value, or NULL if there is no setting | |
823 */ | |
824 const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key); | |
825 | |
826 /** | |
827 * Removes a named setting from a blist node | |
828 * | |
829 * @param node The node from which to remove the setting | |
830 * @param key The name of the setting | |
831 */ | |
832 void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key); | |
833 | |
834 /** | |
835 * Set the flags for the given node. Setting a node's flags will overwrite | |
836 * the old flags, so if you want to save them, you must first call | |
837 * gaim_blist_node_get_flags and modify that appropriately. | |
838 * | |
839 * @param node The node on which to set the flags. | |
840 * @param flags The flags to set. This is a bitmask. | |
841 */ | |
842 void gaim_blist_node_set_flags(GaimBlistNode *node, GaimBlistNodeFlags flags); | |
843 | |
844 /** | |
845 * Get the current flags on a given node. | |
846 * | |
847 * @param node The node from which to get the flags. | |
848 * | |
849 * @return The flags on the node. This is a bitmask. | |
850 */ | |
851 GaimBlistNodeFlags gaim_blist_node_get_flags(GaimBlistNode *node); | |
852 | |
853 /*@}*/ | |
854 | |
855 /** | |
856 * Retrieves the extended menu items for a buddy list node. | |
857 * @param n The blist node for which to obtain the extended menu items. | |
858 * @return A list of GaimMenuAction items, as harvested by the | |
859 * blist-node-extended-menu signal. | |
860 */ | |
861 GList *gaim_blist_node_get_extended_menu(GaimBlistNode *n); | |
862 | |
863 /**************************************************************************/ | |
864 /** @name UI Registration Functions */ | |
865 /**************************************************************************/ | |
866 /*@{*/ | |
867 | |
868 /** | |
869 * Sets the UI operations structure to be used for the buddy list. | |
870 * | |
871 * @param ops The ops struct. | |
872 */ | |
873 void gaim_blist_set_ui_ops(GaimBlistUiOps *ops); | |
874 | |
875 /** | |
876 * Returns the UI operations structure to be used for the buddy list. | |
877 * | |
878 * @return The UI operations structure. | |
879 */ | |
880 GaimBlistUiOps *gaim_blist_get_ui_ops(void); | |
881 | |
882 /*@}*/ | |
883 | |
884 /**************************************************************************/ | |
885 /** @name Buddy List Subsystem */ | |
886 /**************************************************************************/ | |
887 /*@{*/ | |
888 | |
889 /** | |
890 * Returns the handle for the buddy list subsystem. | |
891 * | |
892 * @return The buddy list subsystem handle. | |
893 */ | |
894 void *gaim_blist_get_handle(void); | |
895 | |
896 /** | |
897 * Initializes the buddy list subsystem. | |
898 */ | |
899 void gaim_blist_init(void); | |
900 | |
901 /** | |
902 * Uninitializes the buddy list subsystem. | |
903 */ | |
904 void gaim_blist_uninit(void); | |
905 | |
906 /*@}*/ | |
907 | |
908 #ifdef __cplusplus | |
909 } | |
910 #endif | |
911 | |
912 #endif /* _GAIM_BLIST_H_ */ |