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