Mercurial > pidgin
annotate src/blist.h @ 10554:0ad82505bde8
[gaim-migrate @ 11931]
Buddies can be in more than one group (at least on some protocols), so we
should update their status/idle/warning/etc. in all groups.
committer: Tailor Script <tailor@pidgin.im>
author | Stu Tomlinson <stu@nosnilmot.com> |
---|---|
date | Sat, 29 Jan 2005 18:03:48 +0000 |
parents | 1596ade00664 |
children | 62fc579810f4 |
rev | line source |
---|---|
5228 | 1 /** |
5497 | 2 * @file blist.h Buddy List API |
5228 | 3 * @ingroup core |
4 * | |
5 * gaim | |
6 * | |
8046 | 7 * Gaim is the legal property of its developers, whose names are too numerous |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
10 * |
5228 | 11 * This program is free software; you can redistribute it and/or modify |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
9713 | 25 #ifndef _GAIM_BLIST_H_ |
26 #define _GAIM_BLIST_H_ | |
5228 | 27 |
28 /* I can't believe I let ChipX86 inspire me to write good code. -Sean */ | |
29 | |
30 #include <glib.h> | |
31 | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
32 typedef struct _GaimBuddyList GaimBuddyList; |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
33 typedef struct _GaimBlistUiOps GaimBlistUiOps; |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
34 typedef struct _GaimBlistNode GaimBlistNode; |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
35 |
9030 | 36 typedef struct _GaimBlistNodeAction GaimBlistNodeAction; |
37 | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
38 typedef struct _GaimChat GaimChat; |
6695 | 39 typedef struct _GaimGroup GaimGroup; |
40 typedef struct _GaimContact GaimContact; | |
41 typedef struct _GaimBuddy GaimBuddy; | |
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 |
9944 | 56 #define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE) |
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) |
9944 | 59 #define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE) |
5228 | 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 |
9944 | 70 #define GAIM_BUDDY_IS_ONLINE(b) \ |
71 ((b) != NULL && gaim_account_is_connected((b)->account) && \ | |
72 gaim_presence_is_online(gaim_buddy_get_presence(b))) | |
5228 | 73 |
9787 | 74 typedef enum |
75 { | |
10008 | 76 GAIM_BLIST_NODE_FLAG_NO_SAVE = 1 /**< node should not be saved with the buddy list */ |
77 | |
9787 | 78 } GaimBlistNodeFlags; |
79 | |
80 #define GAIM_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f)) | |
81 #define GAIM_BLIST_NODE_SHOULD_SAVE(b) (! GAIM_BLIST_NODE_HAS_FLAG(b, GAIM_BLIST_NODE_FLAG_NO_SAVE)) | |
82 | |
10008 | 83 #include "account.h" |
84 #include "buddyicon.h" | |
85 #include "status.h" | |
5228 | 86 |
87 /**************************************************************************/ | |
88 /* Data Structures */ | |
89 /**************************************************************************/ | |
90 | |
91 /** | |
92 * A Buddy list node. This can represent a group, a buddy, or anything else. This is a base class for struct buddy and | |
93 * struct group and for anything else that wants to put itself in the buddy list. */ | |
94 struct _GaimBlistNode { | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
95 GaimBlistNodeType type; /**< The type of node this is */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
96 GaimBlistNode *prev; /**< The sibling before this buddy. */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
97 GaimBlistNode *next; /**< The sibling after this buddy. */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
98 GaimBlistNode *parent; /**< The parent of this node */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
99 GaimBlistNode *child; /**< The child of this node */ |
7693 | 100 GHashTable *settings; /**< per-node settings */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
101 void *ui_data; /**< The UI can put data here. */ |
9787 | 102 GaimBlistNodeFlags flags; /**< The buddy flags */ |
5228 | 103 }; |
104 | |
105 /** | |
106 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
107 */ | |
6695 | 108 struct _GaimBuddy { |
5228 | 109 GaimBlistNode node; /**< The node that this buddy inherits from */ |
110 char *name; /**< The screenname of the buddy. */ | |
111 char *alias; /**< The user-set alias of the buddy */ | |
6695 | 112 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
|
113 GaimBuddyPresenceState present; /**< This is 0 if the buddy appears offline, 1 if he appears online, and 2 if |
5228 | 114 he has recently signed on */ |
115 time_t signon; /**< The time the buddy signed on. */ | |
116 int uc; /**< This is a cryptic bitmask that makes sense only to the prpl. This will get changed */ | |
117 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
|
118 GaimBuddyIcon *icon; /**< The buddy icon. */ |
9787 | 119 GaimAccount *account; /**< the account this buddy belongs to */ |
120 guint timer; /**< The timer handle. */ | |
9949 | 121 GaimPresence *presence; |
5228 | 122 }; |
123 | |
124 /** | |
6695 | 125 * A contact. This contains everything Gaim will ever need to know about a contact. |
126 */ | |
127 struct _GaimContact { | |
6755 | 128 GaimBlistNode node; /**< The node that this contact inherits from. */ |
129 char *alias; /**< The user-set alias of the contact */ | |
130 int totalsize; /**< The number of buddies in this contact */ | |
131 int currentsize; /**< The number of buddies in this contact corresponding to online accounts */ | |
132 int online; /**< The number of buddies in this contact who are currently online */ | |
6843 | 133 GaimBuddy *priority; /**< The "top" buddy for this contact */ |
10378 | 134 gboolean priority_valid; /**< Is priority valid? */ |
6695 | 135 }; |
136 | |
137 | |
138 /** | |
5228 | 139 * A group. This contains everything Gaim will ever need to know about a group. |
140 */ | |
6695 | 141 struct _GaimGroup { |
5228 | 142 GaimBlistNode node; /**< The node that this group inherits from */ |
143 char *name; /**< The name of this group. */ | |
6695 | 144 int totalsize; /**< The number of chats and contacts in this group */ |
145 int currentsize; /**< The number of chats and contacts in this group corresponding to online accounts */ | |
146 int online; /**< The number of chats and contacts in this group who are currently online */ | |
5228 | 147 }; |
148 | |
5234 | 149 /** |
6695 | 150 * A chat. This contains everything Gaim needs to put a chat room in the |
5234 | 151 * buddy list. |
152 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
153 struct _GaimChat { |
5234 | 154 GaimBlistNode node; /**< The node that this chat inherits from */ |
155 char *alias; /**< The display name of this chat. */ | |
156 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
|
157 GaimAccount *account; /**< The account this chat is attached to */ |
5234 | 158 }; |
159 | |
5228 | 160 |
161 /** | |
162 * The Buddy List | |
163 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
164 struct _GaimBuddyList { |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
165 GaimBlistNode *root; /**< The first node in the buddy list */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
166 GHashTable *buddies; /**< Every buddy in this list */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
167 GaimBlistUiOps *ui_ops; /**< The UI operations for the buddy list */ |
5228 | 168 |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
169 void *ui_data; /**< UI-specific data. */ |
5228 | 170 }; |
171 | |
172 /** | |
173 * Buddy list UI operations. | |
174 * | |
9460 | 175 * Any UI representing a buddy list must assign a filled-out GaimBlistUiOps |
5228 | 176 * structure to the buddy list core. |
177 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
178 struct _GaimBlistUiOps |
5228 | 179 { |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
180 void (*new_list)(GaimBuddyList *list); /**< Sets UI-specific data on a buddy list. */ |
9996 | 181 void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */ |
9997 | 182 void (*show)(GaimBuddyList *list); /**< The core will call this when it's finished doing its core stuff */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
183 void (*update)(GaimBuddyList *list, |
9996 | 184 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
|
185 void (*remove)(GaimBuddyList *list, |
9996 | 186 GaimBlistNode *node); /**< This removes a node from the list */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
187 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
|
188 void (*set_visible)(GaimBuddyList *list, |
9996 | 189 gboolean show); /**< Hides or unhides the buddy list */ |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
190 void (*request_add_buddy)(GaimAccount *account, const char *username, |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
191 const char *group, const char *alias); |
10433 | 192 void (*request_add_chat)(GaimAccount *account, GaimGroup *group, |
9754 | 193 const char *alias, const char *name); |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
194 void (*request_add_group)(void); |
5228 | 195 }; |
196 | |
9030 | 197 |
198 struct _GaimBlistNodeAction { | |
199 char *label; | |
200 void (*callback)(GaimBlistNode *, gpointer); | |
201 gpointer data; | |
202 }; | |
203 | |
204 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
205 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
206 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
207 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
208 |
5228 | 209 /**************************************************************************/ |
210 /** @name Buddy List API */ | |
211 /**************************************************************************/ | |
212 /*@{*/ | |
213 | |
214 /** | |
215 * Creates a new buddy list | |
10071 | 216 * |
217 * @return The new buddy list. | |
5228 | 218 */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
219 GaimBuddyList *gaim_blist_new(); |
5228 | 220 |
221 /** | |
222 * Sets the main buddy list. | |
223 * | |
10071 | 224 * @param blist The buddy list you want to use. |
5228 | 225 */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
226 void gaim_set_blist(GaimBuddyList *blist); |
5228 | 227 |
228 /** | |
229 * Returns the main buddy list. | |
230 * | |
231 * @return The main buddy list. | |
232 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
233 GaimBuddyList *gaim_get_blist(void); |
5228 | 234 |
235 /** | |
236 * Shows the buddy list, creating a new one if necessary. | |
237 */ | |
238 void gaim_blist_show(); | |
239 | |
240 | |
241 /** | |
242 * Destroys the buddy list window. | |
243 */ | |
244 void gaim_blist_destroy(); | |
245 | |
246 /** | |
247 * Hides or unhides the buddy list. | |
248 * | |
249 * @param show Whether or not to show the buddy list | |
250 */ | |
251 void gaim_blist_set_visible(gboolean show); | |
252 | |
253 /** | |
254 * Updates a buddy's status. | |
5234 | 255 * |
10052 | 256 * @param buddy The buddy whose status has changed. |
257 * @param old_status The status from which we are changing. | |
5228 | 258 */ |
10052 | 259 void gaim_blist_update_buddy_status(GaimBuddy *buddy, GaimStatus *old_status); |
5228 | 260 |
7950 | 261 /** |
262 * Updates a buddy's signon time. | |
263 * | |
9944 | 264 * @param buddy The buddy whose sign-on time has changed. |
7950 | 265 * @param signon The buddy's signon time since the dawn of the UNIX epoch. |
266 */ | |
267 void gaim_blist_update_buddy_signon(GaimBuddy *buddy, time_t signon); | |
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 /** |
10037
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
372 * Returns a buddy's account. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
373 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
374 * @param buddy The buddy. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
375 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
376 * @return The account |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
377 */ |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
378 GaimAccount *gaim_buddy_get_account(const GaimBuddy *buddy); |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
379 |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
380 /** |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
381 * Returns a buddy's name |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
382 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
383 * @param buddy The buddy. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
384 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
385 * @return The name. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
386 */ |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
387 const char *gaim_buddy_get_name(const GaimBuddy *buddy); |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
388 |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
389 /** |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
390 * Returns a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
391 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
392 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
393 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
394 * @return The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
395 */ |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
396 GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy); |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
397 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
398 /** |
7312 | 399 * Returns a buddy's contact. |
400 * | |
401 * @param buddy The buddy. | |
402 * | |
403 * @return The buddy's contact. | |
404 */ | |
405 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); | |
406 | |
407 /** | |
9944 | 408 * Returns a buddy's presence. |
409 * | |
410 * @param buddy The buddy. | |
411 * | |
412 * @return The buddy's presence. | |
413 */ | |
414 GaimPresence *gaim_buddy_get_presence(const GaimBuddy *buddy); | |
415 | |
416 /** | |
5228 | 417 * Adds a new buddy to the buddy list. |
418 * | |
6695 | 419 * The buddy will be inserted right after node or prepended to the |
420 * group if node is NULL. If both are NULL, the buddy will be added to | |
5228 | 421 * the "Buddies" group. |
422 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
423 * @param buddy The new buddy who gets added |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
424 * @param contact The optional contact to place the buddy in. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
425 * @param group The group to add the new buddy to. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
426 * @param node The insertion point |
5228 | 427 */ |
6695 | 428 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); |
5228 | 429 |
430 /** | |
431 * Creates a new group | |
432 * | |
6695 | 433 * You can't have more than one group with the same name. Sorry. If you pass |
434 * this the * name of a group that already exists, it will return that group. | |
5228 | 435 * |
436 * @param name The name of the new group | |
6695 | 437 * @return A new group struct |
5228 | 438 */ |
6695 | 439 GaimGroup *gaim_group_new(const char *name); |
5228 | 440 |
441 /** | |
442 * Adds a new group to the buddy list. | |
443 * | |
6695 | 444 * The new group will be inserted after insert or prepended to the list if |
445 * node is NULL. | |
446 * | |
447 * @param group The group | |
448 * @param node The insertion point | |
449 */ | |
450 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
451 | |
452 /** | |
453 * Creates a new contact | |
5228 | 454 * |
6695 | 455 * @return A new contact struct |
5228 | 456 */ |
6695 | 457 GaimContact *gaim_contact_new(); |
458 | |
459 /** | |
460 * Adds a new contact to the buddy list. | |
461 * | |
462 * The new contact will be inserted after insert or prepended to the list if | |
463 * node is NULL. | |
464 * | |
465 * @param contact The contact | |
466 * @param group The group to add the contact to | |
467 * @param node The insertion point | |
468 */ | |
469 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
470 | |
471 /** | |
6965 | 472 * Merges two contacts |
473 * | |
474 * All of the buddies from source will be moved to target | |
475 * | |
476 * @param source The contact to merge | |
7246 | 477 * @param node The place to merge to (a buddy or contact) |
6965 | 478 */ |
7246 | 479 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); |
6965 | 480 |
481 /** | |
6695 | 482 * Returns the highest priority buddy for a given contact. |
483 * | |
484 * @param contact The contact | |
485 * @return The highest priority buddy | |
486 */ | |
487 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
5228 | 488 |
489 /** | |
6755 | 490 * Sets the alias for a contact. |
491 * | |
492 * @param contact The contact | |
493 * @param alias The alias to set, or NULL to unset | |
494 */ | |
495 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
496 | |
497 /** | |
498 * Gets the alias for a contact. | |
499 * | |
500 * @param contact The contact | |
501 * @return The alias, or NULL if it is not set. | |
502 */ | |
503 const char *gaim_contact_get_alias(GaimContact *contact); | |
504 | |
505 /** | |
9787 | 506 * Determines whether an account owns any buddies in a given contact |
507 * | |
508 * @param contact The contact to search through. | |
509 * @param account The account. | |
510 * | |
511 * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise. | |
512 */ | |
513 gboolean gaim_contact_on_account(GaimContact *contact, GaimAccount *account); | |
514 | |
515 /** | |
10378 | 516 * Invalidates the priority buddy so that the next call to |
517 * gaim_contact_get_priority_buddy recomputes it. | |
9944 | 518 * |
10378 | 519 * @param contact The contact |
520 * @return The highest priority buddy | |
9944 | 521 */ |
10378 | 522 void gaim_contact_invalidate_priority_buddy(GaimContact *contact); |
9944 | 523 /** |
5228 | 524 * Removes a buddy from the buddy list and frees the memory allocated to it. |
525 * | |
526 * @param buddy The buddy to be removed | |
527 */ | |
6695 | 528 void gaim_blist_remove_buddy(GaimBuddy *buddy); |
529 | |
530 /** | |
531 * Removes a contact, and any buddies it contains, and frees the memory | |
532 * allocated to it. | |
533 * | |
534 * @param contact The contact to be removed | |
535 */ | |
536 void gaim_blist_remove_contact(GaimContact *contact); | |
5228 | 537 |
538 /** | |
5234 | 539 * Removes a chat from the buddy list and frees the memory allocated to it. |
540 * | |
541 * @param chat The chat to be removed | |
542 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
543 void gaim_blist_remove_chat(GaimChat *chat); |
5234 | 544 |
545 /** | |
5228 | 546 * Removes a group from the buddy list and frees the memory allocated to it and to |
547 * its children | |
548 * | |
549 * @param group The group to be removed | |
550 */ | |
6695 | 551 void gaim_blist_remove_group(GaimGroup *group); |
5228 | 552 |
553 /** | |
554 * Returns the alias of a buddy. | |
555 * | |
556 * @param buddy The buddy whose name will be returned. | |
10349 | 557 * @return The alias (if set), server alias (if set), |
558 * or NULL. | |
5228 | 559 */ |
9620 | 560 const char *gaim_buddy_get_alias_only(GaimBuddy *buddy); |
5228 | 561 |
562 | |
563 /** | |
9620 | 564 * Returns the correct name to display for a buddy, taking the contact alias |
565 * into account. In order of precedence: the buddy's alias; the buddy's | |
566 * contact alias; the buddy's server alias; the buddy's user name. | |
567 * | |
568 * @param buddy The buddy whose name will be returned | |
9635 | 569 * @return The appropriate name or alias, or NULL. |
9620 | 570 * |
571 */ | |
572 const char *gaim_buddy_get_contact_alias(GaimBuddy *buddy); | |
573 | |
10349 | 574 /** |
575 * Returns the correct alias for this user, ignoring server aliases. Used | |
576 * when a user-recognizable name is required. In order: buddy's alias; buddy's | |
577 * contact alias; buddy's user name. | |
578 * | |
579 * @param buddy The buddy whose alias will be returned. | |
580 * @return The appropriate name or alias. | |
581 */ | |
582 const char *gaim_buddy_get_local_alias(GaimBuddy *buddy); | |
9620 | 583 |
584 /** | |
585 * Returns the correct name to display for a buddy. In order of precedence: | |
586 * the buddy's alias; the buddy's server alias; the buddy's contact alias; | |
587 * the buddy's user name. | |
5228 | 588 * |
589 * @param buddy The buddy whose name will be returned. | |
9635 | 590 * @return The appropriate name or alias, or NULL |
5228 | 591 */ |
9620 | 592 const char *gaim_buddy_get_alias(GaimBuddy *buddy); |
5228 | 593 |
594 /** | |
6744 | 595 * Returns the correct name to display for a blist chat. |
596 * | |
597 * @param chat The chat whose name will be returned. | |
598 * @return The alias (if set), or first component value. | |
599 */ | |
7125 | 600 const char *gaim_chat_get_name(GaimChat *chat); |
6744 | 601 |
602 /** | |
5228 | 603 * Finds the buddy struct given a screenname and an account |
604 * | |
10071 | 605 * @param account The account this buddy belongs to |
6872 | 606 * @param name The buddy's screenname |
5228 | 607 * @return The buddy or NULL if the buddy does not exist |
608 */ | |
6695 | 609 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); |
6245 | 610 |
611 /** | |
6872 | 612 * Finds the buddy struct given a screenname, an account, and a group |
613 * | |
10071 | 614 * @param account The account this buddy belongs to |
6872 | 615 * @param name The buddy's screenname |
616 * @param group The group to look in | |
617 * @return The buddy or NULL if the buddy does not exist in the group | |
618 */ | |
619 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, | |
620 GaimGroup *group); | |
621 | |
622 /** | |
9285 | 623 * Finds all GaimBuddy structs given a screenname and an account |
6245 | 624 * |
10071 | 625 * @param account The account this buddy belongs to |
6245 | 626 * @param name The buddy's screenname |
627 * | |
628 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist | |
629 */ | |
630 GSList *gaim_find_buddies(GaimAccount *account, const char *name); | |
631 | |
5228 | 632 |
633 /** | |
634 * Finds a group by name | |
635 * | |
636 * @param name The groups name | |
637 * @return The group or NULL if the group does not exist | |
638 */ | |
6695 | 639 GaimGroup *gaim_find_group(const char *name); |
640 | |
641 /** | |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
642 * Finds a chat by name. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
643 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
644 * @param account The chat's account. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
645 * @param name The chat's name. |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
646 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
647 * @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
|
648 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
649 GaimChat *gaim_blist_find_chat(GaimAccount *account, const char *name); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
650 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
651 /** |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
652 * Returns the group of which the chat is a member. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
653 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
654 * @param chat The chat. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
655 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
656 * @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
|
657 */ |
7125 | 658 GaimGroup *gaim_chat_get_group(GaimChat *chat); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
659 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
660 /** |
5228 | 661 * Returns the group of which the buddy is a member. |
662 * | |
663 * @param buddy The buddy | |
664 * @return The group or NULL if the buddy is not in a group | |
665 */ | |
6695 | 666 GaimGroup *gaim_find_buddys_group(GaimBuddy *buddy); |
5228 | 667 |
668 | |
669 /** | |
670 * Returns a list of accounts that have buddies in this group | |
671 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
672 * @param g The group |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
673 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
674 * @return A list of gaim_accounts |
5228 | 675 */ |
6695 | 676 GSList *gaim_group_get_accounts(GaimGroup *g); |
5228 | 677 |
678 /** | |
679 * Determines whether an account owns any buddies in a given group | |
680 * | |
681 * @param g The group to search through. | |
682 * @param account The account. | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
683 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
684 * @return TRUE if there are any buddies in the group, or FALSE otherwise. |
5228 | 685 */ |
6695 | 686 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); |
5228 | 687 |
688 /** | |
5234 | 689 * Called when an account gets signed on. Tells the UI to update all the |
690 * buddies. | |
691 * | |
692 * @param account The account | |
693 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
694 void gaim_blist_add_account(GaimAccount *account); |
5234 | 695 |
696 | |
697 /** | |
5228 | 698 * Called when an account gets signed off. Sets the presence of all the buddies to 0 |
699 * and tells the UI to update them. | |
700 * | |
6695 | 701 * @param account The account |
5228 | 702 */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
703 void gaim_blist_remove_account(GaimAccount *account); |
5228 | 704 |
705 | |
706 /** | |
707 * Determines the total size of a group | |
708 * | |
709 * @param group The group | |
710 * @param offline Count buddies in offline accounts | |
711 * @return The number of buddies in the group | |
712 */ | |
6695 | 713 int gaim_blist_get_group_size(GaimGroup *group, gboolean offline); |
5228 | 714 |
715 /** | |
716 * Determines the number of online buddies in a group | |
717 * | |
718 * @param group The group | |
719 * @return The number of online buddies in the group, or 0 if the group is NULL | |
720 */ | |
6695 | 721 int gaim_blist_get_group_online_count(GaimGroup *group); |
5228 | 722 |
723 /*@}*/ | |
724 | |
725 /****************************************************************************************/ | |
726 /** @name Buddy list file management API */ | |
727 /****************************************************************************************/ | |
728 | |
729 /** | |
7117
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
730 * 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
|
731 * |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
732 * @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
|
733 * @param config This is the toc-style buddy list data |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
734 */ |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
735 void gaim_blist_parse_toc_buddy_list(GaimAccount *account, char *config); |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
736 |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
737 |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
738 /** |
5228 | 739 * Loads the buddy list from ~/.gaim/blist.xml. |
740 */ | |
741 void gaim_blist_load(); | |
742 | |
743 /** | |
10350 | 744 * Force an immediate write of the buddy list. Normally the buddy list is |
745 * saved automatically a few seconds after a change is made. | |
746 */ | |
747 void gaim_blist_sync(); | |
748 | |
749 /** | |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
750 * 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
|
751 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
752 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
753 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
754 * @param username The username of the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
755 * @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
|
756 * @param alias The optional alias for the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
757 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
758 void gaim_blist_request_add_buddy(GaimAccount *account, const char *username, |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
759 const char *group, const char *alias); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
760 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
761 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
762 * 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
|
763 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
764 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
765 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
766 * @param group The optional group to add the chat to. |
9000 | 767 * @param alias The optional alias for the chat. |
9939 | 768 * @param name The required chat name. |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
769 */ |
7859 | 770 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, |
9754 | 771 const char *alias, const char *name); |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
772 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
773 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
774 * 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
|
775 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
776 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
777 void gaim_blist_request_add_group(void); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
778 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
779 /** |
7693 | 780 * Associates a boolean with a node in the buddy list |
781 * | |
782 * @param node The node to associate the data with | |
783 * @param key The identifier for the data | |
784 * @param value The value to set | |
785 */ | |
786 void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value); | |
787 | |
788 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
789 * Retrieves a named boolean setting from a node in the buddy list |
7693 | 790 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
791 * @param node The node to retrieve the data from |
7693 | 792 * @param key The identifier of the data |
793 * | |
794 * @return The value, or FALSE if there is no setting | |
795 */ | |
796 gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key); | |
797 | |
798 /** | |
799 * Associates an integer with a node in the buddy list | |
800 * | |
801 * @param node The node to associate the data with | |
802 * @param key The identifier for the data | |
803 * @param value The value to set | |
804 */ | |
805 void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value); | |
806 | |
807 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
808 * Retrieves a named integer setting from a node in the buddy list |
7693 | 809 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
810 * @param node The node to retrieve the data from |
7693 | 811 * @param key The identifier of the data |
812 * | |
813 * @return The value, or 0 if there is no setting | |
814 */ | |
815 int gaim_blist_node_get_int(GaimBlistNode *node, const char *key); | |
816 | |
817 /** | |
818 * Associates a string with a node in the buddy list | |
819 * | |
820 * @param node The node to associate the data with | |
821 * @param key The identifier for the data | |
822 * @param value The value to set | |
823 */ | |
824 void gaim_blist_node_set_string(GaimBlistNode *node, const char *key, | |
825 const char *value); | |
826 | |
827 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
828 * Retrieves a named string setting from a node in the buddy list |
7693 | 829 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
830 * @param node The node to retrieve the data from |
7693 | 831 * @param key The identifier of the data |
832 * | |
833 * @return The value, or NULL if there is no setting | |
834 */ | |
835 const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key); | |
836 | |
837 /** | |
7811 | 838 * Removes a named setting from a blist node |
839 * | |
840 * @param node The node from which to remove the setting | |
841 * @param key The name of the setting | |
842 */ | |
843 void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key); | |
844 | |
10548 | 845 /** |
846 * Set the flags for the given node. Setting a node's flags will overwrite | |
847 * the old flags, so if you want to save them, you must first call | |
848 * gaim_blist_node_get_flags and modify that appropriately. | |
849 * | |
850 * @param node The node on which to set the flags. | |
851 * @param flags The flags to set. This is a bitmask. | |
852 */ | |
853 void gaim_blist_node_set_flags(GaimBlistNode *node, GaimBlistNodeFlags flags); | |
854 | |
855 /** | |
856 * Get the current flags on a given node. | |
857 * | |
858 * @param node The node from which to get the flags. | |
859 * | |
860 * @return The flags on the node. This is a bitmask. | |
861 */ | |
862 GaimBlistNodeFlags gaim_blist_node_get_flags(GaimBlistNode *node); | |
863 | |
5228 | 864 /*@}*/ |
865 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
866 |
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
867 /** |
9030 | 868 * Retrieves the extended menu items for a buddy list node. |
869 * @param n The blist node for which to obtain the extended menu items. | |
870 * @return list of GaimBlistNodeAction items, as harvested by the | |
871 * blist-node-extended-menu signal. | |
872 */ | |
873 GList *gaim_blist_node_get_extended_menu(GaimBlistNode *n); | |
874 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
875 |
8952 | 876 /** |
9030 | 877 * Creates a new GaimBlistNodeAction. |
878 * @param label The text label to display for this action. | |
879 * @param callback The function to be called when the action is used on | |
880 * a selected GaimBlistNode. | |
881 * @param data Additional data, to be passed to the callback | |
882 */ | |
883 GaimBlistNodeAction *gaim_blist_node_action_new(char *label, | |
884 void (*callback)(GaimBlistNode *, gpointer), gpointer data); | |
8952 | 885 |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
886 |
5228 | 887 /**************************************************************************/ |
888 /** @name UI Registration Functions */ | |
889 /**************************************************************************/ | |
890 /*@{*/ | |
891 | |
892 /** | |
893 * Sets the UI operations structure to be used for the buddy list. | |
894 * | |
895 * @param ops The ops struct. | |
896 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
897 void gaim_blist_set_ui_ops(GaimBlistUiOps *ops); |
5228 | 898 |
899 /** | |
900 * Returns the UI operations structure to be used for the buddy list. | |
901 * | |
902 * @return The UI operations structure. | |
903 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
904 GaimBlistUiOps *gaim_blist_get_ui_ops(void); |
5228 | 905 |
906 /*@}*/ | |
907 | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
908 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
909 /** @name Buddy List Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
910 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
911 /*@{*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
912 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
913 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
914 * Returns the handle for the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
915 * |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
916 * @return The buddy list subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
917 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
918 void *gaim_blist_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
919 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
920 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
921 * Initializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
922 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
923 void gaim_blist_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
924 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
925 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
926 * Uninitializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
927 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
928 void gaim_blist_uninit(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
929 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
930 /*@}*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
931 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
932 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
933 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
934 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
935 |
9713 | 936 #endif /* _GAIM_BLIST_H_ */ |