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