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