Mercurial > pidgin.yaz
annotate src/blist.h @ 7394:c6ff3c1fb1b3
[gaim-migrate @ 7989]
NEWS is embarrassing when you don't do anything
committer: Tailor Script <tailor@pidgin.im>
author | Ethan Blanton <elb@pidgin.im> |
---|---|
date | Fri, 31 Oct 2003 01:38:46 +0000 |
parents | b8ce6e194cff |
children | 53c86d59f20b |
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 */ |
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 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
141 struct _GaimChat { |
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 * | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
164 * Any UI representing a buddy list must assign a filled-out gaim_conv_window_ops |
5228 | 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 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
307 void gaim_blist_alias_chat(GaimChat *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 */ | |
7125 | 325 GaimChat *gaim_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 */ | |
7125 | 333 char *gaim_chat_get_display_name(GaimChat *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 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
346 void gaim_blist_add_chat(GaimChat *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 /** |
7312 | 381 * Returns a buddy's contact. |
382 * | |
383 * @param buddy The buddy. | |
384 * | |
385 * @return The buddy's contact. | |
386 */ | |
387 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); | |
388 | |
389 /** | |
5228 | 390 * Adds a new buddy to the buddy list. |
391 * | |
6695 | 392 * The buddy will be inserted right after node or prepended to the |
393 * group if node is NULL. If both are NULL, the buddy will be added to | |
5228 | 394 * the "Buddies" group. |
395 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
396 * @param buddy The new buddy who gets added |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
397 * @param contact The optional contact to place the buddy in. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
398 * @param group The group to add the new buddy to. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
399 * @param node The insertion point |
5228 | 400 */ |
6695 | 401 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); |
5228 | 402 |
403 /** | |
404 * Creates a new group | |
405 * | |
6695 | 406 * You can't have more than one group with the same name. Sorry. If you pass |
407 * this the * name of a group that already exists, it will return that group. | |
5228 | 408 * |
409 * @param name The name of the new group | |
6695 | 410 * @return A new group struct |
5228 | 411 */ |
6695 | 412 GaimGroup *gaim_group_new(const char *name); |
5228 | 413 |
414 /** | |
415 * Adds a new group to the buddy list. | |
416 * | |
6695 | 417 * The new group will be inserted after insert or prepended to the list if |
418 * node is NULL. | |
419 * | |
420 * @param group The group | |
421 * @param node The insertion point | |
422 */ | |
423 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
424 | |
425 /** | |
426 * Creates a new contact | |
5228 | 427 * |
6695 | 428 * @return A new contact struct |
5228 | 429 */ |
6695 | 430 GaimContact *gaim_contact_new(); |
431 | |
432 /** | |
433 * Adds a new contact to the buddy list. | |
434 * | |
435 * The new contact will be inserted after insert or prepended to the list if | |
436 * node is NULL. | |
437 * | |
438 * @param contact The contact | |
439 * @param group The group to add the contact to | |
440 * @param node The insertion point | |
441 */ | |
442 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
443 | |
444 /** | |
6965 | 445 * Merges two contacts |
446 * | |
447 * All of the buddies from source will be moved to target | |
448 * | |
449 * @param source The contact to merge | |
7246 | 450 * @param node The place to merge to (a buddy or contact) |
6965 | 451 */ |
7246 | 452 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); |
6965 | 453 |
454 /** | |
6695 | 455 * Returns the highest priority buddy for a given contact. |
456 * | |
457 * @param contact The contact | |
458 * @return The highest priority buddy | |
459 */ | |
460 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
5228 | 461 |
462 /** | |
6755 | 463 * Sets the alias for a contact. |
464 * | |
465 * @param contact The contact | |
466 * @param alias The alias to set, or NULL to unset | |
467 */ | |
468 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
469 | |
470 /** | |
471 * Gets the alias for a contact. | |
472 * | |
473 * @param contact The contact | |
474 * @return The alias, or NULL if it is not set. | |
475 */ | |
476 const char *gaim_contact_get_alias(GaimContact *contact); | |
477 | |
478 /** | |
5228 | 479 * Removes a buddy from the buddy list and frees the memory allocated to it. |
480 * | |
481 * @param buddy The buddy to be removed | |
482 */ | |
6695 | 483 void gaim_blist_remove_buddy(GaimBuddy *buddy); |
484 | |
485 /** | |
486 * Removes a contact, and any buddies it contains, and frees the memory | |
487 * allocated to it. | |
488 * | |
489 * @param contact The contact to be removed | |
490 */ | |
491 void gaim_blist_remove_contact(GaimContact *contact); | |
5228 | 492 |
493 /** | |
5234 | 494 * Removes a chat from the buddy list and frees the memory allocated to it. |
495 * | |
496 * @param chat The chat to be removed | |
497 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
498 void gaim_blist_remove_chat(GaimChat *chat); |
5234 | 499 |
500 /** | |
5228 | 501 * Removes a group from the buddy list and frees the memory allocated to it and to |
502 * its children | |
503 * | |
504 * @param group The group to be removed | |
505 */ | |
6695 | 506 void gaim_blist_remove_group(GaimGroup *group); |
5228 | 507 |
508 /** | |
509 * Returns the alias of 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), or NULL. | |
513 */ | |
6695 | 514 const char *gaim_get_buddy_alias_only(GaimBuddy *buddy); |
5228 | 515 |
516 | |
517 /** | |
518 * Returns the correct name to display for a buddy. | |
519 * | |
520 * @param buddy The buddy whose name will be returned. | |
521 * @return The alias (if set), server alias (if option is set), screenname, or "Unknown" | |
522 */ | |
6695 | 523 const char *gaim_get_buddy_alias(GaimBuddy *buddy); |
5228 | 524 |
525 /** | |
6744 | 526 * Returns the correct name to display for a blist chat. |
527 * | |
528 * @param chat The chat whose name will be returned. | |
529 * @return The alias (if set), or first component value. | |
530 */ | |
7125 | 531 const char *gaim_chat_get_name(GaimChat *chat); |
6744 | 532 |
533 /** | |
5228 | 534 * Finds the buddy struct given a screenname and an account |
535 * | |
6872 | 536 * @param name The buddy's screenname |
5228 | 537 * @param account The account this buddy belongs to |
538 * @return The buddy or NULL if the buddy does not exist | |
539 */ | |
6695 | 540 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); |
6245 | 541 |
542 /** | |
6872 | 543 * Finds the buddy struct given a screenname, an account, and a group |
544 * | |
545 * @param name The buddy's screenname | |
546 * @param account The account this buddy belongs to | |
547 * @param group The group to look in | |
548 * @return The buddy or NULL if the buddy does not exist in the group | |
549 */ | |
550 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, | |
551 GaimGroup *group); | |
552 | |
553 /** | |
6245 | 554 * Finds all buddies struct given a screenname and an account |
555 * | |
556 * @param name The buddy's screenname | |
557 * @param account The account this buddy belongs to | |
558 * | |
559 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist | |
560 */ | |
561 GSList *gaim_find_buddies(GaimAccount *account, const char *name); | |
562 | |
5228 | 563 |
564 /** | |
565 * Finds a group by name | |
566 * | |
567 * @param name The groups name | |
568 * @return The group or NULL if the group does not exist | |
569 */ | |
6695 | 570 GaimGroup *gaim_find_group(const char *name); |
571 | |
572 /** | |
573 * Finds a contact | |
574 * | |
575 * @param group The group to look in | |
576 * @param name The name to look for | |
577 * @return The contact or NULL if the contact does not exist | |
578 */ | |
579 GaimContact *gaim_find_contact(GaimGroup *group, const char *name); | |
5228 | 580 |
581 /** | |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
582 * Finds a chat by name. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
583 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
584 * @param account The chat's account. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
585 * @param name The chat's name. |
6456
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 chat, or @c NULL if the chat does not exist. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
588 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
589 GaimChat *gaim_blist_find_chat(GaimAccount *account, const char *name); |
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 /** |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
592 * Returns the group of which the chat is a member. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
593 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
594 * @param chat The chat. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
595 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
596 * @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
|
597 */ |
7125 | 598 GaimGroup *gaim_chat_get_group(GaimChat *chat); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
599 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
600 /** |
5228 | 601 * Returns the group of which the buddy is a member. |
602 * | |
603 * @param buddy The buddy | |
604 * @return The group or NULL if the buddy is not in a group | |
605 */ | |
6695 | 606 GaimGroup *gaim_find_buddys_group(GaimBuddy *buddy); |
5228 | 607 |
608 | |
609 /** | |
610 * Returns a list of accounts that have buddies in this group | |
611 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
612 * @param g The group |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
613 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
614 * @return A list of gaim_accounts |
5228 | 615 */ |
6695 | 616 GSList *gaim_group_get_accounts(GaimGroup *g); |
5228 | 617 |
618 /** | |
619 * Determines whether an account owns any buddies in a given group | |
620 * | |
621 * @param g The group to search through. | |
622 * @param account The account. | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
623 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
624 * @return TRUE if there are any buddies in the group, or FALSE otherwise. |
5228 | 625 */ |
6695 | 626 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); |
5228 | 627 |
628 /** | |
5234 | 629 * Called when an account gets signed on. Tells the UI to update all the |
630 * buddies. | |
631 * | |
632 * @param account The account | |
633 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
634 void gaim_blist_add_account(GaimAccount *account); |
5234 | 635 |
636 | |
637 /** | |
5228 | 638 * Called when an account gets signed off. Sets the presence of all the buddies to 0 |
639 * and tells the UI to update them. | |
640 * | |
6695 | 641 * @param account The account |
5228 | 642 */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
643 void gaim_blist_remove_account(GaimAccount *account); |
5228 | 644 |
645 | |
646 /** | |
647 * Determines the total size of a group | |
648 * | |
649 * @param group The group | |
650 * @param offline Count buddies in offline accounts | |
651 * @return The number of buddies in the group | |
652 */ | |
6695 | 653 int gaim_blist_get_group_size(GaimGroup *group, gboolean offline); |
5228 | 654 |
655 /** | |
656 * Determines the number of online buddies in a group | |
657 * | |
658 * @param group The group | |
659 * @return The number of online buddies in the group, or 0 if the group is NULL | |
660 */ | |
6695 | 661 int gaim_blist_get_group_online_count(GaimGroup *group); |
5228 | 662 |
663 /*@}*/ | |
664 | |
665 /****************************************************************************************/ | |
666 /** @name Buddy list file management API */ | |
667 /****************************************************************************************/ | |
668 | |
669 /*@{*/ | |
670 /** | |
671 * Saves the buddy list to file | |
672 */ | |
673 void gaim_blist_save(); | |
674 | |
675 /** | |
7117
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
676 * 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
|
677 * |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
678 * @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
|
679 * @param config This is the toc-style buddy list data |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
680 */ |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
681 void gaim_blist_parse_toc_buddy_list(GaimAccount *account, char *config); |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
682 |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
683 |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
684 /** |
5228 | 685 * Loads the buddy list from ~/.gaim/blist.xml. |
686 */ | |
687 void gaim_blist_load(); | |
688 | |
689 /** | |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
690 * 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
|
691 * buddy list. |
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 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
694 * @param username The username of the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
695 * @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
|
696 * @param alias The optional alias for the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
697 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
698 void gaim_blist_request_add_buddy(GaimAccount *account, const char *username, |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
699 const char *group, const char *alias); |
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 chat 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 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
706 * @param group The optional group to add the chat to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
707 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
708 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
709 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
710 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
711 * 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
|
712 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
713 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
714 void gaim_blist_request_add_group(void); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
715 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
716 /** |
5228 | 717 * Associates some data with the group in the xml buddy list |
718 * | |
719 * @param g The group the data is associated with | |
720 * @param key The key used to retrieve the data | |
721 * @param value The data to set | |
722 */ | |
6695 | 723 void gaim_group_set_setting(GaimGroup *g, const char *key, const char *value); |
5228 | 724 |
725 /** | |
726 * Retrieves data from the XML buddy list set by gaim_group_set_setting()) | |
727 * | |
728 * @param g The group to retrieve data from | |
729 * @param key The key to retrieve the data with | |
730 * @return The associated data or NULL if no data is associated | |
731 */ | |
7125 | 732 const char *gaim_group_get_setting(GaimGroup *g, const char *key); |
5228 | 733 |
5906 | 734 /** |
735 * Associates some data with the chat in the xml buddy list | |
736 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
737 * @param c The chat the data is associated with |
5906 | 738 * @param key The key used to retrieve the data |
739 * @param value The data to set | |
740 */ | |
7125 | 741 void gaim_chat_set_setting(GaimChat *c, const char *key, const char *value); |
5906 | 742 |
743 /** | |
7125 | 744 * Retrieves data from the XML buddy list set by gaim_chat_set_setting()) |
5906 | 745 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
746 * @param c The chat to retrieve data from |
5906 | 747 * @param key The key to retrieve the data with |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
748 * |
5906 | 749 * @return The associated data or NULL if no data is associated |
750 */ | |
7125 | 751 const char *gaim_chat_get_setting(GaimChat *c, const char *key); |
5228 | 752 |
753 /** | |
754 * Associates some data with the buddy in the xml buddy list | |
755 * | |
756 * @param b The buddy the data is associated with | |
757 * @param key The key used to retrieve the data | |
758 * @param value The data to set | |
759 */ | |
6695 | 760 void gaim_buddy_set_setting(GaimBuddy *b, const char *key, const char *value); |
5228 | 761 |
762 /** | |
763 * Retrieves data from the XML buddy list set by gaim_buddy_set_setting()) | |
764 * | |
765 * @param b The buddy to retrieve data from | |
766 * @param key The key to retrieve the data with | |
767 * @return The associated data or NULL if no data is associated | |
768 */ | |
7125 | 769 const char *gaim_buddy_get_setting(GaimBuddy *b, const char *key); |
5228 | 770 |
771 /*@}*/ | |
772 | |
773 /**************************************************************************/ | |
774 /** @name UI Registration Functions */ | |
775 /**************************************************************************/ | |
776 /*@{*/ | |
777 | |
778 /** | |
779 * Sets the UI operations structure to be used for the buddy list. | |
780 * | |
781 * @param ops The ops struct. | |
782 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
783 void gaim_blist_set_ui_ops(GaimBlistUiOps *ops); |
5228 | 784 |
785 /** | |
786 * Returns the UI operations structure to be used for the buddy list. | |
787 * | |
788 * @return The UI operations structure. | |
789 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
790 GaimBlistUiOps *gaim_blist_get_ui_ops(void); |
5228 | 791 |
792 /*@}*/ | |
793 | |
6485
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 /** @name Buddy List Subsystem */ |
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 |
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 * Returns the handle for the buddy list subsystem. |
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 * @return The buddy list subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
803 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
804 void *gaim_blist_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
805 |
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 * Initializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
808 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
809 void gaim_blist_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
810 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
811 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
812 * Uninitializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
813 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
814 void gaim_blist_uninit(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
815 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
816 /*@}*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
817 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
818 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
819 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
820 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
821 |
6695 | 822 #endif /* _BLIST_H_ */ |