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