Mercurial > pidgin.yaz
annotate src/blist.h @ 12053:1ec93dd2f359
[gaim-migrate @ 14348]
doxygen and ChangeLog.API updates from Casey Harkins
committer: Tailor Script <tailor@pidgin.im>
author | Nathan Walp <nwalp@pidgin.im> |
---|---|
date | Sat, 12 Nov 2005 16:49:10 +0000 |
parents | 73777ad45562 |
children | 2cb1beb9da51 |
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 |
9944 | 61 #define GAIM_BUDDY_IS_ONLINE(b) \ |
62 ((b) != NULL && gaim_account_is_connected((b)->account) && \ | |
63 gaim_presence_is_online(gaim_buddy_get_presence(b))) | |
5228 | 64 |
9787 | 65 typedef enum |
66 { | |
10008 | 67 GAIM_BLIST_NODE_FLAG_NO_SAVE = 1 /**< node should not be saved with the buddy list */ |
68 | |
9787 | 69 } GaimBlistNodeFlags; |
70 | |
71 #define GAIM_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f)) | |
72 #define GAIM_BLIST_NODE_SHOULD_SAVE(b) (! GAIM_BLIST_NODE_HAS_FLAG(b, GAIM_BLIST_NODE_FLAG_NO_SAVE)) | |
73 | |
10008 | 74 #include "account.h" |
75 #include "buddyicon.h" | |
76 #include "status.h" | |
5228 | 77 |
78 /**************************************************************************/ | |
79 /* Data Structures */ | |
80 /**************************************************************************/ | |
81 | |
82 /** | |
10566
62fc579810f4
[gaim-migrate @ 11949]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10548
diff
changeset
|
83 * A Buddy list node. This can represent a group, a buddy, or anything else. |
62fc579810f4
[gaim-migrate @ 11949]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10548
diff
changeset
|
84 * This is a base class for struct buddy and struct group and for anything |
62fc579810f4
[gaim-migrate @ 11949]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10548
diff
changeset
|
85 * else that wants to put itself in the buddy list. */ |
5228 | 86 struct _GaimBlistNode { |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
87 GaimBlistNodeType type; /**< The type of node this is */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
88 GaimBlistNode *prev; /**< The sibling before this buddy. */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
89 GaimBlistNode *next; /**< The sibling after this buddy. */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
90 GaimBlistNode *parent; /**< The parent of this node */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
91 GaimBlistNode *child; /**< The child of this node */ |
7693 | 92 GHashTable *settings; /**< per-node settings */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
93 void *ui_data; /**< The UI can put data here. */ |
9787 | 94 GaimBlistNodeFlags flags; /**< The buddy flags */ |
5228 | 95 }; |
96 | |
97 /** | |
98 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
99 */ | |
6695 | 100 struct _GaimBuddy { |
5228 | 101 GaimBlistNode node; /**< The node that this buddy inherits from */ |
102 char *name; /**< The screenname of the buddy. */ | |
103 char *alias; /**< The user-set alias of the buddy */ | |
6695 | 104 char *server_alias; /**< The server-specified alias of the buddy. (i.e. MSN "Friendly Names") */ |
5228 | 105 void *proto_data; /**< This allows the prpl to associate whatever data it wants with a buddy */ |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
106 GaimBuddyIcon *icon; /**< The buddy icon. */ |
11972 | 107 GaimAccount *account; /**< the account this buddy belongs to */ |
9949 | 108 GaimPresence *presence; |
5228 | 109 }; |
110 | |
111 /** | |
6695 | 112 * A contact. This contains everything Gaim will ever need to know about a contact. |
113 */ | |
114 struct _GaimContact { | |
6755 | 115 GaimBlistNode node; /**< The node that this contact inherits from. */ |
116 char *alias; /**< The user-set alias of the contact */ | |
117 int totalsize; /**< The number of buddies in this contact */ | |
118 int currentsize; /**< The number of buddies in this contact corresponding to online accounts */ | |
119 int online; /**< The number of buddies in this contact who are currently online */ | |
6843 | 120 GaimBuddy *priority; /**< The "top" buddy for this contact */ |
10378 | 121 gboolean priority_valid; /**< Is priority valid? */ |
6695 | 122 }; |
123 | |
124 | |
125 /** | |
5228 | 126 * A group. This contains everything Gaim will ever need to know about a group. |
127 */ | |
6695 | 128 struct _GaimGroup { |
5228 | 129 GaimBlistNode node; /**< The node that this group inherits from */ |
130 char *name; /**< The name of this group. */ | |
6695 | 131 int totalsize; /**< The number of chats and contacts in this group */ |
132 int currentsize; /**< The number of chats and contacts in this group corresponding to online accounts */ | |
133 int online; /**< The number of chats and contacts in this group who are currently online */ | |
5228 | 134 }; |
135 | |
5234 | 136 /** |
6695 | 137 * A chat. This contains everything Gaim needs to put a chat room in the |
5234 | 138 * buddy list. |
139 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
140 struct _GaimChat { |
5234 | 141 GaimBlistNode node; /**< The node that this chat inherits from */ |
142 char *alias; /**< The display name of this chat. */ | |
143 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
|
144 GaimAccount *account; /**< The account this chat is attached to */ |
5234 | 145 }; |
146 | |
5228 | 147 |
148 /** | |
149 * The Buddy List | |
150 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
151 struct _GaimBuddyList { |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
152 GaimBlistNode *root; /**< The first node in the buddy list */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
153 GHashTable *buddies; /**< Every buddy in this list */ |
5228 | 154 |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
155 void *ui_data; /**< UI-specific data. */ |
5228 | 156 }; |
157 | |
9030 | 158 struct _GaimBlistNodeAction { |
159 char *label; | |
160 void (*callback)(GaimBlistNode *, gpointer); | |
161 gpointer data; | |
10662
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
162 GList *children; |
9030 | 163 }; |
164 | |
165 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
166 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
167 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
168 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
169 |
5228 | 170 /**************************************************************************/ |
171 /** @name Buddy List API */ | |
172 /**************************************************************************/ | |
173 /*@{*/ | |
174 | |
175 /** | |
176 * Creates a new buddy list | |
10071 | 177 * |
178 * @return The new buddy list. | |
5228 | 179 */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
180 GaimBuddyList *gaim_blist_new(); |
5228 | 181 |
182 /** | |
183 * Sets the main buddy list. | |
184 * | |
10071 | 185 * @param blist The buddy list you want to use. |
5228 | 186 */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
187 void gaim_set_blist(GaimBuddyList *blist); |
5228 | 188 |
189 /** | |
190 * Returns the main buddy list. | |
191 * | |
192 * @return The main buddy list. | |
193 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
194 GaimBuddyList *gaim_get_blist(void); |
5228 | 195 |
196 /** | |
197 * Shows the buddy list, creating a new one if necessary. | |
198 */ | |
199 void gaim_blist_show(); | |
200 | |
201 | |
202 /** | |
203 * Destroys the buddy list window. | |
204 */ | |
205 void gaim_blist_destroy(); | |
206 | |
207 /** | |
208 * Hides or unhides the buddy list. | |
209 * | |
210 * @param show Whether or not to show the buddy list | |
211 */ | |
212 void gaim_blist_set_visible(gboolean show); | |
213 | |
214 /** | |
215 * Updates a buddy's status. | |
5234 | 216 * |
10052 | 217 * @param buddy The buddy whose status has changed. |
218 * @param old_status The status from which we are changing. | |
5228 | 219 */ |
10052 | 220 void gaim_blist_update_buddy_status(GaimBuddy *buddy, GaimStatus *old_status); |
5228 | 221 |
7950 | 222 /** |
5228 | 223 * Updates a buddy's icon. |
224 * | |
225 * @param buddy The buddy whose buddy icon has changed | |
226 */ | |
6695 | 227 void gaim_blist_update_buddy_icon(GaimBuddy *buddy); |
5228 | 228 |
229 /** | |
230 * Renames a buddy in the buddy list. | |
231 * | |
232 * @param buddy The buddy whose name will be changed. | |
233 * @param name The new name of the buddy. | |
234 */ | |
6695 | 235 void gaim_blist_rename_buddy(GaimBuddy *buddy, const char *name); |
5228 | 236 |
237 | |
238 /** | |
239 * Aliases a buddy in the buddy list. | |
240 * | |
241 * @param buddy The buddy whose alias will be changed. | |
242 * @param alias The buddy's alias. | |
243 */ | |
6695 | 244 void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias); |
5228 | 245 |
5234 | 246 /** |
6059 | 247 * Sets the server-sent alias of a buddy in the buddy list. |
6058 | 248 * |
249 * @param buddy The buddy whose alias will be changed. | |
250 * @param alias The buddy's "official" alias. | |
251 */ | |
6695 | 252 void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias); |
6058 | 253 |
254 /** | |
5234 | 255 * Aliases a chat in the buddy list. |
256 * | |
257 * @param chat The chat whose alias will be changed. | |
258 * @param alias The chat's new alias. | |
259 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
260 void gaim_blist_alias_chat(GaimChat *chat, const char *alias); |
5228 | 261 |
262 /** | |
263 * Renames a group | |
264 * | |
265 * @param group The group to rename | |
266 * @param name The new name | |
267 */ | |
6695 | 268 void gaim_blist_rename_group(GaimGroup *group, const char *name); |
5228 | 269 |
5234 | 270 /** |
271 * Creates a new chat for the buddy list | |
272 * | |
273 * @param account The account this chat will get added to | |
274 * @param alias The alias of the new chat | |
275 * @param components The info the prpl needs to join the chat | |
276 * @return A newly allocated chat | |
277 */ | |
7125 | 278 GaimChat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); |
5234 | 279 |
280 /** | |
281 * Adds a new chat to the buddy list. | |
282 * | |
283 * The chat will be inserted right after node or appended to the end | |
284 * of group if node is NULL. If both are NULL, the buddy will be added to | |
285 * the "Chats" group. | |
286 * | |
287 * @param chat The new chat who gets added | |
288 * @param group The group to add the new chat to. | |
289 * @param node The insertion point | |
290 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
291 void gaim_blist_add_chat(GaimChat *chat, GaimGroup *group, GaimBlistNode *node); |
5228 | 292 |
293 /** | |
294 * Creates a new buddy | |
295 * | |
296 * @param account The account this buddy will get added to | |
297 * @param screenname The screenname of the new buddy | |
298 * @param alias The alias of the new buddy (or NULL if unaliased) | |
299 * @return A newly allocated buddy | |
300 */ | |
6695 | 301 GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); |
5228 | 302 |
303 /** | |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
304 * Sets a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
305 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
306 * 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
|
307 * call gaim_buddy_icon_set_data(). |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
308 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
309 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
310 * @param icon The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
311 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
312 * @see gaim_buddy_icon_set_data() |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
313 */ |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
314 void gaim_buddy_set_icon(GaimBuddy *buddy, GaimBuddyIcon *icon); |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
315 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
316 /** |
10037
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
317 * Returns a buddy's account. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
318 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
319 * @param buddy The buddy. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
320 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
321 * @return The account |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
322 */ |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
323 GaimAccount *gaim_buddy_get_account(const GaimBuddy *buddy); |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
324 |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
325 /** |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
326 * Returns a buddy's name |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
327 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
328 * @param buddy The buddy. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
329 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
330 * @return The name. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
331 */ |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
332 const char *gaim_buddy_get_name(const GaimBuddy *buddy); |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
333 |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
334 /** |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
335 * Returns a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
336 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
337 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
338 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
339 * @return The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
340 */ |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
341 GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy); |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
342 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
343 /** |
7312 | 344 * Returns a buddy's contact. |
345 * | |
346 * @param buddy The buddy. | |
347 * | |
348 * @return The buddy's contact. | |
349 */ | |
350 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); | |
351 | |
352 /** | |
9944 | 353 * Returns a buddy's presence. |
354 * | |
355 * @param buddy The buddy. | |
356 * | |
357 * @return The buddy's presence. | |
358 */ | |
359 GaimPresence *gaim_buddy_get_presence(const GaimBuddy *buddy); | |
360 | |
361 /** | |
5228 | 362 * Adds a new buddy to the buddy list. |
363 * | |
6695 | 364 * The buddy will be inserted right after node or prepended to the |
365 * group if node is NULL. If both are NULL, the buddy will be added to | |
5228 | 366 * the "Buddies" group. |
367 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
368 * @param buddy The new buddy who gets added |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
369 * @param contact The optional contact to place the buddy in. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
370 * @param group The group to add the new buddy to. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
371 * @param node The insertion point |
5228 | 372 */ |
6695 | 373 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); |
5228 | 374 |
375 /** | |
376 * Creates a new group | |
377 * | |
6695 | 378 * You can't have more than one group with the same name. Sorry. If you pass |
379 * this the * name of a group that already exists, it will return that group. | |
5228 | 380 * |
381 * @param name The name of the new group | |
6695 | 382 * @return A new group struct |
5228 | 383 */ |
6695 | 384 GaimGroup *gaim_group_new(const char *name); |
5228 | 385 |
386 /** | |
387 * Adds a new group to the buddy list. | |
388 * | |
6695 | 389 * The new group will be inserted after insert or prepended to the list if |
390 * node is NULL. | |
391 * | |
392 * @param group The group | |
393 * @param node The insertion point | |
394 */ | |
395 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
396 | |
397 /** | |
398 * Creates a new contact | |
5228 | 399 * |
6695 | 400 * @return A new contact struct |
5228 | 401 */ |
6695 | 402 GaimContact *gaim_contact_new(); |
403 | |
404 /** | |
405 * Adds a new contact to the buddy list. | |
406 * | |
407 * The new contact will be inserted after insert or prepended to the list if | |
408 * node is NULL. | |
409 * | |
410 * @param contact The contact | |
411 * @param group The group to add the contact to | |
412 * @param node The insertion point | |
413 */ | |
414 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
415 | |
416 /** | |
6965 | 417 * Merges two contacts |
418 * | |
419 * All of the buddies from source will be moved to target | |
420 * | |
421 * @param source The contact to merge | |
7246 | 422 * @param node The place to merge to (a buddy or contact) |
6965 | 423 */ |
7246 | 424 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); |
6965 | 425 |
426 /** | |
6695 | 427 * Returns the highest priority buddy for a given contact. |
428 * | |
429 * @param contact The contact | |
430 * @return The highest priority buddy | |
431 */ | |
432 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
5228 | 433 |
434 /** | |
6755 | 435 * Sets the alias for a contact. |
436 * | |
437 * @param contact The contact | |
438 * @param alias The alias to set, or NULL to unset | |
439 */ | |
440 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
441 | |
442 /** | |
443 * Gets the alias for a contact. | |
444 * | |
445 * @param contact The contact | |
446 * @return The alias, or NULL if it is not set. | |
447 */ | |
448 const char *gaim_contact_get_alias(GaimContact *contact); | |
449 | |
450 /** | |
9787 | 451 * Determines whether an account owns any buddies in a given contact |
452 * | |
453 * @param contact The contact to search through. | |
454 * @param account The account. | |
455 * | |
456 * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise. | |
457 */ | |
458 gboolean gaim_contact_on_account(GaimContact *contact, GaimAccount *account); | |
459 | |
460 /** | |
10378 | 461 * Invalidates the priority buddy so that the next call to |
462 * gaim_contact_get_priority_buddy recomputes it. | |
9944 | 463 * |
10378 | 464 * @param contact The contact |
9944 | 465 */ |
10378 | 466 void gaim_contact_invalidate_priority_buddy(GaimContact *contact); |
9944 | 467 /** |
5228 | 468 * Removes a buddy from the buddy list and frees the memory allocated to it. |
469 * | |
470 * @param buddy The buddy to be removed | |
471 */ | |
6695 | 472 void gaim_blist_remove_buddy(GaimBuddy *buddy); |
473 | |
474 /** | |
475 * Removes a contact, and any buddies it contains, and frees the memory | |
476 * allocated to it. | |
477 * | |
478 * @param contact The contact to be removed | |
479 */ | |
480 void gaim_blist_remove_contact(GaimContact *contact); | |
5228 | 481 |
482 /** | |
5234 | 483 * Removes a chat from the buddy list and frees the memory allocated to it. |
484 * | |
485 * @param chat The chat to be removed | |
486 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
487 void gaim_blist_remove_chat(GaimChat *chat); |
5234 | 488 |
489 /** | |
5228 | 490 * Removes a group from the buddy list and frees the memory allocated to it and to |
491 * its children | |
492 * | |
493 * @param group The group to be removed | |
494 */ | |
6695 | 495 void gaim_blist_remove_group(GaimGroup *group); |
5228 | 496 |
497 /** | |
498 * Returns the alias of a buddy. | |
499 * | |
500 * @param buddy The buddy whose name will be returned. | |
10349 | 501 * @return The alias (if set), server alias (if set), |
502 * or NULL. | |
5228 | 503 */ |
9620 | 504 const char *gaim_buddy_get_alias_only(GaimBuddy *buddy); |
5228 | 505 |
506 | |
507 /** | |
9620 | 508 * Returns the correct name to display for a buddy, taking the contact alias |
509 * into account. In order of precedence: the buddy's alias; the buddy's | |
510 * contact alias; the buddy's server alias; the buddy's user name. | |
511 * | |
512 * @param buddy The buddy whose name will be returned | |
9635 | 513 * @return The appropriate name or alias, or NULL. |
9620 | 514 * |
515 */ | |
516 const char *gaim_buddy_get_contact_alias(GaimBuddy *buddy); | |
517 | |
10349 | 518 /** |
519 * Returns the correct alias for this user, ignoring server aliases. Used | |
520 * when a user-recognizable name is required. In order: buddy's alias; buddy's | |
521 * contact alias; buddy's user name. | |
522 * | |
523 * @param buddy The buddy whose alias will be returned. | |
524 * @return The appropriate name or alias. | |
525 */ | |
526 const char *gaim_buddy_get_local_alias(GaimBuddy *buddy); | |
9620 | 527 |
528 /** | |
529 * Returns the correct name to display for a buddy. In order of precedence: | |
530 * the buddy's alias; the buddy's server alias; the buddy's contact alias; | |
531 * the buddy's user name. | |
5228 | 532 * |
533 * @param buddy The buddy whose name will be returned. | |
9635 | 534 * @return The appropriate name or alias, or NULL |
5228 | 535 */ |
9620 | 536 const char *gaim_buddy_get_alias(GaimBuddy *buddy); |
5228 | 537 |
538 /** | |
6744 | 539 * Returns the correct name to display for a blist chat. |
540 * | |
541 * @param chat The chat whose name will be returned. | |
542 * @return The alias (if set), or first component value. | |
543 */ | |
7125 | 544 const char *gaim_chat_get_name(GaimChat *chat); |
6744 | 545 |
546 /** | |
5228 | 547 * Finds the buddy struct given a screenname and an account |
548 * | |
10071 | 549 * @param account The account this buddy belongs to |
6872 | 550 * @param name The buddy's screenname |
5228 | 551 * @return The buddy or NULL if the buddy does not exist |
552 */ | |
6695 | 553 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); |
6245 | 554 |
555 /** | |
6872 | 556 * Finds the buddy struct given a screenname, an account, and a group |
557 * | |
10071 | 558 * @param account The account this buddy belongs to |
6872 | 559 * @param name The buddy's screenname |
560 * @param group The group to look in | |
561 * @return The buddy or NULL if the buddy does not exist in the group | |
562 */ | |
563 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, | |
564 GaimGroup *group); | |
565 | |
566 /** | |
9285 | 567 * Finds all GaimBuddy structs given a screenname and an account |
6245 | 568 * |
10071 | 569 * @param account The account this buddy belongs to |
6245 | 570 * @param name The buddy's screenname |
571 * | |
572 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist | |
573 */ | |
574 GSList *gaim_find_buddies(GaimAccount *account, const char *name); | |
575 | |
5228 | 576 |
577 /** | |
578 * Finds a group by name | |
579 * | |
580 * @param name The groups name | |
581 * @return The group or NULL if the group does not exist | |
582 */ | |
6695 | 583 GaimGroup *gaim_find_group(const char *name); |
584 | |
585 /** | |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
586 * Finds a chat by name. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
587 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
588 * @param account The chat's account. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
589 * @param name The chat's name. |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
590 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
591 * @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
|
592 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
593 GaimChat *gaim_blist_find_chat(GaimAccount *account, const char *name); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
594 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
595 /** |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
596 * Returns the group of which the chat is a member. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
597 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
598 * @param chat The chat. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
599 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
600 * @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
|
601 */ |
7125 | 602 GaimGroup *gaim_chat_get_group(GaimChat *chat); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
603 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
604 /** |
5228 | 605 * Returns the group of which the buddy is a member. |
606 * | |
607 * @param buddy The buddy | |
608 * @return The group or NULL if the buddy is not in a group | |
609 */ | |
6695 | 610 GaimGroup *gaim_find_buddys_group(GaimBuddy *buddy); |
5228 | 611 |
612 | |
613 /** | |
614 * Returns a list of accounts that have buddies in this group | |
615 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
616 * @param g The group |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
617 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
618 * @return A list of gaim_accounts |
5228 | 619 */ |
6695 | 620 GSList *gaim_group_get_accounts(GaimGroup *g); |
5228 | 621 |
622 /** | |
623 * Determines whether an account owns any buddies in a given group | |
624 * | |
625 * @param g The group to search through. | |
626 * @param account The account. | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
627 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
628 * @return TRUE if there are any buddies in the group, or FALSE otherwise. |
5228 | 629 */ |
6695 | 630 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); |
5228 | 631 |
632 /** | |
5234 | 633 * Called when an account gets signed on. Tells the UI to update all the |
634 * buddies. | |
635 * | |
636 * @param account The account | |
637 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
638 void gaim_blist_add_account(GaimAccount *account); |
5234 | 639 |
640 | |
641 /** | |
5228 | 642 * Called when an account gets signed off. Sets the presence of all the buddies to 0 |
643 * and tells the UI to update them. | |
644 * | |
6695 | 645 * @param account The account |
5228 | 646 */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
647 void gaim_blist_remove_account(GaimAccount *account); |
5228 | 648 |
649 | |
650 /** | |
651 * Determines the total size of a group | |
652 * | |
653 * @param group The group | |
654 * @param offline Count buddies in offline accounts | |
655 * @return The number of buddies in the group | |
656 */ | |
6695 | 657 int gaim_blist_get_group_size(GaimGroup *group, gboolean offline); |
5228 | 658 |
659 /** | |
660 * Determines the number of online buddies in a group | |
661 * | |
662 * @param group The group | |
663 * @return The number of online buddies in the group, or 0 if the group is NULL | |
664 */ | |
6695 | 665 int gaim_blist_get_group_online_count(GaimGroup *group); |
5228 | 666 |
667 /*@}*/ | |
668 | |
669 /****************************************************************************************/ | |
670 /** @name Buddy list file management API */ | |
671 /****************************************************************************************/ | |
672 | |
673 /** | |
674 * Loads the buddy list from ~/.gaim/blist.xml. | |
675 */ | |
676 void gaim_blist_load(); | |
677 | |
678 /** | |
10704 | 679 * Schedule a save of the blist.xml file. This is used by the privacy |
680 * API whenever the privacy settings are changed. If you make a change | |
681 * to blist.xml using one of the functions in the buddy list API, then | |
682 * the buddy list is saved automatically, so you should not need to | |
683 * call this. | |
10350 | 684 */ |
10704 | 685 void gaim_blist_schedule_save(); |
10350 | 686 |
687 /** | |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
688 * 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
|
689 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
690 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
691 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
692 * @param username The username of the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
693 * @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
|
694 * @param alias The optional alias for the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
695 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
696 void gaim_blist_request_add_buddy(GaimAccount *account, const char *username, |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
697 const char *group, const char *alias); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
698 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
699 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
700 * 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
|
701 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
702 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
703 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
704 * @param group The optional group to add the chat to. |
9000 | 705 * @param alias The optional alias for the chat. |
9939 | 706 * @param name The required chat name. |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
707 */ |
7859 | 708 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, |
9754 | 709 const char *alias, const char *name); |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
710 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
711 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
712 * Requests from the user information needed to add a group to the |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
713 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
714 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
715 void gaim_blist_request_add_group(void); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
716 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
717 /** |
7693 | 718 * Associates a boolean with a node in the buddy list |
719 * | |
720 * @param node The node to associate the data with | |
721 * @param key The identifier for the data | |
722 * @param value The value to set | |
723 */ | |
724 void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value); | |
725 | |
726 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
727 * Retrieves a named boolean setting from a node in the buddy list |
7693 | 728 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
729 * @param node The node to retrieve the data from |
7693 | 730 * @param key The identifier of the data |
731 * | |
732 * @return The value, or FALSE if there is no setting | |
733 */ | |
734 gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key); | |
735 | |
736 /** | |
737 * Associates an integer with a node in the buddy list | |
738 * | |
739 * @param node The node to associate the data with | |
740 * @param key The identifier for the data | |
741 * @param value The value to set | |
742 */ | |
743 void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value); | |
744 | |
745 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
746 * Retrieves a named integer setting from a node in the buddy list |
7693 | 747 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
748 * @param node The node to retrieve the data from |
7693 | 749 * @param key The identifier of the data |
750 * | |
751 * @return The value, or 0 if there is no setting | |
752 */ | |
753 int gaim_blist_node_get_int(GaimBlistNode *node, const char *key); | |
754 | |
755 /** | |
756 * Associates a string with a node in the buddy list | |
757 * | |
758 * @param node The node to associate the data with | |
759 * @param key The identifier for the data | |
760 * @param value The value to set | |
761 */ | |
762 void gaim_blist_node_set_string(GaimBlistNode *node, const char *key, | |
763 const char *value); | |
764 | |
765 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
766 * Retrieves a named string setting from a node in the buddy list |
7693 | 767 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
768 * @param node The node to retrieve the data from |
7693 | 769 * @param key The identifier of the data |
770 * | |
771 * @return The value, or NULL if there is no setting | |
772 */ | |
773 const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key); | |
774 | |
775 /** | |
7811 | 776 * Removes a named setting from a blist node |
777 * | |
778 * @param node The node from which to remove the setting | |
779 * @param key The name of the setting | |
780 */ | |
781 void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key); | |
782 | |
10548 | 783 /** |
784 * Set the flags for the given node. Setting a node's flags will overwrite | |
785 * the old flags, so if you want to save them, you must first call | |
786 * gaim_blist_node_get_flags and modify that appropriately. | |
787 * | |
788 * @param node The node on which to set the flags. | |
789 * @param flags The flags to set. This is a bitmask. | |
790 */ | |
791 void gaim_blist_node_set_flags(GaimBlistNode *node, GaimBlistNodeFlags flags); | |
792 | |
793 /** | |
794 * Get the current flags on a given node. | |
795 * | |
796 * @param node The node from which to get the flags. | |
797 * | |
798 * @return The flags on the node. This is a bitmask. | |
799 */ | |
800 GaimBlistNodeFlags gaim_blist_node_get_flags(GaimBlistNode *node); | |
801 | |
5228 | 802 /*@}*/ |
803 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
804 |
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
805 /** |
9030 | 806 * Retrieves the extended menu items for a buddy list node. |
807 * @param n The blist node for which to obtain the extended menu items. | |
808 * @return list of GaimBlistNodeAction items, as harvested by the | |
809 * blist-node-extended-menu signal. | |
810 */ | |
811 GList *gaim_blist_node_get_extended_menu(GaimBlistNode *n); | |
812 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
813 |
8952 | 814 /** |
9030 | 815 * Creates a new GaimBlistNodeAction. |
10662
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
816 * @param label The text label to display for this action. |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
817 * @param callback The function to be called when the action is used on |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
818 * a selected GaimBlistNode. |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
819 * @param data Additional data, to be passed to the callback |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
820 * @param children A GList of GaimBlistNodeActions to be added as a |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
821 * submenu of the action. |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
822 * @return The GaimBlistNodeAction. |
9030 | 823 */ |
10662
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
824 GaimBlistNodeAction *gaim_blist_node_action_new(char *label, |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
825 void (*callback)(GaimBlistNode *, gpointer), gpointer data, |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
826 GList *children); |
8952 | 827 |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
828 |
5228 | 829 /**************************************************************************/ |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
830 /** @name Buddy List Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
831 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
832 /*@{*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
833 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
834 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
835 * Returns the handle for the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
836 * |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
837 * @return The buddy list subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
838 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
839 void *gaim_blist_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
840 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
841 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
842 * Initializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
843 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
844 void gaim_blist_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
845 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
846 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
847 * Uninitializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
848 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
849 void gaim_blist_uninit(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
850 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
851 /*@}*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
852 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
853 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
854 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
855 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
856 |
9713 | 857 #endif /* _GAIM_BLIST_H_ */ |