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