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