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