Mercurial > pidgin
annotate src/blist.h @ 12370:0d4484b7a46a
[gaim-migrate @ 14674]
Changing the prototypes here broke FreeBSD. Looking at what was changed, I think reverting the changes for this file is best.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Tue, 06 Dec 2005 07:59:07 +0000 |
parents | fc464a0abccc |
children | e63a80be5227 |
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 */ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12319
diff
changeset
|
207 GaimBuddyList *gaim_blist_new(void); |
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 */ | |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12319
diff
changeset
|
236 void gaim_blist_show(void); |
5228 | 237 |
238 | |
239 /** | |
240 * Destroys the buddy list window. | |
241 */ | |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12319
diff
changeset
|
242 void gaim_blist_destroy(void); |
5228 | 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 |
12319
7630a95f3b8b
[gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents:
12286
diff
changeset
|
274 /** |
7630a95f3b8b
[gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents:
12286
diff
changeset
|
275 * Aliases a contact in the buddy list. |
7630a95f3b8b
[gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents:
12286
diff
changeset
|
276 * |
7630a95f3b8b
[gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents:
12286
diff
changeset
|
277 * @param contact The contact whose alias will be changed. |
7630a95f3b8b
[gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents:
12286
diff
changeset
|
278 * @param alias The contact's alias. |
7630a95f3b8b
[gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents:
12286
diff
changeset
|
279 */ |
7630a95f3b8b
[gaim-migrate @ 14623]
Richard Laager <rlaager@wiktel.com>
parents:
12286
diff
changeset
|
280 void gaim_blist_alias_contact(GaimContact *contact, const char *alias); |
5228 | 281 |
282 /** | |
283 * Aliases a buddy in the buddy list. | |
284 * | |
285 * @param buddy The buddy whose alias will be changed. | |
286 * @param alias The buddy's alias. | |
287 */ | |
6695 | 288 void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias); |
5228 | 289 |
5234 | 290 /** |
6059 | 291 * Sets the server-sent alias of a buddy in the buddy list. |
6058 | 292 * |
293 * @param buddy The buddy whose alias will be changed. | |
294 * @param alias The buddy's "official" alias. | |
295 */ | |
6695 | 296 void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias); |
6058 | 297 |
298 /** | |
5234 | 299 * Aliases a chat in the buddy list. |
300 * | |
301 * @param chat The chat whose alias will be changed. | |
302 * @param alias The chat's new alias. | |
303 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
304 void gaim_blist_alias_chat(GaimChat *chat, const char *alias); |
5228 | 305 |
306 /** | |
307 * Renames a group | |
308 * | |
309 * @param group The group to rename | |
310 * @param name The new name | |
311 */ | |
6695 | 312 void gaim_blist_rename_group(GaimGroup *group, const char *name); |
5228 | 313 |
5234 | 314 /** |
315 * Creates a new chat for the buddy list | |
316 * | |
317 * @param account The account this chat will get added to | |
318 * @param alias The alias of the new chat | |
319 * @param components The info the prpl needs to join the chat | |
320 * @return A newly allocated chat | |
321 */ | |
7125 | 322 GaimChat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); |
5234 | 323 |
324 /** | |
325 * Adds a new chat to the buddy list. | |
326 * | |
327 * The chat will be inserted right after node or appended to the end | |
328 * of group if node is NULL. If both are NULL, the buddy will be added to | |
329 * the "Chats" group. | |
330 * | |
331 * @param chat The new chat who gets added | |
332 * @param group The group to add the new chat to. | |
333 * @param node The insertion point | |
334 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
335 void gaim_blist_add_chat(GaimChat *chat, GaimGroup *group, GaimBlistNode *node); |
5228 | 336 |
337 /** | |
338 * Creates a new buddy | |
339 * | |
340 * @param account The account this buddy will get added to | |
341 * @param screenname The screenname of the new buddy | |
342 * @param alias The alias of the new buddy (or NULL if unaliased) | |
343 * @return A newly allocated buddy | |
344 */ | |
6695 | 345 GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); |
5228 | 346 |
347 /** | |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
348 * Sets a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
349 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
350 * 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
|
351 * call gaim_buddy_icon_set_data(). |
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 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
354 * @param icon The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
355 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
356 * @see gaim_buddy_icon_set_data() |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
357 */ |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
358 void gaim_buddy_set_icon(GaimBuddy *buddy, GaimBuddyIcon *icon); |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
359 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
360 /** |
10037
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
361 * Returns a buddy's account. |
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 * @param buddy The buddy. |
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 * @return The account |
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 GaimAccount *gaim_buddy_get_account(const GaimBuddy *buddy); |
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 /** |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
370 * Returns a buddy's name |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
371 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
372 * @param buddy The buddy. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
373 * |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
374 * @return The name. |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
375 */ |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
376 const char *gaim_buddy_get_name(const GaimBuddy *buddy); |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
377 |
e6e68b9db19b
[gaim-migrate @ 10996]
Luke Schierer <lschiere@pidgin.im>
parents:
10012
diff
changeset
|
378 /** |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
379 * Returns a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
380 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
381 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
382 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
383 * @return The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
384 */ |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
385 GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy); |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
386 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
387 /** |
7312 | 388 * Returns a buddy's contact. |
389 * | |
390 * @param buddy The buddy. | |
391 * | |
392 * @return The buddy's contact. | |
393 */ | |
394 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); | |
395 | |
396 /** | |
9944 | 397 * Returns a buddy's presence. |
398 * | |
399 * @param buddy The buddy. | |
400 * | |
401 * @return The buddy's presence. | |
402 */ | |
403 GaimPresence *gaim_buddy_get_presence(const GaimBuddy *buddy); | |
404 | |
405 /** | |
5228 | 406 * Adds a new buddy to the buddy list. |
407 * | |
6695 | 408 * The buddy will be inserted right after node or prepended to the |
409 * group if node is NULL. If both are NULL, the buddy will be added to | |
5228 | 410 * the "Buddies" group. |
411 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
412 * @param buddy The new buddy who gets added |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
413 * @param contact The optional contact to place the buddy in. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
414 * @param group The group to add the new buddy to. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
415 * @param node The insertion point |
5228 | 416 */ |
6695 | 417 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); |
5228 | 418 |
419 /** | |
420 * Creates a new group | |
421 * | |
6695 | 422 * You can't have more than one group with the same name. Sorry. If you pass |
423 * this the * name of a group that already exists, it will return that group. | |
5228 | 424 * |
425 * @param name The name of the new group | |
6695 | 426 * @return A new group struct |
5228 | 427 */ |
6695 | 428 GaimGroup *gaim_group_new(const char *name); |
5228 | 429 |
430 /** | |
431 * Adds a new group to the buddy list. | |
432 * | |
6695 | 433 * The new group will be inserted after insert or prepended to the list if |
434 * node is NULL. | |
435 * | |
436 * @param group The group | |
437 * @param node The insertion point | |
438 */ | |
439 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
440 | |
441 /** | |
442 * Creates a new contact | |
5228 | 443 * |
6695 | 444 * @return A new contact struct |
5228 | 445 */ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12319
diff
changeset
|
446 GaimContact *gaim_contact_new(void); |
6695 | 447 |
448 /** | |
449 * Adds a new contact to the buddy list. | |
450 * | |
451 * The new contact will be inserted after insert or prepended to the list if | |
452 * node is NULL. | |
453 * | |
454 * @param contact The contact | |
455 * @param group The group to add the contact to | |
456 * @param node The insertion point | |
457 */ | |
458 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
459 | |
460 /** | |
6965 | 461 * Merges two contacts |
462 * | |
463 * All of the buddies from source will be moved to target | |
464 * | |
465 * @param source The contact to merge | |
7246 | 466 * @param node The place to merge to (a buddy or contact) |
6965 | 467 */ |
7246 | 468 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); |
6965 | 469 |
470 /** | |
6695 | 471 * Returns the highest priority buddy for a given contact. |
472 * | |
473 * @param contact The contact | |
474 * @return The highest priority buddy | |
475 */ | |
476 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
5228 | 477 |
478 /** | |
6755 | 479 * Sets the alias for a contact. |
480 * | |
481 * @param contact The contact | |
482 * @param alias The alias to set, or NULL to unset | |
483 */ | |
484 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
485 | |
486 /** | |
487 * Gets the alias for a contact. | |
488 * | |
489 * @param contact The contact | |
490 * @return The alias, or NULL if it is not set. | |
491 */ | |
492 const char *gaim_contact_get_alias(GaimContact *contact); | |
493 | |
494 /** | |
9787 | 495 * Determines whether an account owns any buddies in a given contact |
496 * | |
497 * @param contact The contact to search through. | |
498 * @param account The account. | |
499 * | |
500 * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise. | |
501 */ | |
502 gboolean gaim_contact_on_account(GaimContact *contact, GaimAccount *account); | |
503 | |
504 /** | |
10378 | 505 * Invalidates the priority buddy so that the next call to |
506 * gaim_contact_get_priority_buddy recomputes it. | |
9944 | 507 * |
10378 | 508 * @param contact The contact |
9944 | 509 */ |
10378 | 510 void gaim_contact_invalidate_priority_buddy(GaimContact *contact); |
9944 | 511 /** |
5228 | 512 * Removes a buddy from the buddy list and frees the memory allocated to it. |
513 * | |
514 * @param buddy The buddy to be removed | |
515 */ | |
6695 | 516 void gaim_blist_remove_buddy(GaimBuddy *buddy); |
517 | |
518 /** | |
519 * Removes a contact, and any buddies it contains, and frees the memory | |
520 * allocated to it. | |
521 * | |
522 * @param contact The contact to be removed | |
523 */ | |
524 void gaim_blist_remove_contact(GaimContact *contact); | |
5228 | 525 |
526 /** | |
5234 | 527 * Removes a chat from the buddy list and frees the memory allocated to it. |
528 * | |
529 * @param chat The chat to be removed | |
530 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
531 void gaim_blist_remove_chat(GaimChat *chat); |
5234 | 532 |
533 /** | |
5228 | 534 * Removes a group from the buddy list and frees the memory allocated to it and to |
535 * its children | |
536 * | |
537 * @param group The group to be removed | |
538 */ | |
6695 | 539 void gaim_blist_remove_group(GaimGroup *group); |
5228 | 540 |
541 /** | |
542 * Returns the alias of a buddy. | |
543 * | |
544 * @param buddy The buddy whose name will be returned. | |
10349 | 545 * @return The alias (if set), server alias (if set), |
546 * or NULL. | |
5228 | 547 */ |
9620 | 548 const char *gaim_buddy_get_alias_only(GaimBuddy *buddy); |
5228 | 549 |
550 | |
551 /** | |
9620 | 552 * Returns the correct name to display for a buddy, taking the contact alias |
553 * into account. In order of precedence: the buddy's alias; the buddy's | |
554 * contact alias; the buddy's server alias; the buddy's user name. | |
555 * | |
556 * @param buddy The buddy whose name will be returned | |
9635 | 557 * @return The appropriate name or alias, or NULL. |
9620 | 558 * |
559 */ | |
560 const char *gaim_buddy_get_contact_alias(GaimBuddy *buddy); | |
561 | |
10349 | 562 /** |
563 * Returns the correct alias for this user, ignoring server aliases. Used | |
564 * when a user-recognizable name is required. In order: buddy's alias; buddy's | |
565 * contact alias; buddy's user name. | |
566 * | |
567 * @param buddy The buddy whose alias will be returned. | |
568 * @return The appropriate name or alias. | |
569 */ | |
570 const char *gaim_buddy_get_local_alias(GaimBuddy *buddy); | |
9620 | 571 |
572 /** | |
573 * Returns the correct name to display for a buddy. In order of precedence: | |
574 * the buddy's alias; the buddy's server alias; the buddy's contact alias; | |
575 * the buddy's user name. | |
5228 | 576 * |
577 * @param buddy The buddy whose name will be returned. | |
9635 | 578 * @return The appropriate name or alias, or NULL |
5228 | 579 */ |
9620 | 580 const char *gaim_buddy_get_alias(GaimBuddy *buddy); |
5228 | 581 |
582 /** | |
6744 | 583 * Returns the correct name to display for a blist chat. |
584 * | |
585 * @param chat The chat whose name will be returned. | |
586 * @return The alias (if set), or first component value. | |
587 */ | |
7125 | 588 const char *gaim_chat_get_name(GaimChat *chat); |
6744 | 589 |
590 /** | |
5228 | 591 * Finds the buddy struct given a screenname and an account |
592 * | |
10071 | 593 * @param account The account this buddy belongs to |
6872 | 594 * @param name The buddy's screenname |
5228 | 595 * @return The buddy or NULL if the buddy does not exist |
596 */ | |
6695 | 597 GaimBuddy *gaim_find_buddy(GaimAccount *account, const char *name); |
6245 | 598 |
599 /** | |
6872 | 600 * Finds the buddy struct given a screenname, an account, and a group |
601 * | |
10071 | 602 * @param account The account this buddy belongs to |
6872 | 603 * @param name The buddy's screenname |
604 * @param group The group to look in | |
605 * @return The buddy or NULL if the buddy does not exist in the group | |
606 */ | |
607 GaimBuddy *gaim_find_buddy_in_group(GaimAccount *account, const char *name, | |
608 GaimGroup *group); | |
609 | |
610 /** | |
9285 | 611 * Finds all GaimBuddy structs given a screenname and an account |
6245 | 612 * |
10071 | 613 * @param account The account this buddy belongs to |
6245 | 614 * @param name The buddy's screenname |
615 * | |
616 * @return A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist | |
617 */ | |
618 GSList *gaim_find_buddies(GaimAccount *account, const char *name); | |
619 | |
5228 | 620 |
621 /** | |
622 * Finds a group by name | |
623 * | |
624 * @param name The groups name | |
625 * @return The group or NULL if the group does not exist | |
626 */ | |
6695 | 627 GaimGroup *gaim_find_group(const char *name); |
628 | |
629 /** | |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
630 * Finds a chat by name. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
631 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
632 * @param account The chat's account. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
633 * @param name The chat's name. |
6456
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 * @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
|
636 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
637 GaimChat *gaim_blist_find_chat(GaimAccount *account, const char *name); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
638 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
639 /** |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
640 * Returns the group of which the chat is a member. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
641 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
642 * @param chat The chat. |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
643 * |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
644 * @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
|
645 */ |
7125 | 646 GaimGroup *gaim_chat_get_group(GaimChat *chat); |
6456
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
647 |
ccfdf9f2cdd1
[gaim-migrate @ 6965]
Christian Hammond <chipx86@chipx86.com>
parents:
6245
diff
changeset
|
648 /** |
5228 | 649 * Returns the group of which the buddy is a member. |
650 * | |
651 * @param buddy The buddy | |
652 * @return The group or NULL if the buddy is not in a group | |
653 */ | |
12088 | 654 GaimGroup *gaim_buddy_get_group(GaimBuddy *buddy); |
5228 | 655 |
656 | |
657 /** | |
658 * Returns a list of accounts that have buddies in this group | |
659 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
660 * @param g The group |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
661 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
662 * @return A list of gaim_accounts |
5228 | 663 */ |
6695 | 664 GSList *gaim_group_get_accounts(GaimGroup *g); |
5228 | 665 |
666 /** | |
667 * Determines whether an account owns any buddies in a given group | |
668 * | |
669 * @param g The group to search through. | |
670 * @param account The account. | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
671 * |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
672 * @return TRUE if there are any buddies in the group, or FALSE otherwise. |
5228 | 673 */ |
6695 | 674 gboolean gaim_group_on_account(GaimGroup *g, GaimAccount *account); |
5228 | 675 |
676 /** | |
5234 | 677 * Called when an account gets signed on. Tells the UI to update all the |
678 * buddies. | |
679 * | |
680 * @param account The account | |
681 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
682 void gaim_blist_add_account(GaimAccount *account); |
5234 | 683 |
684 | |
685 /** | |
5228 | 686 * Called when an account gets signed off. Sets the presence of all the buddies to 0 |
687 * and tells the UI to update them. | |
688 * | |
6695 | 689 * @param account The account |
5228 | 690 */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
691 void gaim_blist_remove_account(GaimAccount *account); |
5228 | 692 |
693 | |
694 /** | |
695 * Determines the total size of a group | |
696 * | |
697 * @param group The group | |
698 * @param offline Count buddies in offline accounts | |
699 * @return The number of buddies in the group | |
700 */ | |
6695 | 701 int gaim_blist_get_group_size(GaimGroup *group, gboolean offline); |
5228 | 702 |
703 /** | |
704 * Determines the number of online buddies in a group | |
705 * | |
706 * @param group The group | |
707 * @return The number of online buddies in the group, or 0 if the group is NULL | |
708 */ | |
6695 | 709 int gaim_blist_get_group_online_count(GaimGroup *group); |
5228 | 710 |
711 /*@}*/ | |
712 | |
713 /****************************************************************************************/ | |
714 /** @name Buddy list file management API */ | |
715 /****************************************************************************************/ | |
716 | |
717 /** | |
718 * Loads the buddy list from ~/.gaim/blist.xml. | |
719 */ | |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12319
diff
changeset
|
720 void gaim_blist_load(void); |
5228 | 721 |
722 /** | |
10704 | 723 * Schedule a save of the blist.xml file. This is used by the privacy |
724 * API whenever the privacy settings are changed. If you make a change | |
725 * to blist.xml using one of the functions in the buddy list API, then | |
726 * the buddy list is saved automatically, so you should not need to | |
727 * call this. | |
10350 | 728 */ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12319
diff
changeset
|
729 void gaim_blist_schedule_save(void); |
10350 | 730 |
731 /** | |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
732 * 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
|
733 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
734 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
735 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
736 * @param username The username of the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
737 * @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
|
738 * @param alias The optional alias for the buddy. |
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 void gaim_blist_request_add_buddy(GaimAccount *account, const char *username, |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
741 const char *group, const char *alias); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
742 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
743 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
744 * 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
|
745 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
746 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
747 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
748 * @param group The optional group to add the chat to. |
9000 | 749 * @param alias The optional alias for the chat. |
9939 | 750 * @param name The required chat name. |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
751 */ |
7859 | 752 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, |
9754 | 753 const char *alias, const char *name); |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
754 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
755 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
756 * 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
|
757 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
758 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
759 void gaim_blist_request_add_group(void); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
760 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
761 /** |
7693 | 762 * Associates a boolean with a node in the buddy list |
763 * | |
764 * @param node The node to associate the data with | |
765 * @param key The identifier for the data | |
766 * @param value The value to set | |
767 */ | |
768 void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value); | |
769 | |
770 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
771 * Retrieves a named boolean setting from a node in the buddy list |
7693 | 772 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
773 * @param node The node to retrieve the data from |
7693 | 774 * @param key The identifier of the data |
775 * | |
776 * @return The value, or FALSE if there is no setting | |
777 */ | |
778 gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key); | |
779 | |
780 /** | |
781 * Associates an integer with a node in the buddy list | |
782 * | |
783 * @param node The node to associate the data with | |
784 * @param key The identifier for the data | |
785 * @param value The value to set | |
786 */ | |
787 void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value); | |
788 | |
789 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
790 * Retrieves a named integer setting from a node in the buddy list |
7693 | 791 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
792 * @param node The node to retrieve the data from |
7693 | 793 * @param key The identifier of the data |
794 * | |
795 * @return The value, or 0 if there is no setting | |
796 */ | |
797 int gaim_blist_node_get_int(GaimBlistNode *node, const char *key); | |
798 | |
799 /** | |
800 * Associates a string with a node in the buddy list | |
801 * | |
802 * @param node The node to associate the data with | |
803 * @param key The identifier for the data | |
804 * @param value The value to set | |
805 */ | |
806 void gaim_blist_node_set_string(GaimBlistNode *node, const char *key, | |
807 const char *value); | |
808 | |
809 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
810 * Retrieves a named string setting from a node in the buddy list |
7693 | 811 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
812 * @param node The node to retrieve the data from |
7693 | 813 * @param key The identifier of the data |
814 * | |
815 * @return The value, or NULL if there is no setting | |
816 */ | |
817 const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key); | |
818 | |
819 /** | |
7811 | 820 * Removes a named setting from a blist node |
821 * | |
822 * @param node The node from which to remove the setting | |
823 * @param key The name of the setting | |
824 */ | |
825 void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key); | |
826 | |
10548 | 827 /** |
828 * Set the flags for the given node. Setting a node's flags will overwrite | |
829 * the old flags, so if you want to save them, you must first call | |
830 * gaim_blist_node_get_flags and modify that appropriately. | |
831 * | |
832 * @param node The node on which to set the flags. | |
833 * @param flags The flags to set. This is a bitmask. | |
834 */ | |
835 void gaim_blist_node_set_flags(GaimBlistNode *node, GaimBlistNodeFlags flags); | |
836 | |
837 /** | |
838 * Get the current flags on a given node. | |
839 * | |
840 * @param node The node from which to get the flags. | |
841 * | |
842 * @return The flags on the node. This is a bitmask. | |
843 */ | |
844 GaimBlistNodeFlags gaim_blist_node_get_flags(GaimBlistNode *node); | |
845 | |
5228 | 846 /*@}*/ |
847 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
848 |
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
849 /** |
9030 | 850 * Retrieves the extended menu items for a buddy list node. |
12286
255e6912607b
[gaim-migrate @ 14590]
Etan Reisner <pidgin@unreliablesource.net>
parents:
12112
diff
changeset
|
851 * @param n The blist node for which to obtain the extended menu items. |
255e6912607b
[gaim-migrate @ 14590]
Etan Reisner <pidgin@unreliablesource.net>
parents:
12112
diff
changeset
|
852 * @return A list of GaimBlistNodeAction items, as harvested by the |
255e6912607b
[gaim-migrate @ 14590]
Etan Reisner <pidgin@unreliablesource.net>
parents:
12112
diff
changeset
|
853 * blist-node-extended-menu signal. |
9030 | 854 */ |
855 GList *gaim_blist_node_get_extended_menu(GaimBlistNode *n); | |
856 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
857 |
8952 | 858 /** |
9030 | 859 * Creates a new GaimBlistNodeAction. |
10662
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
860 * @param label The text label to display for this action. |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
861 * @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
|
862 * a selected GaimBlistNode. |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
863 * @param data Additional data, to be passed to the callback |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
864 * @param children A GList of GaimBlistNodeActions to be added as a |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
865 * submenu of the action. |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
866 * @return The GaimBlistNodeAction. |
9030 | 867 */ |
10662
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
868 GaimBlistNodeAction *gaim_blist_node_action_new(char *label, |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
869 void (*callback)(GaimBlistNode *, gpointer), gpointer data, |
54ac161a876e
[gaim-migrate @ 12199]
Etan Reisner <pidgin@unreliablesource.net>
parents:
10567
diff
changeset
|
870 GList *children); |
8952 | 871 |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
872 |
5228 | 873 /**************************************************************************/ |
12054 | 874 /** @name UI Registration Functions */ |
875 /**************************************************************************/ | |
876 /*@{*/ | |
877 | |
878 /** | |
879 * Sets the UI operations structure to be used for the buddy list. | |
880 * | |
881 * @param ops The ops struct. | |
882 */ | |
883 void gaim_blist_set_ui_ops(GaimBlistUiOps *ops); | |
884 | |
885 /** | |
886 * Returns the UI operations structure to be used for the buddy list. | |
887 * | |
888 * @return The UI operations structure. | |
889 */ | |
890 GaimBlistUiOps *gaim_blist_get_ui_ops(void); | |
891 | |
892 /*@}*/ | |
893 | |
894 /**************************************************************************/ | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
895 /** @name Buddy List Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
896 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
897 /*@{*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
898 |
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 * Returns the handle for 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 * @return The buddy list subsystem handle. |
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 void *gaim_blist_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
905 |
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 * Initializes the buddy list subsystem. |
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 void gaim_blist_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
910 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
911 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
912 * Uninitializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
913 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
914 void gaim_blist_uninit(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
915 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
916 /*@}*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
917 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
918 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
919 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
920 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
921 |
9713 | 922 #endif /* _GAIM_BLIST_H_ */ |