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