Mercurial > pidgin
annotate src/blist.h @ 6078:87714ede9264
[gaim-migrate @ 6537]
Path corrections
committer: Tailor Script <tailor@pidgin.im>
author | Herman Bloggs <hermanator12002@yahoo.com> |
---|---|
date | Thu, 10 Jul 2003 23:29:10 +0000 |
parents | 5239a3b4ab33 |
children | 9083f92e0d58 |
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> | |
8 * | |
9 * This program is free software; you can redistribute it and/or modify | |
10 * it under the terms of the GNU General Public License as published by | |
11 * the Free Software Foundation; either version 2 of the License, or | |
12 * (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, | |
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 * GNU General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU General Public License | |
20 * along with this program; if not, write to the Free Software | |
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
22 */ | |
23 | |
24 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */ | |
25 | |
26 #ifndef _LIST_H_ | |
27 #define _LIST_H_ | |
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 |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
33 /* TODO Namespace these! */ |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
34 struct chat; |
5794
5e93fc46d1af
[gaim-migrate @ 6219]
Christian Hammond <chipx86@chipx86.com>
parents:
5758
diff
changeset
|
35 struct buddy; |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
36 |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
37 #include "account.h" |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
38 |
5228 | 39 /**************************************************************************/ |
40 /* Enumerations */ | |
41 /**************************************************************************/ | |
42 enum gaim_blist_node_type { | |
43 GAIM_BLIST_GROUP_NODE, | |
44 GAIM_BLIST_BUDDY_NODE, | |
5234 | 45 GAIM_BLIST_CHAT_NODE, |
6063 | 46 GAIM_BLIST_OTHER_NODE |
5228 | 47 }; |
48 | |
5234 | 49 #define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE) |
5228 | 50 #define GAIM_BLIST_NODE_IS_BUDDY(n) ((n)->type == GAIM_BLIST_BUDDY_NODE) |
51 #define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE) | |
52 | |
53 enum gaim_buddy_presence_state { | |
54 GAIM_BUDDY_SIGNING_OFF = -1, | |
55 GAIM_BUDDY_OFFLINE = 0, | |
56 GAIM_BUDDY_ONLINE, | |
6063 | 57 GAIM_BUDDY_SIGNING_ON |
5228 | 58 }; |
59 | |
60 #define GAIM_BUDDY_IS_ONLINE(b) ((b)->present == GAIM_BUDDY_ONLINE || \ | |
61 (b)->present == GAIM_BUDDY_SIGNING_ON) | |
62 | |
63 | |
64 /**************************************************************************/ | |
65 /* Data Structures */ | |
66 /**************************************************************************/ | |
67 | |
68 /** | |
69 * A Buddy list node. This can represent a group, a buddy, or anything else. This is a base class for struct buddy and | |
70 * struct group and for anything else that wants to put itself in the buddy list. */ | |
71 struct _GaimBlistNode { | |
72 enum gaim_blist_node_type type; /**< The type of node this is */ | |
73 GaimBlistNode *prev; /**< The sibling before this buddy. */ | |
74 GaimBlistNode *next; /**< The sibling after this buddy. */ | |
75 GaimBlistNode *parent; /**< The parent of this node */ | |
76 GaimBlistNode *child; /**< The child of this node */ | |
77 void *ui_data; /**< The UI can put data here. */ | |
78 }; | |
79 | |
80 /** | |
81 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
82 */ | |
83 struct buddy { | |
84 GaimBlistNode node; /**< The node that this buddy inherits from */ | |
85 char *name; /**< The screenname of the buddy. */ | |
86 char *alias; /**< The user-set alias of the buddy */ | |
87 char *server_alias; /**< The server-specified alias of the buddy. (i.e. MSN "Friendly Names") */ | |
88 enum gaim_buddy_presence_state present; /**< This is 0 if the buddy appears offline, 1 if he appears online, and 2 if | |
89 he has recently signed on */ | |
90 int evil; /**< The warning level */ | |
91 time_t signon; /**< The time the buddy signed on. */ | |
92 int idle; /**< The time the buddy has been idle in minutes. */ | |
93 int uc; /**< This is a cryptic bitmask that makes sense only to the prpl. This will get changed */ | |
94 void *proto_data; /**< This allows the prpl to associate whatever data it wants with a buddy */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
95 GaimAccount *account; /**< the account this buddy belongs to */ |
5228 | 96 GHashTable *settings; /**< per-buddy settings from the XML buddy list, set by plugins and the likes. */ |
97 guint timer; /**< The timer handle. */ | |
98 }; | |
99 | |
100 /** | |
101 * A group. This contains everything Gaim will ever need to know about a group. | |
102 */ | |
103 struct group { | |
104 GaimBlistNode node; /**< The node that this group inherits from */ | |
105 char *name; /**< The name of this group. */ | |
5277 | 106 int totalsize; /**< The number of buddies in this group */ |
107 int currentsize; /**< The number of buddies in this group corresponding to online accounts */ | |
108 int online; /**< The number of buddies in this group who are currently online */ | |
5228 | 109 GHashTable *settings; /**< per-group settings from the XML buddy list, set by plugins and the likes. */ |
110 }; | |
111 | |
5234 | 112 /** |
113 * A group. This contains everything Gaim needs to put a chat room in the | |
114 * buddy list. | |
115 */ | |
116 struct chat { | |
117 GaimBlistNode node; /**< The node that this chat inherits from */ | |
118 char *alias; /**< The display name of this chat. */ | |
119 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
|
120 GaimAccount *account; /**< The account this chat is attached to */ |
5906 | 121 GHashTable *settings; /**< per-chat settings from the XML buddy list, set by plugins and the likes. */ |
5234 | 122 }; |
123 | |
5228 | 124 |
125 /** | |
126 * The Buddy List | |
127 */ | |
128 struct gaim_buddy_list { | |
129 GaimBlistNode *root; /**< The first node in the buddy list */ | |
5247 | 130 GHashTable *buddies; /**< Every buddy in this list */ |
5228 | 131 struct gaim_blist_ui_ops *ui_ops; /**< The UI operations for the buddy list */ |
132 | |
133 void *ui_data; /**< UI-specific data. */ | |
134 }; | |
135 | |
136 /** | |
137 * Buddy list UI operations. | |
138 * | |
139 * Any UI representing a buddy list must assign a filled-out gaim_window_ops | |
140 * structure to the buddy list core. | |
141 */ | |
142 struct gaim_blist_ui_ops | |
143 { | |
144 void (*new_list)(struct gaim_buddy_list *list); /**< Sets UI-specific data on a buddy list. */ | |
145 void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */ | |
146 void (*show)(struct gaim_buddy_list *list); /**< The core will call this when its finished doing it's core stuff */ | |
147 void (*update)(struct gaim_buddy_list *list, | |
148 GaimBlistNode *node); /**< This will update a node in the buddy list. */ | |
149 void (*remove)(struct gaim_buddy_list *list, | |
150 GaimBlistNode *node); /**< This removes a node from the list */ | |
151 void (*destroy)(struct gaim_buddy_list *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ | |
152 void (*set_visible)(struct gaim_buddy_list *list, | |
153 gboolean show); /**< Hides or unhides the buddy list */ | |
154 | |
155 }; | |
156 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
157 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
158 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
159 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
160 |
5228 | 161 /**************************************************************************/ |
162 /** @name Buddy List API */ | |
163 /**************************************************************************/ | |
164 /*@{*/ | |
165 | |
166 /** | |
167 * Creates a new buddy list | |
168 */ | |
169 struct gaim_buddy_list *gaim_blist_new(); | |
170 | |
171 /** | |
172 * Sets the main buddy list. | |
173 * | |
174 * @return The main buddy list. | |
175 */ | |
176 void gaim_set_blist(struct gaim_buddy_list *blist); | |
177 | |
178 /** | |
179 * Returns the main buddy list. | |
180 * | |
181 * @return The main buddy list. | |
182 */ | |
183 struct gaim_buddy_list *gaim_get_blist(void); | |
184 | |
185 /** | |
186 * Shows the buddy list, creating a new one if necessary. | |
187 * | |
188 */ | |
189 void gaim_blist_show(); | |
190 | |
191 | |
192 /** | |
193 * Destroys the buddy list window. | |
194 */ | |
195 void gaim_blist_destroy(); | |
196 | |
197 /** | |
198 * Hides or unhides the buddy list. | |
199 * | |
200 * @param show Whether or not to show the buddy list | |
201 */ | |
202 void gaim_blist_set_visible(gboolean show); | |
203 | |
204 /** | |
205 * Updates a buddy's status. | |
5234 | 206 * |
5228 | 207 * This needs to not take an int. |
208 * | |
209 * @param buddy The buddy whose status has changed | |
210 * @param status The new status in cryptic prpl-understood code | |
211 */ | |
212 void gaim_blist_update_buddy_status(struct buddy *buddy, int status); | |
213 | |
214 | |
215 /** | |
216 * Updates a buddy's presence. | |
217 * | |
218 * @param buddy The buddy whose presence has changed | |
219 * @param presence The new presence | |
220 */ | |
221 void gaim_blist_update_buddy_presence(struct buddy *buddy, int presence); | |
222 | |
223 | |
224 /** | |
225 * Updates a buddy's idle time. | |
226 * | |
227 * @param buddy The buddy whose idle time has changed | |
228 * @param idle The buddy's idle time in minutes. | |
229 */ | |
230 void gaim_blist_update_buddy_idle(struct buddy *buddy, int idle); | |
231 | |
232 | |
233 /** | |
234 * Updates a buddy's warning level. | |
235 * | |
236 * @param buddy The buddy whose warning level has changed | |
237 * @param evil The warning level as an int from 0 to 100 (or higher, I guess... but that'd be weird) | |
238 */ | |
239 void gaim_blist_update_buddy_evil(struct buddy *buddy, int warning); | |
240 | |
241 /** | |
242 * Updates a buddy's icon. | |
243 * | |
244 * @param buddy The buddy whose buddy icon has changed | |
245 */ | |
246 void gaim_blist_update_buddy_icon(struct buddy *buddy); | |
247 | |
248 | |
249 | |
250 /** | |
251 * Renames a buddy in the buddy list. | |
252 * | |
253 * @param buddy The buddy whose name will be changed. | |
254 * @param name The new name of the buddy. | |
255 */ | |
256 void gaim_blist_rename_buddy(struct buddy *buddy, const char *name); | |
257 | |
258 | |
259 /** | |
260 * Aliases a buddy in the buddy list. | |
261 * | |
262 * @param buddy The buddy whose alias will be changed. | |
263 * @param alias The buddy's alias. | |
264 */ | |
265 void gaim_blist_alias_buddy(struct buddy *buddy, const char *alias); | |
266 | |
5234 | 267 /** |
6059 | 268 * Sets the server-sent alias of a buddy in the buddy list. |
6058 | 269 * |
270 * @param buddy The buddy whose alias will be changed. | |
271 * @param alias The buddy's "official" alias. | |
272 */ | |
273 void gaim_blist_server_alias_buddy(struct buddy *buddy, const char *alias); | |
274 | |
275 /** | |
5234 | 276 * Aliases a chat in the buddy list. |
277 * | |
278 * @param chat The chat whose alias will be changed. | |
279 * @param alias The chat's new alias. | |
280 */ | |
281 void gaim_blist_alias_chat(struct chat *chat, const char *alias); | |
5228 | 282 |
283 /** | |
284 * Renames a group | |
285 * | |
286 * @param group The group to rename | |
287 * @param name The new name | |
288 */ | |
289 void gaim_blist_rename_group(struct group *group, const char *name); | |
290 | |
5234 | 291 /** |
292 * Creates a new chat for the buddy list | |
293 * | |
294 * @param account The account this chat will get added to | |
295 * @param alias The alias of the new chat | |
296 * @param components The info the prpl needs to join the chat | |
297 * @return A newly allocated chat | |
298 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
299 struct chat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); |
5234 | 300 |
301 /** | |
6034 | 302 * Gets the alias of the chat, or the chat name if the alias does not exist |
303 * | |
304 * @param chat The chat | |
305 * @return The display name of the chat | |
306 */ | |
6036 | 307 char *gaim_chat_get_display_name(struct chat *chat); |
6034 | 308 |
309 /** | |
5234 | 310 * Adds a new chat to the buddy list. |
311 * | |
312 * The chat will be inserted right after node or appended to the end | |
313 * of group if node is NULL. If both are NULL, the buddy will be added to | |
314 * the "Chats" group. | |
315 * | |
316 * @param chat The new chat who gets added | |
317 * @param group The group to add the new chat to. | |
318 * @param node The insertion point | |
319 */ | |
320 void gaim_blist_add_chat(struct chat *chat, struct group *group, GaimBlistNode *node); | |
5228 | 321 |
322 /** | |
323 * Creates a new buddy | |
324 * | |
325 * @param account The account this buddy will get added to | |
326 * @param screenname The screenname of the new buddy | |
327 * @param alias The alias of the new buddy (or NULL if unaliased) | |
328 * @return A newly allocated buddy | |
329 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
330 struct buddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); |
5228 | 331 |
332 /** | |
333 * Adds a new buddy to the buddy list. | |
334 * | |
335 * The buddy will be inserted right after node or appended to the end | |
336 * of group if node is NULL. If both are NULL, the buddy will be added to | |
337 * the "Buddies" group. | |
338 * | |
339 * @param buddy The new buddy who gets added | |
340 * @param group The group to add the new buddy to. | |
341 * @param node The insertion point | |
342 */ | |
343 void gaim_blist_add_buddy(struct buddy *buddy, struct group *group, GaimBlistNode *node); | |
344 | |
345 /** | |
346 * Creates a new group | |
347 * | |
348 * You can't have more than one group with the same name. Sorry. If you pass this the | |
349 * name of a group that already exists, it will return that group. | |
350 * | |
351 * @param name The name of the new group | |
352 * @return A new group struct | |
353 */ | |
354 struct group *gaim_group_new(const char *name); | |
355 | |
356 /** | |
357 * Adds a new group to the buddy list. | |
358 * | |
359 * The new group will be inserted after insert or appended to the end of | |
360 * the list if node is NULL. | |
361 * | |
362 * @param group The group to add the new buddy to. | |
363 * @param node The insertion point | |
364 */ | |
365 void gaim_blist_add_group(struct group *group, GaimBlistNode *node); | |
366 | |
367 /** | |
368 * Removes a buddy from the buddy list and frees the memory allocated to it. | |
369 * | |
370 * @param buddy The buddy to be removed | |
371 */ | |
372 void gaim_blist_remove_buddy(struct buddy *buddy); | |
373 | |
374 /** | |
5234 | 375 * Removes a chat from the buddy list and frees the memory allocated to it. |
376 * | |
377 * @param chat The chat to be removed | |
378 */ | |
379 void gaim_blist_remove_chat(struct chat *chat); | |
380 | |
381 /** | |
5228 | 382 * Removes a group from the buddy list and frees the memory allocated to it and to |
383 * its children | |
384 * | |
385 * @param group The group to be removed | |
386 */ | |
387 void gaim_blist_remove_group(struct group *group); | |
388 | |
389 /** | |
390 * Returns the alias of a buddy. | |
391 * | |
392 * @param buddy The buddy whose name will be returned. | |
393 * @return The alias (if set), server alias (if option is set), or NULL. | |
394 */ | |
395 char *gaim_get_buddy_alias_only(struct buddy *buddy); | |
396 | |
397 | |
398 /** | |
399 * Returns the correct name to display for a buddy. | |
400 * | |
401 * @param buddy The buddy whose name will be returned. | |
402 * @return The alias (if set), server alias (if option is set), screenname, or "Unknown" | |
403 */ | |
404 char *gaim_get_buddy_alias(struct buddy *buddy); | |
405 | |
406 /** | |
407 * Finds the buddy struct given a screenname and an account | |
408 * | |
5758 | 409 * @param name The buddy's screenname or NULL to search for more buddies with the same screenname |
410 * as the previous search | |
5228 | 411 * @param account The account this buddy belongs to |
412 * @return The buddy or NULL if the buddy does not exist | |
413 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
414 struct buddy *gaim_find_buddy(GaimAccount *account, const char *name); |
5228 | 415 |
416 /** | |
417 * Finds a group by name | |
418 * | |
419 * @param name The groups name | |
420 * @return The group or NULL if the group does not exist | |
421 */ | |
422 struct group *gaim_find_group(const char *name); | |
423 | |
424 /** | |
425 * Returns the group of which the buddy is a member. | |
426 * | |
427 * @param buddy The buddy | |
428 * @return The group or NULL if the buddy is not in a group | |
429 */ | |
430 struct group *gaim_find_buddys_group(struct buddy *buddy); | |
431 | |
432 | |
433 /** | |
434 * Returns a list of accounts that have buddies in this group | |
435 * | |
436 * @param group The group | |
437 * @return A list of gaim_accounts | |
438 */ | |
439 GSList *gaim_group_get_accounts(struct group *g); | |
440 | |
441 /** | |
442 * Determines whether an account owns any buddies in a given group | |
443 * | |
444 * @param g The group to search through. | |
445 * @param account The account. | |
446 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
447 gboolean gaim_group_on_account(struct group *g, GaimAccount *account); |
5228 | 448 |
449 /** | |
5234 | 450 * Called when an account gets signed on. Tells the UI to update all the |
451 * buddies. | |
452 * | |
453 * @param account The account | |
454 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
455 void gaim_blist_add_account(GaimAccount *account); |
5234 | 456 |
457 | |
458 /** | |
5228 | 459 * Called when an account gets signed off. Sets the presence of all the buddies to 0 |
460 * and tells the UI to update them. | |
461 * | |
462 * @param account The account | |
463 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
464 void gaim_blist_remove_account(GaimAccount *account); |
5228 | 465 |
466 | |
467 /** | |
468 * Determines the total size of a group | |
469 * | |
470 * @param group The group | |
471 * @param offline Count buddies in offline accounts | |
472 * @return The number of buddies in the group | |
473 */ | |
474 int gaim_blist_get_group_size(struct group *group, gboolean offline); | |
475 | |
476 /** | |
477 * Determines the number of online buddies in a group | |
478 * | |
479 * @param group The group | |
480 * @return The number of online buddies in the group, or 0 if the group is NULL | |
481 */ | |
482 int gaim_blist_get_group_online_count(struct group *group); | |
483 | |
484 /*@}*/ | |
485 | |
486 /****************************************************************************************/ | |
487 /** @name Buddy list file management API */ | |
488 /****************************************************************************************/ | |
489 | |
490 /*@{*/ | |
491 /** | |
492 * Saves the buddy list to file | |
493 */ | |
494 void gaim_blist_save(); | |
495 | |
496 /** | |
497 * Parses the toc-style buddy list used in older versions of Gaim and for SSI in toc.c | |
498 * | |
499 * @param account This is the account that the buddies and groups from config will get added to | |
500 * @param config This is the toc-style buddy list data | |
501 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
502 void parse_toc_buddy_list(GaimAccount *account, char *config); |
5228 | 503 |
504 | |
505 /** | |
506 * Loads the buddy list from ~/.gaim/blist.xml. | |
507 */ | |
508 void gaim_blist_load(); | |
509 | |
510 /** | |
511 * Associates some data with the group in the xml buddy list | |
512 * | |
513 * @param g The group the data is associated with | |
514 * @param key The key used to retrieve the data | |
515 * @param value The data to set | |
516 */ | |
517 void gaim_group_set_setting(struct group *g, const char *key, const char *value); | |
518 | |
519 /** | |
520 * Retrieves data from the XML buddy list set by gaim_group_set_setting()) | |
521 * | |
522 * @param g The group to retrieve data from | |
523 * @param key The key to retrieve the data with | |
524 * @return The associated data or NULL if no data is associated | |
525 */ | |
526 char *gaim_group_get_setting(struct group *g, const char *key); | |
527 | |
5906 | 528 /** |
529 * Associates some data with the chat in the xml buddy list | |
530 * | |
531 * @param b The chat the data is associated with | |
532 * @param key The key used to retrieve the data | |
533 * @param value The data to set | |
534 */ | |
535 void gaim_chat_set_setting(struct chat *c, const char *key, const char *value); | |
536 | |
537 /** | |
538 * Retrieves data from the XML buddy list set by gaim_chat_set_setting()) | |
539 * | |
540 * @param b The chat to retrieve data from | |
541 * @param key The key to retrieve the data with | |
542 * @return The associated data or NULL if no data is associated | |
543 */ | |
544 char *gaim_chat_get_setting(struct chat *c, const char *key); | |
5228 | 545 |
546 /** | |
547 * Associates some data with the buddy in the xml buddy list | |
548 * | |
549 * @param b The buddy the data is associated with | |
550 * @param key The key used to retrieve the data | |
551 * @param value The data to set | |
552 */ | |
553 void gaim_buddy_set_setting(struct buddy *b, const char *key, const char *value); | |
554 | |
555 /** | |
556 * Retrieves data from the XML buddy list set by gaim_buddy_set_setting()) | |
557 * | |
558 * @param b The buddy to retrieve data from | |
559 * @param key The key to retrieve the data with | |
560 * @return The associated data or NULL if no data is associated | |
561 */ | |
562 char *gaim_buddy_get_setting(struct buddy *b, const char *key); | |
563 | |
564 /*@}*/ | |
565 | |
566 /**************************************************************************/ | |
567 /** @name UI Registration Functions */ | |
568 /**************************************************************************/ | |
569 /*@{*/ | |
570 | |
571 /** | |
572 * Sets the UI operations structure to be used for the buddy list. | |
573 * | |
574 * @param ops The ops struct. | |
575 */ | |
576 void gaim_set_blist_ui_ops(struct gaim_blist_ui_ops *ops); | |
577 | |
578 /** | |
579 * Returns the UI operations structure to be used for the buddy list. | |
580 * | |
581 * @return The UI operations structure. | |
582 */ | |
583 struct gaim_blist_ui_ops *gaim_get_blist_ui_ops(void); | |
584 | |
585 /*@}*/ | |
586 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
587 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
588 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
589 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
590 |
5228 | 591 #endif /* _LIST_H_ */ |