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