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