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