Mercurial > pidgin
annotate src/blist.h @ 9944:e4a27c9aec4c
[gaim-migrate @ 10838]
with much rejoicing, and massive thanks to the efforts of Christian, and
all who have helped him, I present to you the incomplete status
rewrite!
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Fri, 03 Sep 2004 21:35:52 +0000 |
parents | acbbc0d73600 |
children | ced29c7b396c |
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 |
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
43 #include "account.h" |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
44 #include "buddyicon.h" |
9944 | 45 #include "status.h" |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
46 |
5228 | 47 /**************************************************************************/ |
48 /* Enumerations */ | |
49 /**************************************************************************/ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
50 typedef enum |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
51 { |
5228 | 52 GAIM_BLIST_GROUP_NODE, |
6695 | 53 GAIM_BLIST_CONTACT_NODE, |
5228 | 54 GAIM_BLIST_BUDDY_NODE, |
5234 | 55 GAIM_BLIST_CHAT_NODE, |
6063 | 56 GAIM_BLIST_OTHER_NODE |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
57 |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
58 } GaimBlistNodeType; |
5228 | 59 |
9944 | 60 #define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE) |
61 #define GAIM_BLIST_NODE_IS_BUDDY(n) ((n)->type == GAIM_BLIST_BUDDY_NODE) | |
6695 | 62 #define GAIM_BLIST_NODE_IS_CONTACT(n) ((n)->type == GAIM_BLIST_CONTACT_NODE) |
9944 | 63 #define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE) |
5228 | 64 |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
65 typedef enum |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
66 { |
5228 | 67 GAIM_BUDDY_SIGNING_OFF = -1, |
68 GAIM_BUDDY_OFFLINE = 0, | |
69 GAIM_BUDDY_ONLINE, | |
6063 | 70 GAIM_BUDDY_SIGNING_ON |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
71 |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
72 } GaimBuddyPresenceState; |
5228 | 73 |
9944 | 74 #define GAIM_BUDDY_IS_ONLINE(b) \ |
75 ((b) != NULL && gaim_account_is_connected((b)->account) && \ | |
76 gaim_presence_is_online(gaim_buddy_get_presence(b))) | |
5228 | 77 |
9787 | 78 typedef enum |
79 { | |
80 GAIM_BLIST_NODE_FLAG_NO_SAVE = 1, /**< node should not be saved with the buddy list */ | |
81 } GaimBlistNodeFlags; | |
82 | |
83 #define GAIM_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f)) | |
84 #define GAIM_BLIST_NODE_SHOULD_SAVE(b) (! GAIM_BLIST_NODE_HAS_FLAG(b, GAIM_BLIST_NODE_FLAG_NO_SAVE)) | |
85 | |
5228 | 86 |
87 /**************************************************************************/ | |
88 /* Data Structures */ | |
89 /**************************************************************************/ | |
90 | |
91 /** | |
92 * A Buddy list node. This can represent a group, a buddy, or anything else. This is a base class for struct buddy and | |
93 * struct group and for anything else that wants to put itself in the buddy list. */ | |
94 struct _GaimBlistNode { | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
95 GaimBlistNodeType type; /**< The type of node this is */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
96 GaimBlistNode *prev; /**< The sibling before this buddy. */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
97 GaimBlistNode *next; /**< The sibling after this buddy. */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
98 GaimBlistNode *parent; /**< The parent of this node */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
99 GaimBlistNode *child; /**< The child of this node */ |
7693 | 100 GHashTable *settings; /**< per-node settings */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
101 void *ui_data; /**< The UI can put data here. */ |
9787 | 102 GaimBlistNodeFlags flags; /**< The buddy flags */ |
5228 | 103 }; |
104 | |
105 /** | |
106 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
107 */ | |
6695 | 108 struct _GaimBuddy { |
5228 | 109 GaimBlistNode node; /**< The node that this buddy inherits from */ |
110 char *name; /**< The screenname of the buddy. */ | |
111 char *alias; /**< The user-set alias of the buddy */ | |
6695 | 112 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
|
113 GaimBuddyPresenceState present; /**< This is 0 if the buddy appears offline, 1 if he appears online, and 2 if |
5228 | 114 he has recently signed on */ |
115 int evil; /**< The warning level */ | |
116 time_t signon; /**< The time the buddy signed on. */ | |
117 int idle; /**< The time the buddy has been idle in minutes. */ | |
118 int uc; /**< This is a cryptic bitmask that makes sense only to the prpl. This will get changed */ | |
119 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
|
120 GaimBuddyIcon *icon; /**< The buddy icon. */ |
9787 | 121 GaimAccount *account; /**< the account this buddy belongs to */ |
122 guint timer; /**< The timer handle. */ | |
5228 | 123 }; |
124 | |
125 /** | |
6695 | 126 * A contact. This contains everything Gaim will ever need to know about a contact. |
127 */ | |
128 struct _GaimContact { | |
6755 | 129 GaimBlistNode node; /**< The node that this contact inherits from. */ |
130 char *alias; /**< The user-set alias of the contact */ | |
131 int totalsize; /**< The number of buddies in this contact */ | |
132 int currentsize; /**< The number of buddies in this contact corresponding to online accounts */ | |
133 int online; /**< The number of buddies in this contact who are currently online */ | |
6843 | 134 GaimBuddy *priority; /**< The "top" buddy for this contact */ |
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. */ |
5228 | 181 void (*new_node)(GaimBlistNode *node); /**< Sets UI-specific data on a node. */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
182 void (*show)(GaimBuddyList *list); /**< The core will call this when its finished doing it's core stuff */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
183 void (*update)(GaimBuddyList *list, |
5228 | 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, |
5228 | 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, |
5228 | 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); |
7859 | 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; | |
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 | |
216 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
217 GaimBuddyList *gaim_blist_new(); |
5228 | 218 |
219 /** | |
220 * Sets the main buddy list. | |
221 * | |
222 * @return The main buddy list. | |
223 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
224 void gaim_set_blist(GaimBuddyList *blist); |
5228 | 225 |
226 /** | |
227 * Returns the main buddy list. | |
228 * | |
229 * @return The main buddy list. | |
230 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
231 GaimBuddyList *gaim_get_blist(void); |
5228 | 232 |
233 /** | |
234 * Shows the buddy list, creating a new one if necessary. | |
235 * | |
236 */ | |
237 void gaim_blist_show(); | |
238 | |
239 | |
240 /** | |
241 * Destroys the buddy list window. | |
242 */ | |
243 void gaim_blist_destroy(); | |
244 | |
245 /** | |
246 * Hides or unhides the buddy list. | |
247 * | |
248 * @param show Whether or not to show the buddy list | |
249 */ | |
250 void gaim_blist_set_visible(gboolean show); | |
251 | |
252 /** | |
253 * Updates a buddy's status. | |
5234 | 254 * |
5228 | 255 * This needs to not take an int. |
256 * | |
257 * @param buddy The buddy whose status has changed | |
258 * @param status The new status in cryptic prpl-understood code | |
259 */ | |
6695 | 260 void gaim_blist_update_buddy_status(GaimBuddy *buddy, int status); |
5228 | 261 |
262 | |
263 /** | |
264 * Updates a buddy's presence. | |
265 * | |
266 * @param buddy The buddy whose presence has changed | |
9927 | 267 * @param online If the buddy is now online |
5228 | 268 */ |
9927 | 269 void gaim_blist_update_buddy_presence(GaimBuddy *buddy, gboolean online); |
5228 | 270 |
7950 | 271 /** |
272 * Updates a buddy's signon time. | |
273 * | |
9944 | 274 * @param buddy The buddy whose sign-on time has changed. |
7950 | 275 * @param signon The buddy's signon time since the dawn of the UNIX epoch. |
276 */ | |
277 void gaim_blist_update_buddy_signon(GaimBuddy *buddy, time_t signon); | |
5228 | 278 |
279 /** | |
280 * Updates a buddy's icon. | |
281 * | |
282 * @param buddy The buddy whose buddy icon has changed | |
283 */ | |
6695 | 284 void gaim_blist_update_buddy_icon(GaimBuddy *buddy); |
5228 | 285 |
286 /** | |
287 * Renames a buddy in the buddy list. | |
288 * | |
289 * @param buddy The buddy whose name will be changed. | |
290 * @param name The new name of the buddy. | |
291 */ | |
6695 | 292 void gaim_blist_rename_buddy(GaimBuddy *buddy, const char *name); |
5228 | 293 |
294 | |
295 /** | |
296 * Aliases a buddy in the buddy list. | |
297 * | |
298 * @param buddy The buddy whose alias will be changed. | |
299 * @param alias The buddy's alias. | |
300 */ | |
6695 | 301 void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias); |
5228 | 302 |
5234 | 303 /** |
6059 | 304 * Sets the server-sent alias of a buddy in the buddy list. |
6058 | 305 * |
306 * @param buddy The buddy whose alias will be changed. | |
307 * @param alias The buddy's "official" alias. | |
308 */ | |
6695 | 309 void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias); |
6058 | 310 |
311 /** | |
5234 | 312 * Aliases a chat in the buddy list. |
313 * | |
314 * @param chat The chat whose alias will be changed. | |
315 * @param alias The chat's new alias. | |
316 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
317 void gaim_blist_alias_chat(GaimChat *chat, const char *alias); |
5228 | 318 |
319 /** | |
320 * Renames a group | |
321 * | |
322 * @param group The group to rename | |
323 * @param name The new name | |
324 */ | |
6695 | 325 void gaim_blist_rename_group(GaimGroup *group, const char *name); |
5228 | 326 |
5234 | 327 /** |
328 * Creates a new chat for the buddy list | |
329 * | |
330 * @param account The account this chat will get added to | |
331 * @param alias The alias of the new chat | |
332 * @param components The info the prpl needs to join the chat | |
333 * @return A newly allocated chat | |
334 */ | |
7125 | 335 GaimChat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); |
5234 | 336 |
337 /** | |
6034 | 338 * Gets the alias of the chat, or the chat name if the alias does not exist |
339 * | |
340 * @param chat The chat | |
341 * @return The display name of the chat | |
342 */ | |
7125 | 343 char *gaim_chat_get_display_name(GaimChat *chat); |
6034 | 344 |
345 /** | |
5234 | 346 * Adds a new chat to the buddy list. |
347 * | |
348 * The chat will be inserted right after node or appended to the end | |
349 * of group if node is NULL. If both are NULL, the buddy will be added to | |
350 * the "Chats" group. | |
351 * | |
352 * @param chat The new chat who gets added | |
353 * @param group The group to add the new chat to. | |
354 * @param node The insertion point | |
355 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
356 void gaim_blist_add_chat(GaimChat *chat, GaimGroup *group, GaimBlistNode *node); |
5228 | 357 |
358 /** | |
359 * Creates a new buddy | |
360 * | |
361 * @param account The account this buddy will get added to | |
362 * @param screenname The screenname of the new buddy | |
363 * @param alias The alias of the new buddy (or NULL if unaliased) | |
364 * @return A newly allocated buddy | |
365 */ | |
6695 | 366 GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); |
5228 | 367 |
368 /** | |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
369 * Sets a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
370 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
371 * 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
|
372 * call gaim_buddy_icon_set_data(). |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
373 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
374 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
375 * @param icon The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
376 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
377 * @see gaim_buddy_icon_set_data() |
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 void gaim_buddy_set_icon(GaimBuddy *buddy, GaimBuddyIcon *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 /** |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
382 * Returns a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
383 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
384 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
385 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
386 * @return The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
387 */ |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
388 GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy); |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
389 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
390 /** |
7312 | 391 * Returns a buddy's contact. |
392 * | |
393 * @param buddy The buddy. | |
394 * | |
395 * @return The buddy's contact. | |
396 */ | |
397 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); | |
398 | |
399 /** | |
9944 | 400 * Returns a buddy's presence. |
401 * | |
402 * @param buddy The buddy. | |
403 * | |
404 * @return The buddy's presence. | |
405 */ | |
406 GaimPresence *gaim_buddy_get_presence(const GaimBuddy *buddy); | |
407 | |
408 /** | |
5228 | 409 * Adds a new buddy to the buddy list. |
410 * | |
6695 | 411 * The buddy will be inserted right after node or prepended to the |
412 * group if node is NULL. If both are NULL, the buddy will be added to | |
5228 | 413 * the "Buddies" group. |
414 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
415 * @param buddy The new buddy who gets added |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
416 * @param contact The optional contact to place the buddy in. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
417 * @param group The group to add the new buddy to. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
418 * @param node The insertion point |
5228 | 419 */ |
6695 | 420 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); |
5228 | 421 |
422 /** | |
423 * Creates a new group | |
424 * | |
6695 | 425 * You can't have more than one group with the same name. Sorry. If you pass |
426 * this the * name of a group that already exists, it will return that group. | |
5228 | 427 * |
428 * @param name The name of the new group | |
6695 | 429 * @return A new group struct |
5228 | 430 */ |
6695 | 431 GaimGroup *gaim_group_new(const char *name); |
5228 | 432 |
433 /** | |
434 * Adds a new group to the buddy list. | |
435 * | |
6695 | 436 * The new group will be inserted after insert or prepended to the list if |
437 * node is NULL. | |
438 * | |
439 * @param group The group | |
440 * @param node The insertion point | |
441 */ | |
442 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
443 | |
444 /** | |
445 * Creates a new contact | |
5228 | 446 * |
6695 | 447 * @return A new contact struct |
5228 | 448 */ |
6695 | 449 GaimContact *gaim_contact_new(); |
450 | |
451 /** | |
452 * Adds a new contact to the buddy list. | |
453 * | |
454 * The new contact will be inserted after insert or prepended to the list if | |
455 * node is NULL. | |
456 * | |
457 * @param contact The contact | |
458 * @param group The group to add the contact to | |
459 * @param node The insertion point | |
460 */ | |
461 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
462 | |
463 /** | |
6965 | 464 * Merges two contacts |
465 * | |
466 * All of the buddies from source will be moved to target | |
467 * | |
468 * @param source The contact to merge | |
7246 | 469 * @param node The place to merge to (a buddy or contact) |
6965 | 470 */ |
7246 | 471 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); |
6965 | 472 |
473 /** | |
6695 | 474 * Returns the highest priority buddy for a given contact. |
475 * | |
476 * @param contact The contact | |
477 * @return The highest priority buddy | |
478 */ | |
479 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
5228 | 480 |
481 /** | |
6755 | 482 * Sets the alias for a contact. |
483 * | |
484 * @param contact The contact | |
485 * @param alias The alias to set, or NULL to unset | |
486 */ | |
487 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
488 | |
489 /** | |
490 * Gets the alias for a contact. | |
491 * | |
492 * @param contact The contact | |
493 * @return The alias, or NULL if it is not set. | |
494 */ | |
495 const char *gaim_contact_get_alias(GaimContact *contact); | |
496 | |
497 /** | |
9787 | 498 * Determines whether an account owns any buddies in a given contact |
499 * | |
500 * @param contact The contact to search through. | |
501 * @param account The account. | |
502 * | |
503 * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise. | |
504 */ | |
505 gboolean gaim_contact_on_account(GaimContact *contact, GaimAccount *account); | |
506 | |
507 | |
508 /** | |
9944 | 509 * Re-calculates the priority buddy for a contact. |
510 * | |
511 * @param contact The contact. | |
512 */ | |
513 void gaim_contact_compute_priority_buddy(GaimContact *contact); | |
514 | |
515 /** | |
5228 | 516 * Removes a buddy from the buddy list and frees the memory allocated to it. |
517 * | |
518 * @param buddy The buddy to be removed | |
519 */ | |
6695 | 520 void gaim_blist_remove_buddy(GaimBuddy *buddy); |
521 | |
522 /** | |
523 * Removes a contact, and any buddies it contains, and frees the memory | |
524 * allocated to it. | |
525 * | |
526 * @param contact The contact to be removed | |
527 */ | |
528 void gaim_blist_remove_contact(GaimContact *contact); | |
5228 | 529 |
530 /** | |
5234 | 531 * Removes a chat from the buddy list and frees the memory allocated to it. |
532 * | |
533 * @param chat The chat to be removed | |
534 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
535 void gaim_blist_remove_chat(GaimChat *chat); |
5234 | 536 |
537 /** | |
5228 | 538 * Removes a group from the buddy list and frees the memory allocated to it and to |
539 * its children | |
540 * | |
541 * @param group The group to be removed | |
542 */ | |
6695 | 543 void gaim_blist_remove_group(GaimGroup *group); |
5228 | 544 |
545 /** | |
546 * Returns the alias of a buddy. | |
547 * | |
548 * @param buddy The buddy whose name will be returned. | |
9635 | 549 * @return The alias (if set), server alias (if set and preference |
550 * is to display server aliases), or NULL. | |
5228 | 551 */ |
9620 | 552 const char *gaim_buddy_get_alias_only(GaimBuddy *buddy); |
5228 | 553 |
554 | |
555 /** | |
9620 | 556 * Returns the correct name to display for a buddy, taking the contact alias |
557 * into account. In order of precedence: the buddy's alias; the buddy's | |
558 * contact alias; the buddy's server alias; the buddy's user name. | |
559 * | |
560 * @param buddy The buddy whose name will be returned | |
9635 | 561 * @return The appropriate name or alias, or NULL. |
9620 | 562 * |
563 */ | |
564 const char *gaim_buddy_get_contact_alias(GaimBuddy *buddy); | |
565 | |
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 * | |
6872 | 588 * @param name The buddy's screenname |
5228 | 589 * @param account The account this buddy belongs to |
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 * | |
597 * @param name The buddy's screenname | |
598 * @param account The account this buddy belongs to | |
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 * |
608 * @param name The buddy's screenname | |
609 * @param account The account this buddy belongs to | |
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 /** | |
9285 | 714 * Force an immediate write of the buddy list. Normally the buddy list is |
715 * saved automatically a few seconds after a change is made. | |
5228 | 716 */ |
9285 | 717 void gaim_blist_sync(); |
5228 | 718 |
719 /** | |
7117
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
720 * Parses the toc-style buddy list used in older versions of Gaim and for SSI in toc.c |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
721 * |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
722 * @param account This is the account that the buddies and groups from config will get added to |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
723 * @param config This is the toc-style buddy list data |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
724 */ |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
725 void gaim_blist_parse_toc_buddy_list(GaimAccount *account, char *config); |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
726 |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
727 |
943085b0ff8b
[gaim-migrate @ 7684]
Christian Hammond <chipx86@chipx86.com>
parents:
7115
diff
changeset
|
728 /** |
5228 | 729 * Loads the buddy list from ~/.gaim/blist.xml. |
730 */ | |
731 void gaim_blist_load(); | |
732 | |
733 /** | |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
734 * 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
|
735 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
736 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
737 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
738 * @param username The username of the buddy. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
739 * @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
|
740 * @param alias The optional alias for the buddy. |
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 void gaim_blist_request_add_buddy(GaimAccount *account, const char *username, |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
743 const char *group, const char *alias); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
744 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
745 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
746 * 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
|
747 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
748 * |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
749 * @param account The account the buddy is added to. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
750 * @param group The optional group to add the chat to. |
9000 | 751 * @param alias The optional alias for the chat. |
9939 | 752 * @param name The required chat name. |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
753 */ |
7859 | 754 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, |
9754 | 755 const char *alias, const char *name); |
7060
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 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
758 * 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
|
759 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
760 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
761 void gaim_blist_request_add_group(void); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
762 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
763 /** |
7693 | 764 * Associates a boolean with a node in the buddy list |
765 * | |
766 * @param node The node to associate the data with | |
767 * @param key The identifier for the data | |
768 * @param value The value to set | |
769 */ | |
770 void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value); | |
771 | |
772 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
773 * Retrieves a named boolean setting from a node in the buddy list |
7693 | 774 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
775 * @param node The node to retrieve the data from |
7693 | 776 * @param key The identifier of the data |
777 * | |
778 * @return The value, or FALSE if there is no setting | |
779 */ | |
780 gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key); | |
781 | |
782 /** | |
783 * Associates an integer with a node in the buddy list | |
784 * | |
785 * @param node The node to associate the data with | |
786 * @param key The identifier for the data | |
787 * @param value The value to set | |
788 */ | |
789 void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value); | |
790 | |
791 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
792 * Retrieves a named integer setting from a node in the buddy list |
7693 | 793 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
794 * @param node The node to retrieve the data from |
7693 | 795 * @param key The identifier of the data |
796 * | |
797 * @return The value, or 0 if there is no setting | |
798 */ | |
799 int gaim_blist_node_get_int(GaimBlistNode *node, const char *key); | |
800 | |
801 /** | |
802 * Associates a string with a node in the buddy list | |
803 * | |
804 * @param node The node to associate the data with | |
805 * @param key The identifier for the data | |
806 * @param value The value to set | |
807 */ | |
808 void gaim_blist_node_set_string(GaimBlistNode *node, const char *key, | |
809 const char *value); | |
810 | |
811 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
812 * Retrieves a named string setting from a node in the buddy list |
7693 | 813 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
814 * @param node The node to retrieve the data from |
7693 | 815 * @param key The identifier of the data |
816 * | |
817 * @return The value, or NULL if there is no setting | |
818 */ | |
819 const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key); | |
820 | |
821 /** | |
7811 | 822 * Removes a named setting from a blist node |
823 * | |
824 * @param node The node from which to remove the setting | |
825 * @param key The name of the setting | |
826 */ | |
827 void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key); | |
828 | |
5228 | 829 /*@}*/ |
830 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
831 |
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
832 /** |
9030 | 833 * Retrieves the extended menu items for a buddy list node. |
834 * @param n The blist node for which to obtain the extended menu items. | |
835 * @return list of GaimBlistNodeAction items, as harvested by the | |
836 * blist-node-extended-menu signal. | |
837 */ | |
838 GList *gaim_blist_node_get_extended_menu(GaimBlistNode *n); | |
839 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
840 |
8952 | 841 /** |
9030 | 842 * Creates a new GaimBlistNodeAction. |
843 * @param label The text label to display for this action. | |
844 * @param callback The function to be called when the action is used on | |
845 * a selected GaimBlistNode. | |
846 * @param data Additional data, to be passed to the callback | |
847 */ | |
848 GaimBlistNodeAction *gaim_blist_node_action_new(char *label, | |
849 void (*callback)(GaimBlistNode *, gpointer), gpointer data); | |
8952 | 850 |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
851 |
5228 | 852 /**************************************************************************/ |
853 /** @name UI Registration Functions */ | |
854 /**************************************************************************/ | |
855 /*@{*/ | |
856 | |
857 /** | |
858 * Sets the UI operations structure to be used for the buddy list. | |
859 * | |
860 * @param ops The ops struct. | |
861 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
862 void gaim_blist_set_ui_ops(GaimBlistUiOps *ops); |
5228 | 863 |
864 /** | |
865 * Returns the UI operations structure to be used for the buddy list. | |
866 * | |
867 * @return The UI operations structure. | |
868 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
869 GaimBlistUiOps *gaim_blist_get_ui_ops(void); |
5228 | 870 |
871 /*@}*/ | |
872 | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
873 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
874 /** @name Buddy List Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
875 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
876 /*@{*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
877 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
878 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
879 * Returns the handle for the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
880 * |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
881 * @return The buddy list subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
882 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
883 void *gaim_blist_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
884 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
885 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
886 * Initializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
887 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
888 void gaim_blist_init(void); |
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 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
891 * Uninitializes the 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 void gaim_blist_uninit(void); |
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 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
897 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
898 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
899 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
900 |
9713 | 901 #endif /* _GAIM_BLIST_H_ */ |