Mercurial > pidgin.yaz
annotate src/blist.h @ 7826:5ba07997ade3
[gaim-migrate @ 8478]
there's no need to keep this around
committer: Tailor Script <tailor@pidgin.im>
author | Nathan Walp <nwalp@pidgin.im> |
---|---|
date | Wed, 10 Dec 2003 07:37:13 +0000 |
parents | 02cb9284782e |
children | e873d0bd0e6c |
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 |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
35 typedef struct _GaimChat GaimChat; |
6695 | 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 */ |
7693 | 88 GHashTable *settings; /**< per-node settings */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
89 void *ui_data; /**< The UI can put data here. */ |
5228 | 90 }; |
91 | |
92 /** | |
93 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
94 */ | |
6695 | 95 struct _GaimBuddy { |
5228 | 96 GaimBlistNode node; /**< The node that this buddy inherits from */ |
97 char *name; /**< The screenname of the buddy. */ | |
98 char *alias; /**< The user-set alias of the buddy */ | |
6695 | 99 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
|
100 GaimBuddyPresenceState present; /**< This is 0 if the buddy appears offline, 1 if he appears online, and 2 if |
5228 | 101 he has recently signed on */ |
102 int evil; /**< The warning level */ | |
103 time_t signon; /**< The time the buddy signed on. */ | |
104 int idle; /**< The time the buddy has been idle in minutes. */ | |
105 int uc; /**< This is a cryptic bitmask that makes sense only to the prpl. This will get changed */ | |
106 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
|
107 GaimBuddyIcon *icon; /**< The buddy icon. */ |
6695 | 108 GaimAccount *account; /**< the account this buddy belongs to */ |
5228 | 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 }; |
135 | |
5234 | 136 /** |
6695 | 137 * A chat. This contains everything Gaim needs to put a chat room in the |
5234 | 138 * buddy list. |
139 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
140 struct _GaimChat { |
5234 | 141 GaimBlistNode node; /**< The node that this chat inherits from */ |
142 char *alias; /**< The display name of this chat. */ | |
143 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
|
144 GaimAccount *account; /**< The account this chat is attached to */ |
5234 | 145 }; |
146 | |
5228 | 147 |
148 /** | |
149 * The Buddy List | |
150 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
151 struct _GaimBuddyList { |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
152 GaimBlistNode *root; /**< The first node in the buddy list */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
153 GHashTable *buddies; /**< Every buddy in this list */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
154 GaimBlistUiOps *ui_ops; /**< The UI operations for the buddy list */ |
5228 | 155 |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
156 void *ui_data; /**< UI-specific data. */ |
5228 | 157 }; |
158 | |
159 /** | |
160 * Buddy list UI operations. | |
161 * | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
162 * Any UI representing a buddy list must assign a filled-out gaim_conv_window_ops |
5228 | 163 * structure to the buddy list core. |
164 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
165 struct _GaimBlistUiOps |
5228 | 166 { |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
167 void (*new_list)(GaimBuddyList *list); /**< Sets UI-specific data on a buddy list. */ |
5228 | 168 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
|
169 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
|
170 void (*update)(GaimBuddyList *list, |
5228 | 171 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
|
172 void (*remove)(GaimBuddyList *list, |
5228 | 173 GaimBlistNode *node); /**< This removes a node from the list */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
174 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
|
175 void (*set_visible)(GaimBuddyList *list, |
5228 | 176 gboolean show); /**< Hides or unhides the buddy list */ |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
177 void (*request_add_buddy)(GaimAccount *account, const char *username, |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
178 const char *group, const char *alias); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
179 void (*request_add_chat)(GaimAccount *account, GaimGroup *group); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
180 void (*request_add_group)(void); |
5228 | 181 }; |
182 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
183 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
184 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
185 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
186 |
5228 | 187 /**************************************************************************/ |
188 /** @name Buddy List API */ | |
189 /**************************************************************************/ | |
190 /*@{*/ | |
191 | |
192 /** | |
193 * Creates a new buddy list | |
194 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
195 GaimBuddyList *gaim_blist_new(); |
5228 | 196 |
197 /** | |
198 * Sets the main buddy list. | |
199 * | |
200 * @return The main buddy list. | |
201 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
202 void gaim_set_blist(GaimBuddyList *blist); |
5228 | 203 |
204 /** | |
205 * Returns the main buddy list. | |
206 * | |
207 * @return The main buddy list. | |
208 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
209 GaimBuddyList *gaim_get_blist(void); |
5228 | 210 |
211 /** | |
212 * Shows the buddy list, creating a new one if necessary. | |
213 * | |
214 */ | |
215 void gaim_blist_show(); | |
216 | |
217 | |
218 /** | |
219 * Destroys the buddy list window. | |
220 */ | |
221 void gaim_blist_destroy(); | |
222 | |
223 /** | |
224 * Hides or unhides the buddy list. | |
225 * | |
226 * @param show Whether or not to show the buddy list | |
227 */ | |
228 void gaim_blist_set_visible(gboolean show); | |
229 | |
230 /** | |
231 * Updates a buddy's status. | |
5234 | 232 * |
5228 | 233 * This needs to not take an int. |
234 * | |
235 * @param buddy The buddy whose status has changed | |
236 * @param status The new status in cryptic prpl-understood code | |
237 */ | |
6695 | 238 void gaim_blist_update_buddy_status(GaimBuddy *buddy, int status); |
5228 | 239 |
240 | |
241 /** | |
242 * Updates a buddy's presence. | |
243 * | |
244 * @param buddy The buddy whose presence has changed | |
245 * @param presence The new presence | |
246 */ | |
6695 | 247 void gaim_blist_update_buddy_presence(GaimBuddy *buddy, int presence); |
5228 | 248 |
249 | |
250 /** | |
251 * Updates a buddy's idle time. | |
252 * | |
253 * @param buddy The buddy whose idle time has changed | |
254 * @param idle The buddy's idle time in minutes. | |
255 */ | |
6695 | 256 void gaim_blist_update_buddy_idle(GaimBuddy *buddy, int idle); |
5228 | 257 |
258 | |
259 /** | |
260 * Updates a buddy's warning level. | |
261 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
262 * @param buddy The buddy whose warning level has changed. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
263 * @param warning The warning level as an int from 0 to 100. |
5228 | 264 */ |
6695 | 265 void gaim_blist_update_buddy_evil(GaimBuddy *buddy, int warning); |
5228 | 266 |
267 /** | |
268 * Updates a buddy's icon. | |
269 * | |
270 * @param buddy The buddy whose buddy icon has changed | |
271 */ | |
6695 | 272 void gaim_blist_update_buddy_icon(GaimBuddy *buddy); |
5228 | 273 |
274 /** | |
275 * Renames a buddy in the buddy list. | |
276 * | |
277 * @param buddy The buddy whose name will be changed. | |
278 * @param name The new name of the buddy. | |
279 */ | |
6695 | 280 void gaim_blist_rename_buddy(GaimBuddy *buddy, const char *name); |
5228 | 281 |
282 | |
283 /** | |
284 * Aliases a buddy in the buddy list. | |
285 * | |
286 * @param buddy The buddy whose alias will be changed. | |
287 * @param alias The buddy's alias. | |
288 */ | |
6695 | 289 void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias); |
5228 | 290 |
5234 | 291 /** |
6059 | 292 * Sets the server-sent alias of a buddy in the buddy list. |
6058 | 293 * |
294 * @param buddy The buddy whose alias will be changed. | |
295 * @param alias The buddy's "official" alias. | |
296 */ | |
6695 | 297 void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias); |
6058 | 298 |
299 /** | |
5234 | 300 * Aliases a chat in the buddy list. |
301 * | |
302 * @param chat The chat whose alias will be changed. | |
303 * @param alias The chat's new alias. | |
304 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
305 void gaim_blist_alias_chat(GaimChat *chat, const char *alias); |
5228 | 306 |
307 /** | |
308 * Renames a group | |
309 * | |
310 * @param group The group to rename | |
311 * @param name The new name | |
312 */ | |
6695 | 313 void gaim_blist_rename_group(GaimGroup *group, const char *name); |
5228 | 314 |
5234 | 315 /** |
316 * Creates a new chat for the buddy list | |
317 * | |
318 * @param account The account this chat will get added to | |
319 * @param alias The alias of the new chat | |
320 * @param components The info the prpl needs to join the chat | |
321 * @return A newly allocated chat | |
322 */ | |
7125 | 323 GaimChat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); |
5234 | 324 |
325 /** | |
6034 | 326 * Gets the alias of the chat, or the chat name if the alias does not exist |
327 * | |
328 * @param chat The chat | |
329 * @return The display name of the chat | |
330 */ | |
7125 | 331 char *gaim_chat_get_display_name(GaimChat *chat); |
6034 | 332 |
333 /** | |
5234 | 334 * Adds a new chat to the buddy list. |
335 * | |
336 * The chat will be inserted right after node or appended to the end | |
337 * of group if node is NULL. If both are NULL, the buddy will be added to | |
338 * the "Chats" group. | |
339 * | |
340 * @param chat The new chat who gets added | |
341 * @param group The group to add the new chat to. | |
342 * @param node The insertion point | |
343 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
344 void gaim_blist_add_chat(GaimChat *chat, GaimGroup *group, GaimBlistNode *node); |
5228 | 345 |
346 /** | |
347 * Creates a new buddy | |
348 * | |
349 * @param account The account this buddy will get added to | |
350 * @param screenname The screenname of the new buddy | |
351 * @param alias The alias of the new buddy (or NULL if unaliased) | |
352 * @return A newly allocated buddy | |
353 */ | |
6695 | 354 GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); |
5228 | 355 |
356 /** | |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
357 * Sets a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
358 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
359 * 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
|
360 * call gaim_buddy_icon_set_data(). |
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 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
363 * @param icon The buddy 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 * @see gaim_buddy_icon_set_data() |
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 void gaim_buddy_set_icon(GaimBuddy *buddy, GaimBuddyIcon *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 /** |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
370 * Returns a buddy's icon. |
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 * @param buddy The buddy. |
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 * @return The buddy icon. |
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 GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy); |
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 /** |
7312 | 379 * Returns a buddy's contact. |
380 * | |
381 * @param buddy The buddy. | |
382 * | |
383 * @return The buddy's contact. | |
384 */ | |
385 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); | |
386 | |
387 /** | |
5228 | 388 * Adds a new buddy to the buddy list. |
389 * | |
6695 | 390 * The buddy will be inserted right after node or prepended to the |
391 * group if node is NULL. If both are NULL, the buddy will be added to | |
5228 | 392 * the "Buddies" group. |
393 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
394 * @param buddy The new buddy who gets added |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
395 * @param contact The optional contact to place the buddy in. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
396 * @param group The group to add the new buddy to. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
397 * @param node The insertion point |
5228 | 398 */ |
6695 | 399 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); |
5228 | 400 |
401 /** | |
402 * Creates a new group | |
403 * | |
6695 | 404 * You can't have more than one group with the same name. Sorry. If you pass |
405 * this the * name of a group that already exists, it will return that group. | |
5228 | 406 * |
407 * @param name The name of the new group | |
6695 | 408 * @return A new group struct |
5228 | 409 */ |
6695 | 410 GaimGroup *gaim_group_new(const char *name); |
5228 | 411 |
412 /** | |
413 * Adds a new group to the buddy list. | |
414 * | |
6695 | 415 * The new group will be inserted after insert or prepended to the list if |
416 * node is NULL. | |
417 * | |
418 * @param group The group | |
419 * @param node The insertion point | |
420 */ | |
421 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
422 | |
423 /** | |
424 * Creates a new contact | |
5228 | 425 * |
6695 | 426 * @return A new contact struct |
5228 | 427 */ |
6695 | 428 GaimContact *gaim_contact_new(); |
429 | |
430 /** | |
431 * Adds a new contact to the buddy list. | |
432 * | |
433 * The new contact will be inserted after insert or prepended to the list if | |
434 * node is NULL. | |
435 * | |
436 * @param contact The contact | |
437 * @param group The group to add the contact to | |
438 * @param node The insertion point | |
439 */ | |
440 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
441 | |
442 /** | |
6965 | 443 * Merges two contacts |
444 * | |
445 * All of the buddies from source will be moved to target | |
446 * | |
447 * @param source The contact to merge | |
7246 | 448 * @param node The place to merge to (a buddy or contact) |
6965 | 449 */ |
7246 | 450 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); |
6965 | 451 |
452 /** | |
6695 | 453 * Returns the highest priority buddy for a given contact. |
454 * | |
455 * @param contact The contact | |
456 * @return The highest priority buddy | |
457 */ | |
458 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
5228 | 459 |
460 /** | |
6755 | 461 * Sets the alias for a contact. |
462 * | |
463 * @param contact The contact | |
464 * @param alias The alias to set, or NULL to unset | |
465 */ | |
466 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
467 | |
468 /** | |
469 * Gets the alias for a contact. | |
470 * | |
471 * @param contact The contact | |
472 * @return The alias, or NULL if it is not set. | |
473 */ | |
474 const char *gaim_contact_get_alias(GaimContact *contact); | |
475 | |
476 /** | |
5228 | 477 * Removes a buddy from the buddy list and frees the memory allocated to it. |
478 * | |
479 * @param buddy The buddy to be removed | |
480 */ | |
6695 | 481 void gaim_blist_remove_buddy(GaimBuddy *buddy); |
482 | |
483 /** | |
484 * Removes a contact, and any buddies it contains, and frees the memory | |
485 * allocated to it. | |
486 * | |
487 * @param contact The contact to be removed | |
488 */ | |
489 void gaim_blist_remove_contact(GaimContact *contact); | |
5228 | 490 |
491 /** | |
5234 | 492 * Removes a chat from the buddy list and frees the memory allocated to it. |
493 * | |
494 * @param chat The chat to be removed | |
495 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
496 void gaim_blist_remove_chat(GaimChat *chat); |
5234 | 497 |
498 /** | |
5228 | 499 * Removes a group from the buddy list and frees the memory allocated to it and to |
500 * its children | |
501 * | |
502 * @param group The group to be removed | |
503 */ | |
6695 | 504 void gaim_blist_remove_group(GaimGroup *group); |
5228 | 505 |
506 /** | |
507 * Returns the alias of a buddy. | |
508 * | |
509 * @param buddy The buddy whose name will be returned. | |
510 * @return The alias (if set), server alias (if option is set), or NULL. | |
511 */ | |
6695 | 512 const char *gaim_get_buddy_alias_only(GaimBuddy *buddy); |
5228 | 513 |
514 | |
515 /** | |
516 * Returns the correct name to display for a buddy. | |
517 * | |
518 * @param buddy The buddy whose name will be returned. | |
519 * @return The alias (if set), server alias (if option is set), screenname, or "Unknown" | |
520 */ | |
6695 | 521 const char *gaim_get_buddy_alias(GaimBuddy *buddy); |
5228 | 522 |
523 /** | |
6744 | 524 * Returns the correct name to display for a blist chat. |
525 * | |
526 * @param chat The chat whose name will be returned. | |
527 * @return The alias (if set), or first component value. | |
528 */ | |
7125 | 529 const char *gaim_chat_get_name(GaimChat *chat); |
6744 | 530 |
531 /** | |
5228 | 532 * Finds the buddy struct given a screenname and an account |
533 * | |
6872 | 534 * @param name The buddy's screenname |
5228 | 535 * @param account The account this buddy belongs to |
536 * @return The buddy or NULL if the buddy does not exist | |
537 */ | |
6695 | 538 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); |
6245 | 539 |
540 /** | |
6872 | 541 * Finds the buddy struct given a screenname, an account, and a group |
542 * | |
543 * @param name The buddy's screenname | |
544 * @param account The account this buddy belongs to | |
545 * @param group The group to look in | |
546 * @return The buddy or NULL if the buddy does not exist in the group | |
547 */ | |
548 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, | |
549 GaimGroup *group); | |
550 | |
551 /** | |
6245 | 552 * Finds all buddies struct given a screenname and an account |
553 * | |
554 * @param name The buddy's screenname | |
555 * @param account The account this buddy belongs to | |
556 * | |
557 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist | |
558 */ | |
559 GSList *gaim_find_buddies(GaimAccount *account, const char *name); | |
560 | |
5228 | 561 |
562 /** | |
563 * Finds a group by name | |
564 * | |
565 * @param name The groups name | |
566 * @return The group or NULL if the group does not exist | |
567 */ | |
6695 | 568 GaimGroup *gaim_find_group(const char *name); |
569 | |
570 /** | |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
571 * Finds a chat by name. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
572 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
573 * @param account The chat's account. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
574 * @param name The chat's name. |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
575 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
576 * @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
|
577 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
578 GaimChat *gaim_blist_find_chat(GaimAccount *account, const char *name); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
579 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
580 /** |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
581 * Returns the group of which the chat is a member. |
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 * @param chat The chat. |
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 * @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
|
586 */ |
7125 | 587 GaimGroup *gaim_chat_get_group(GaimChat *chat); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
588 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
589 /** |
5228 | 590 * Returns the group of which the buddy is a member. |
591 * | |
592 * @param buddy The buddy | |
593 * @return The group or NULL if the buddy is not in a group | |
594 */ | |
6695 | 595 GaimGroup *gaim_find_buddys_group(GaimBuddy *buddy); |
5228 | 596 |
597 | |
598 /** | |
599 * Returns a list of accounts that have buddies in this group | |
600 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
601 * @param g The group |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
602 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
603 * @return A list of gaim_accounts |
5228 | 604 */ |
6695 | 605 GSList *gaim_group_get_accounts(GaimGroup *g); |
5228 | 606 |
607 /** | |
608 * Determines whether an account owns any buddies in a given group | |
609 * | |
610 * @param g The group to search through. | |
611 * @param account The account. | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
612 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
613 * @return TRUE if there are any buddies in the group, or FALSE otherwise. |
5228 | 614 */ |
6695 | 615 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); |
5228 | 616 |
617 /** | |
5234 | 618 * Called when an account gets signed on. Tells the UI to update all the |
619 * buddies. | |
620 * | |
621 * @param account The account | |
622 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
623 void gaim_blist_add_account(GaimAccount *account); |
5234 | 624 |
625 | |
626 /** | |
5228 | 627 * Called when an account gets signed off. Sets the presence of all the buddies to 0 |
628 * and tells the UI to update them. | |
629 * | |
6695 | 630 * @param account The account |
5228 | 631 */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
632 void gaim_blist_remove_account(GaimAccount *account); |
5228 | 633 |
634 | |
635 /** | |
636 * Determines the total size of a group | |
637 * | |
638 * @param group The group | |
639 * @param offline Count buddies in offline accounts | |
640 * @return The number of buddies in the group | |
641 */ | |
6695 | 642 int gaim_blist_get_group_size(GaimGroup *group, gboolean offline); |
5228 | 643 |
644 /** | |
645 * Determines the number of online buddies in a group | |
646 * | |
647 * @param group The group | |
648 * @return The number of online buddies in the group, or 0 if the group is NULL | |
649 */ | |
6695 | 650 int gaim_blist_get_group_online_count(GaimGroup *group); |
5228 | 651 |
652 /*@}*/ | |
653 | |
654 /****************************************************************************************/ | |
655 /** @name Buddy list file management API */ | |
656 /****************************************************************************************/ | |
657 | |
658 /*@{*/ | |
659 /** | |
660 * Saves the buddy list to file | |
661 */ | |
662 void gaim_blist_save(); | |
663 | |
664 /** | |
7117
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
665 * Parses the toc-style buddy list used in older versions of Gaim and for SSI in toc.c |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
666 * |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
667 * @param account This is the account that the buddies and groups from config will get added to |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
668 * @param config This is the toc-style buddy list data |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
669 */ |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
670 void gaim_blist_parse_toc_buddy_list(GaimAccount *account, char *config); |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
671 |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
672 |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
673 /** |
5228 | 674 * Loads the buddy list from ~/.gaim/blist.xml. |
675 */ | |
676 void gaim_blist_load(); | |
677 | |
678 /** | |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
679 * 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
|
680 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
681 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
682 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
683 * @param username The username of the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
684 * @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
|
685 * @param alias The optional alias for the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
686 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
687 void gaim_blist_request_add_buddy(GaimAccount *account, const char *username, |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
688 const char *group, const char *alias); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
689 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
690 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
691 * 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
|
692 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
693 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
694 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
695 * @param group The optional group to add the chat to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
696 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
697 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group); |
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 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
700 * 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
|
701 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
702 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
703 void gaim_blist_request_add_group(void); |
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 /** |
7693 | 706 * Associates a boolean with a node in the buddy list |
707 * | |
708 * @param node The node to associate the data with | |
709 * @param key The identifier for the data | |
710 * @param value The value to set | |
711 */ | |
712 void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value); | |
713 | |
714 /** | |
715 * Retreives a named boolean setting from a node in the buddy list | |
716 * | |
717 * @param node The node to retreive the data from | |
718 * @param key The identifier of the data | |
719 * | |
720 * @return The value, or FALSE if there is no setting | |
721 */ | |
722 gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key); | |
723 | |
724 /** | |
725 * Associates an integer with a node in the buddy list | |
726 * | |
727 * @param node The node to associate the data with | |
728 * @param key The identifier for the data | |
729 * @param value The value to set | |
730 */ | |
731 void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value); | |
732 | |
733 /** | |
734 * Retreives a named integer setting from a node in the buddy list | |
735 * | |
736 * @param node The node to retreive the data from | |
737 * @param key The identifier of the data | |
738 * | |
739 * @return The value, or 0 if there is no setting | |
740 */ | |
741 int gaim_blist_node_get_int(GaimBlistNode *node, const char *key); | |
742 | |
743 /** | |
744 * Associates a string with a node in the buddy list | |
745 * | |
746 * @param node The node to associate the data with | |
747 * @param key The identifier for the data | |
748 * @param value The value to set | |
749 */ | |
750 void gaim_blist_node_set_string(GaimBlistNode *node, const char *key, | |
751 const char *value); | |
752 | |
753 /** | |
754 * Retreives a named string setting from a node in the buddy list | |
755 * | |
756 * @param node The node to retreive the data from | |
757 * @param key The identifier of the data | |
758 * | |
759 * @return The value, or NULL if there is no setting | |
760 */ | |
761 const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key); | |
762 | |
763 /** | |
7811 | 764 * Removes a named setting from a blist node |
765 * | |
766 * @param node The node from which to remove the setting | |
767 * @param key The name of the setting | |
768 */ | |
769 void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key); | |
770 | |
771 /** | |
5228 | 772 * Associates some data with the group in the xml buddy list |
773 * | |
774 * @param g The group the data is associated with | |
775 * @param key The key used to retrieve the data | |
776 * @param value The data to set | |
7812 | 777 * @deprecated Replaced by gaim_blist_node_set_bool(), gaim_blist_node_set_int() |
778 * and gaim_blist_node_set_string() to enable types and consolidate functionality. | |
779 * This function is scheduled to be removed in the near future. | |
5228 | 780 */ |
6695 | 781 void gaim_group_set_setting(GaimGroup *g, const char *key, const char *value); |
5228 | 782 |
783 /** | |
784 * Retrieves data from the XML buddy list set by gaim_group_set_setting()) | |
785 * | |
786 * @param g The group to retrieve data from | |
787 * @param key The key to retrieve the data with | |
788 * @return The associated data or NULL if no data is associated | |
7812 | 789 * @deprecated Replaced by gaim_blist_node_get_bool(), gaim_blist_node_get_int() |
790 * and gaim_blist_node_get_string() to enable types and consolidate functionality. | |
791 * This function is scheduled to be removed in the near future. | |
5228 | 792 */ |
7125 | 793 const char *gaim_group_get_setting(GaimGroup *g, const char *key); |
5228 | 794 |
5906 | 795 /** |
796 * Associates some data with the chat in the xml buddy list | |
797 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
798 * @param c The chat the data is associated with |
5906 | 799 * @param key The key used to retrieve the data |
800 * @param value The data to set | |
7812 | 801 * @deprecated Replaced by gaim_blist_node_set_bool(), gaim_blist_node_set_int() |
802 * and gaim_blist_node_set_string() to enable types and consolidate functionality. | |
803 * This function is scheduled to be removed in the near future. | |
5906 | 804 */ |
7125 | 805 void gaim_chat_set_setting(GaimChat *c, const char *key, const char *value); |
5906 | 806 |
807 /** | |
7125 | 808 * Retrieves data from the XML buddy list set by gaim_chat_set_setting()) |
5906 | 809 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
810 * @param c The chat to retrieve data from |
5906 | 811 * @param key The key to retrieve the data with |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
812 * |
5906 | 813 * @return The associated data or NULL if no data is associated |
7812 | 814 * @deprecated Replaced by gaim_blist_node_get_bool(), gaim_blist_node_get_int() |
815 * and gaim_blist_node_get_string() to enable types and consolidate functionality. | |
816 * This function is scheduled to be removed in the near future. | |
5906 | 817 */ |
7125 | 818 const char *gaim_chat_get_setting(GaimChat *c, const char *key); |
5228 | 819 |
820 /** | |
821 * Associates some data with the buddy in the xml buddy list | |
822 * | |
823 * @param b The buddy the data is associated with | |
824 * @param key The key used to retrieve the data | |
825 * @param value The data to set | |
7812 | 826 * @deprecated Replaced by gaim_blist_node_set_bool(), gaim_blist_node_set_int() |
827 * and gaim_blist_node_set_string() to enable types and consolidate functionality. | |
828 * This function is scheduled to be removed in the near future. | |
5228 | 829 */ |
6695 | 830 void gaim_buddy_set_setting(GaimBuddy *b, const char *key, const char *value); |
5228 | 831 |
832 /** | |
833 * Retrieves data from the XML buddy list set by gaim_buddy_set_setting()) | |
834 * | |
835 * @param b The buddy to retrieve data from | |
836 * @param key The key to retrieve the data with | |
837 * @return The associated data or NULL if no data is associated | |
7812 | 838 * @deprecated Replaced by gaim_blist_node_get_bool(), gaim_blist_node_get_int() |
839 * and gaim_blist_node_get_string() to enable types and consolidate functionality. | |
840 * This function is scheduled to be removed in the near future. | |
5228 | 841 */ |
7125 | 842 const char *gaim_buddy_get_setting(GaimBuddy *b, const char *key); |
5228 | 843 |
844 /*@}*/ | |
845 | |
846 /**************************************************************************/ | |
847 /** @name UI Registration Functions */ | |
848 /**************************************************************************/ | |
849 /*@{*/ | |
850 | |
851 /** | |
852 * Sets the UI operations structure to be used for the buddy list. | |
853 * | |
854 * @param ops The ops struct. | |
855 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
856 void gaim_blist_set_ui_ops(GaimBlistUiOps *ops); |
5228 | 857 |
858 /** | |
859 * Returns the UI operations structure to be used for the buddy list. | |
860 * | |
861 * @return The UI operations structure. | |
862 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
863 GaimBlistUiOps *gaim_blist_get_ui_ops(void); |
5228 | 864 |
865 /*@}*/ | |
866 | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
867 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
868 /** @name Buddy List Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
869 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
870 /*@{*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
871 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
872 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
873 * Returns the handle for the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
874 * |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
875 * @return The buddy list subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
876 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
877 void *gaim_blist_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
878 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
879 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
880 * Initializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
881 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
882 void gaim_blist_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
883 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
884 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
885 * Uninitializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
886 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
887 void gaim_blist_uninit(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
888 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
889 /*@}*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
890 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
891 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
892 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
893 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
894 |
6695 | 895 #endif /* _BLIST_H_ */ |