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