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