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