Mercurial > pidgin.yaz
annotate src/blist.h @ 9802:acf175d9f79b
[gaim-migrate @ 10670]
A wee bit o' cleanup. Rrrrrrr. Avast.
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Sat, 21 Aug 2004 17:20:48 +0000 |
parents | 904b757835ca |
children | fb08a0973b3e |
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" |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
45 |
5228 | 46 /**************************************************************************/ |
47 /* Enumerations */ | |
48 /**************************************************************************/ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
49 typedef enum |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
50 { |
5228 | 51 GAIM_BLIST_GROUP_NODE, |
6695 | 52 GAIM_BLIST_CONTACT_NODE, |
5228 | 53 GAIM_BLIST_BUDDY_NODE, |
5234 | 54 GAIM_BLIST_CHAT_NODE, |
6063 | 55 GAIM_BLIST_OTHER_NODE |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
56 |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
57 } GaimBlistNodeType; |
5228 | 58 |
5234 | 59 #define GAIM_BLIST_NODE_IS_CHAT(n) ((n)->type == GAIM_BLIST_CHAT_NODE) |
5228 | 60 #define GAIM_BLIST_NODE_IS_BUDDY(n) ((n)->type == GAIM_BLIST_BUDDY_NODE) |
6695 | 61 #define GAIM_BLIST_NODE_IS_CONTACT(n) ((n)->type == GAIM_BLIST_CONTACT_NODE) |
5228 | 62 #define GAIM_BLIST_NODE_IS_GROUP(n) ((n)->type == GAIM_BLIST_GROUP_NODE) |
63 | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
64 typedef enum |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
65 { |
5228 | 66 GAIM_BUDDY_SIGNING_OFF = -1, |
67 GAIM_BUDDY_OFFLINE = 0, | |
68 GAIM_BUDDY_ONLINE, | |
6063 | 69 GAIM_BUDDY_SIGNING_ON |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
70 |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
71 } GaimBuddyPresenceState; |
5228 | 72 |
6695 | 73 #define GAIM_BUDDY_IS_ONLINE(b) ((b)->account->gc && \ |
74 ((b)->present == GAIM_BUDDY_ONLINE || \ | |
75 (b)->present == GAIM_BUDDY_SIGNING_ON)) | |
5228 | 76 |
9787 | 77 typedef enum |
78 { | |
79 GAIM_BLIST_NODE_FLAG_NO_SAVE = 1, /**< node should not be saved with the buddy list */ | |
80 } GaimBlistNodeFlags; | |
81 | |
82 #define GAIM_BLIST_NODE_HAS_FLAG(b, f) ((b)->flags & (f)) | |
83 #define GAIM_BLIST_NODE_SHOULD_SAVE(b) (! GAIM_BLIST_NODE_HAS_FLAG(b, GAIM_BLIST_NODE_FLAG_NO_SAVE)) | |
84 | |
5228 | 85 |
86 /**************************************************************************/ | |
87 /* Data Structures */ | |
88 /**************************************************************************/ | |
89 | |
90 /** | |
91 * A Buddy list node. This can represent a group, a buddy, or anything else. This is a base class for struct buddy and | |
92 * struct group and for anything else that wants to put itself in the buddy list. */ | |
93 struct _GaimBlistNode { | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
94 GaimBlistNodeType type; /**< The type of node this is */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
95 GaimBlistNode *prev; /**< The sibling before this buddy. */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
96 GaimBlistNode *next; /**< The sibling after this buddy. */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
97 GaimBlistNode *parent; /**< The parent of this node */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
98 GaimBlistNode *child; /**< The child of this node */ |
7693 | 99 GHashTable *settings; /**< per-node settings */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
100 void *ui_data; /**< The UI can put data here. */ |
9787 | 101 GaimBlistNodeFlags flags; /**< The buddy flags */ |
5228 | 102 }; |
103 | |
104 /** | |
105 * A buddy. This contains everything Gaim will ever need to know about someone on the buddy list. Everything. | |
106 */ | |
6695 | 107 struct _GaimBuddy { |
5228 | 108 GaimBlistNode node; /**< The node that this buddy inherits from */ |
109 char *name; /**< The screenname of the buddy. */ | |
110 char *alias; /**< The user-set alias of the buddy */ | |
6695 | 111 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
|
112 GaimBuddyPresenceState present; /**< This is 0 if the buddy appears offline, 1 if he appears online, and 2 if |
5228 | 113 he has recently signed on */ |
114 int evil; /**< The warning level */ | |
115 time_t signon; /**< The time the buddy signed on. */ | |
116 int idle; /**< The time the buddy has been idle in minutes. */ | |
117 int uc; /**< This is a cryptic bitmask that makes sense only to the prpl. This will get changed */ | |
118 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
|
119 GaimBuddyIcon *icon; /**< The buddy icon. */ |
9787 | 120 GaimAccount *account; /**< the account this buddy belongs to */ |
121 guint timer; /**< The timer handle. */ | |
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 */ |
6695 | 134 }; |
135 | |
136 | |
137 /** | |
5228 | 138 * A group. This contains everything Gaim will ever need to know about a group. |
139 */ | |
6695 | 140 struct _GaimGroup { |
5228 | 141 GaimBlistNode node; /**< The node that this group inherits from */ |
142 char *name; /**< The name of this group. */ | |
6695 | 143 int totalsize; /**< The number of chats and contacts in this group */ |
144 int currentsize; /**< The number of chats and contacts in this group corresponding to online accounts */ | |
145 int online; /**< The number of chats and contacts in this group who are currently online */ | |
5228 | 146 }; |
147 | |
5234 | 148 /** |
6695 | 149 * A chat. This contains everything Gaim needs to put a chat room in the |
5234 | 150 * buddy list. |
151 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
152 struct _GaimChat { |
5234 | 153 GaimBlistNode node; /**< The node that this chat inherits from */ |
154 char *alias; /**< The display name of this chat. */ | |
155 GHashTable *components; /**< the stuff the protocol needs to know to join the chat */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5497
diff
changeset
|
156 GaimAccount *account; /**< The account this chat is attached to */ |
5234 | 157 }; |
158 | |
5228 | 159 |
160 /** | |
161 * The Buddy List | |
162 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
163 struct _GaimBuddyList { |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
164 GaimBlistNode *root; /**< The first node in the buddy list */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
165 GHashTable *buddies; /**< Every buddy in this list */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
166 GaimBlistUiOps *ui_ops; /**< The UI operations for the buddy list */ |
5228 | 167 |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
168 void *ui_data; /**< UI-specific data. */ |
5228 | 169 }; |
170 | |
171 /** | |
172 * Buddy list UI operations. | |
173 * | |
9460 | 174 * Any UI representing a buddy list must assign a filled-out GaimBlistUiOps |
5228 | 175 * structure to the buddy list core. |
176 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
177 struct _GaimBlistUiOps |
5228 | 178 { |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
179 void (*new_list)(GaimBuddyList *list); /**< Sets UI-specific data on a buddy list. */ |
5228 | 180 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
|
181 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
|
182 void (*update)(GaimBuddyList *list, |
5228 | 183 GaimBlistNode *node); /**< This will update a node in the buddy list. */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
184 void (*remove)(GaimBuddyList *list, |
5228 | 185 GaimBlistNode *node); /**< This removes a node from the list */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
186 void (*destroy)(GaimBuddyList *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
187 void (*set_visible)(GaimBuddyList *list, |
5228 | 188 gboolean show); /**< Hides or unhides the buddy list */ |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
189 void (*request_add_buddy)(GaimAccount *account, const char *username, |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
190 const char *group, const char *alias); |
7859 | 191 void (*request_add_chat)(GaimAccount *account, GaimGroup *group, |
9754 | 192 const char *alias, const char *name); |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
193 void (*request_add_group)(void); |
5228 | 194 }; |
195 | |
9030 | 196 |
197 struct _GaimBlistNodeAction { | |
198 char *label; | |
199 void (*callback)(GaimBlistNode *, gpointer); | |
200 gpointer data; | |
201 }; | |
202 | |
203 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
204 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
205 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
206 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
207 |
5228 | 208 /**************************************************************************/ |
209 /** @name Buddy List API */ | |
210 /**************************************************************************/ | |
211 /*@{*/ | |
212 | |
213 /** | |
214 * Creates a new buddy list | |
215 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
216 GaimBuddyList *gaim_blist_new(); |
5228 | 217 |
218 /** | |
219 * Sets the main buddy list. | |
220 * | |
221 * @return The main buddy list. | |
222 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
223 void gaim_set_blist(GaimBuddyList *blist); |
5228 | 224 |
225 /** | |
226 * Returns the main buddy list. | |
227 * | |
228 * @return The main buddy list. | |
229 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
230 GaimBuddyList *gaim_get_blist(void); |
5228 | 231 |
232 /** | |
233 * Shows the buddy list, creating a new one if necessary. | |
234 * | |
235 */ | |
236 void gaim_blist_show(); | |
237 | |
238 | |
239 /** | |
240 * Destroys the buddy list window. | |
241 */ | |
242 void gaim_blist_destroy(); | |
243 | |
244 /** | |
245 * Hides or unhides the buddy list. | |
246 * | |
247 * @param show Whether or not to show the buddy list | |
248 */ | |
249 void gaim_blist_set_visible(gboolean show); | |
250 | |
251 /** | |
252 * Updates a buddy's status. | |
5234 | 253 * |
5228 | 254 * This needs to not take an int. |
255 * | |
256 * @param buddy The buddy whose status has changed | |
257 * @param status The new status in cryptic prpl-understood code | |
258 */ | |
6695 | 259 void gaim_blist_update_buddy_status(GaimBuddy *buddy, int status); |
5228 | 260 |
261 | |
262 /** | |
263 * Updates a buddy's presence. | |
264 * | |
265 * @param buddy The buddy whose presence has changed | |
266 * @param presence The new presence | |
267 */ | |
6695 | 268 void gaim_blist_update_buddy_presence(GaimBuddy *buddy, int presence); |
5228 | 269 |
7950 | 270 /** |
271 * Updates a buddy's signon time. | |
272 * | |
273 * @param buddy The buddy whose idle time has changed. | |
274 * @param signon The buddy's signon time since the dawn of the UNIX epoch. | |
275 */ | |
276 void gaim_blist_update_buddy_signon(GaimBuddy *buddy, time_t signon); | |
5228 | 277 |
278 /** | |
279 * Updates a buddy's idle time. | |
280 * | |
281 * @param buddy The buddy whose idle time has changed | |
282 * @param idle The buddy's idle time in minutes. | |
283 */ | |
6695 | 284 void gaim_blist_update_buddy_idle(GaimBuddy *buddy, int idle); |
5228 | 285 |
286 | |
287 /** | |
288 * Updates a buddy's warning level. | |
289 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
290 * @param buddy The buddy whose warning level has changed. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
291 * @param warning The warning level as an int from 0 to 100. |
5228 | 292 */ |
6695 | 293 void gaim_blist_update_buddy_evil(GaimBuddy *buddy, int warning); |
5228 | 294 |
295 /** | |
296 * Updates a buddy's icon. | |
297 * | |
298 * @param buddy The buddy whose buddy icon has changed | |
299 */ | |
6695 | 300 void gaim_blist_update_buddy_icon(GaimBuddy *buddy); |
5228 | 301 |
302 /** | |
303 * Renames a buddy in the buddy list. | |
304 * | |
305 * @param buddy The buddy whose name will be changed. | |
306 * @param name The new name of the buddy. | |
307 */ | |
6695 | 308 void gaim_blist_rename_buddy(GaimBuddy *buddy, const char *name); |
5228 | 309 |
310 | |
311 /** | |
312 * Aliases a buddy in the buddy list. | |
313 * | |
314 * @param buddy The buddy whose alias will be changed. | |
315 * @param alias The buddy's alias. | |
316 */ | |
6695 | 317 void gaim_blist_alias_buddy(GaimBuddy *buddy, const char *alias); |
5228 | 318 |
5234 | 319 /** |
6059 | 320 * Sets the server-sent alias of a buddy in the buddy list. |
6058 | 321 * |
322 * @param buddy The buddy whose alias will be changed. | |
323 * @param alias The buddy's "official" alias. | |
324 */ | |
6695 | 325 void gaim_blist_server_alias_buddy(GaimBuddy *buddy, const char *alias); |
6058 | 326 |
327 /** | |
5234 | 328 * Aliases a chat in the buddy list. |
329 * | |
330 * @param chat The chat whose alias will be changed. | |
331 * @param alias The chat's new alias. | |
332 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
333 void gaim_blist_alias_chat(GaimChat *chat, const char *alias); |
5228 | 334 |
335 /** | |
336 * Renames a group | |
337 * | |
338 * @param group The group to rename | |
339 * @param name The new name | |
340 */ | |
6695 | 341 void gaim_blist_rename_group(GaimGroup *group, const char *name); |
5228 | 342 |
5234 | 343 /** |
344 * Creates a new chat for the buddy list | |
345 * | |
346 * @param account The account this chat will get added to | |
347 * @param alias The alias of the new chat | |
348 * @param components The info the prpl needs to join the chat | |
349 * @return A newly allocated chat | |
350 */ | |
7125 | 351 GaimChat *gaim_chat_new(GaimAccount *account, const char *alias, GHashTable *components); |
5234 | 352 |
353 /** | |
6034 | 354 * Gets the alias of the chat, or the chat name if the alias does not exist |
355 * | |
356 * @param chat The chat | |
357 * @return The display name of the chat | |
358 */ | |
7125 | 359 char *gaim_chat_get_display_name(GaimChat *chat); |
6034 | 360 |
361 /** | |
5234 | 362 * Adds a new chat to the buddy list. |
363 * | |
364 * The chat will be inserted right after node or appended to the end | |
365 * of group if node is NULL. If both are NULL, the buddy will be added to | |
366 * the "Chats" group. | |
367 * | |
368 * @param chat The new chat who gets added | |
369 * @param group The group to add the new chat to. | |
370 * @param node The insertion point | |
371 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7117
diff
changeset
|
372 void gaim_blist_add_chat(GaimChat *chat, GaimGroup *group, GaimBlistNode *node); |
5228 | 373 |
374 /** | |
375 * Creates a new buddy | |
376 * | |
377 * @param account The account this buddy will get added to | |
378 * @param screenname The screenname of the new buddy | |
379 * @param alias The alias of the new buddy (or NULL if unaliased) | |
380 * @return A newly allocated buddy | |
381 */ | |
6695 | 382 GaimBuddy *gaim_buddy_new(GaimAccount *account, const char *screenname, const char *alias); |
5228 | 383 |
384 /** | |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
385 * Sets a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
386 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
387 * 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
|
388 * call gaim_buddy_icon_set_data(). |
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 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
391 * @param icon The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
392 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
393 * @see gaim_buddy_icon_set_data() |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
394 */ |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
395 void gaim_buddy_set_icon(GaimBuddy *buddy, GaimBuddyIcon *icon); |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
396 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
397 /** |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
398 * Returns a buddy's icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
399 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
400 * @param buddy The buddy. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
401 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
402 * @return The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
403 */ |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
404 GaimBuddyIcon *gaim_buddy_get_icon(const GaimBuddy *buddy); |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
405 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6843
diff
changeset
|
406 /** |
7312 | 407 * Returns a buddy's contact. |
408 * | |
409 * @param buddy The buddy. | |
410 * | |
411 * @return The buddy's contact. | |
412 */ | |
413 GaimContact *gaim_buddy_get_contact(GaimBuddy *buddy); | |
414 | |
415 /** | |
5228 | 416 * Adds a new buddy to the buddy list. |
417 * | |
6695 | 418 * The buddy will be inserted right after node or prepended to the |
419 * group if node is NULL. If both are NULL, the buddy will be added to | |
5228 | 420 * the "Buddies" group. |
421 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
422 * @param buddy The new buddy who gets added |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
423 * @param contact The optional contact to place the buddy in. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
424 * @param group The group to add the new buddy to. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
425 * @param node The insertion point |
5228 | 426 */ |
6695 | 427 void gaim_blist_add_buddy(GaimBuddy *buddy, GaimContact *contact, GaimGroup *group, GaimBlistNode *node); |
5228 | 428 |
429 /** | |
430 * Creates a new group | |
431 * | |
6695 | 432 * You can't have more than one group with the same name. Sorry. If you pass |
433 * this the * name of a group that already exists, it will return that group. | |
5228 | 434 * |
435 * @param name The name of the new group | |
6695 | 436 * @return A new group struct |
5228 | 437 */ |
6695 | 438 GaimGroup *gaim_group_new(const char *name); |
5228 | 439 |
440 /** | |
441 * Adds a new group to the buddy list. | |
442 * | |
6695 | 443 * The new group will be inserted after insert or prepended to the list if |
444 * node is NULL. | |
445 * | |
446 * @param group The group | |
447 * @param node The insertion point | |
448 */ | |
449 void gaim_blist_add_group(GaimGroup *group, GaimBlistNode *node); | |
450 | |
451 /** | |
452 * Creates a new contact | |
5228 | 453 * |
6695 | 454 * @return A new contact struct |
5228 | 455 */ |
6695 | 456 GaimContact *gaim_contact_new(); |
457 | |
458 /** | |
459 * Adds a new contact to the buddy list. | |
460 * | |
461 * The new contact will be inserted after insert or prepended to the list if | |
462 * node is NULL. | |
463 * | |
464 * @param contact The contact | |
465 * @param group The group to add the contact to | |
466 * @param node The insertion point | |
467 */ | |
468 void gaim_blist_add_contact(GaimContact *contact, GaimGroup *group, GaimBlistNode *node); | |
469 | |
470 /** | |
6965 | 471 * Merges two contacts |
472 * | |
473 * All of the buddies from source will be moved to target | |
474 * | |
475 * @param source The contact to merge | |
7246 | 476 * @param node The place to merge to (a buddy or contact) |
6965 | 477 */ |
7246 | 478 void gaim_blist_merge_contact(GaimContact *source, GaimBlistNode *node); |
6965 | 479 |
480 /** | |
6695 | 481 * Returns the highest priority buddy for a given contact. |
482 * | |
483 * @param contact The contact | |
484 * @return The highest priority buddy | |
485 */ | |
486 GaimBuddy *gaim_contact_get_priority_buddy(GaimContact *contact); | |
5228 | 487 |
488 /** | |
6755 | 489 * Sets the alias for a contact. |
490 * | |
491 * @param contact The contact | |
492 * @param alias The alias to set, or NULL to unset | |
493 */ | |
494 void gaim_contact_set_alias(GaimContact *contact, const char *alias); | |
495 | |
496 /** | |
497 * Gets the alias for a contact. | |
498 * | |
499 * @param contact The contact | |
500 * @return The alias, or NULL if it is not set. | |
501 */ | |
502 const char *gaim_contact_get_alias(GaimContact *contact); | |
503 | |
504 /** | |
9787 | 505 * Determines whether an account owns any buddies in a given contact |
506 * | |
507 * @param contact The contact to search through. | |
508 * @param account The account. | |
509 * | |
510 * @return TRUE if there are any buddies from account in the contact, or FALSE otherwise. | |
511 */ | |
512 gboolean gaim_contact_on_account(GaimContact *contact, GaimAccount *account); | |
513 | |
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. |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
752 */ |
7859 | 753 void gaim_blist_request_add_chat(GaimAccount *account, GaimGroup *group, |
9754 | 754 const char *alias, const char *name); |
7060
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
755 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
756 /** |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
757 * 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
|
758 * buddy list. |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
759 */ |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
760 void gaim_blist_request_add_group(void); |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
761 |
9946001989a3
[gaim-migrate @ 7623]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
762 /** |
7693 | 763 * Associates a boolean with a node in the buddy list |
764 * | |
765 * @param node The node to associate the data with | |
766 * @param key The identifier for the data | |
767 * @param value The value to set | |
768 */ | |
769 void gaim_blist_node_set_bool(GaimBlistNode *node, const char *key, gboolean value); | |
770 | |
771 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
772 * Retrieves a named boolean setting from a node in the buddy list |
7693 | 773 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
774 * @param node The node to retrieve the data from |
7693 | 775 * @param key The identifier of the data |
776 * | |
777 * @return The value, or FALSE if there is no setting | |
778 */ | |
779 gboolean gaim_blist_node_get_bool(GaimBlistNode *node, const char *key); | |
780 | |
781 /** | |
782 * Associates an integer with a node in the buddy list | |
783 * | |
784 * @param node The node to associate the data with | |
785 * @param key The identifier for the data | |
786 * @param value The value to set | |
787 */ | |
788 void gaim_blist_node_set_int(GaimBlistNode *node, const char *key, int value); | |
789 | |
790 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
791 * Retrieves a named integer setting from a node in the buddy list |
7693 | 792 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
793 * @param node The node to retrieve the data from |
7693 | 794 * @param key The identifier of the data |
795 * | |
796 * @return The value, or 0 if there is no setting | |
797 */ | |
798 int gaim_blist_node_get_int(GaimBlistNode *node, const char *key); | |
799 | |
800 /** | |
801 * Associates a string with a node in the buddy list | |
802 * | |
803 * @param node The node to associate the data with | |
804 * @param key The identifier for the data | |
805 * @param value The value to set | |
806 */ | |
807 void gaim_blist_node_set_string(GaimBlistNode *node, const char *key, | |
808 const char *value); | |
809 | |
810 /** | |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
811 * Retrieves a named string setting from a node in the buddy list |
7693 | 812 * |
8735
92cbf9713795
[gaim-migrate @ 9490]
Christian Hammond <chipx86@chipx86.com>
parents:
8710
diff
changeset
|
813 * @param node The node to retrieve the data from |
7693 | 814 * @param key The identifier of the data |
815 * | |
816 * @return The value, or NULL if there is no setting | |
817 */ | |
818 const char *gaim_blist_node_get_string(GaimBlistNode *node, const char *key); | |
819 | |
820 /** | |
7811 | 821 * Removes a named setting from a blist node |
822 * | |
823 * @param node The node from which to remove the setting | |
824 * @param key The name of the setting | |
825 */ | |
826 void gaim_blist_node_remove_setting(GaimBlistNode *node, const char *key); | |
827 | |
5228 | 828 /*@}*/ |
829 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
830 |
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
831 /** |
9030 | 832 * Retrieves the extended menu items for a buddy list node. |
833 * @param n The blist node for which to obtain the extended menu items. | |
834 * @return list of GaimBlistNodeAction items, as harvested by the | |
835 * blist-node-extended-menu signal. | |
836 */ | |
837 GList *gaim_blist_node_get_extended_menu(GaimBlistNode *n); | |
838 | |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
839 |
8952 | 840 /** |
9030 | 841 * Creates a new GaimBlistNodeAction. |
842 * @param label The text label to display for this action. | |
843 * @param callback The function to be called when the action is used on | |
844 * a selected GaimBlistNode. | |
845 * @param data Additional data, to be passed to the callback | |
846 */ | |
847 GaimBlistNodeAction *gaim_blist_node_action_new(char *label, | |
848 void (*callback)(GaimBlistNode *, gpointer), gpointer data); | |
8952 | 849 |
8710
36b043fe2740
[gaim-migrate @ 9464]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
850 |
5228 | 851 /**************************************************************************/ |
852 /** @name UI Registration Functions */ | |
853 /**************************************************************************/ | |
854 /*@{*/ | |
855 | |
856 /** | |
857 * Sets the UI operations structure to be used for the buddy list. | |
858 * | |
859 * @param ops The ops struct. | |
860 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
861 void gaim_blist_set_ui_ops(GaimBlistUiOps *ops); |
5228 | 862 |
863 /** | |
864 * Returns the UI operations structure to be used for the buddy list. | |
865 * | |
866 * @return The UI operations structure. | |
867 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7060
diff
changeset
|
868 GaimBlistUiOps *gaim_blist_get_ui_ops(void); |
5228 | 869 |
870 /*@}*/ | |
871 | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
872 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
873 /** @name Buddy List Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
874 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
875 /*@{*/ |
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 * Returns the handle for the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
879 * |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
880 * @return The buddy list subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
881 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
882 void *gaim_blist_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
883 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
884 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
885 * Initializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
886 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
887 void gaim_blist_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
888 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
889 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
890 * Uninitializes the buddy list subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
891 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6456
diff
changeset
|
892 void gaim_blist_uninit(void); |
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 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
896 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
897 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
898 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
899 |
9713 | 900 #endif /* _GAIM_BLIST_H_ */ |