Mercurial > pidgin
comparison libpurple/buddyicon.h @ 15373:5fe8042783c1
Rename gtk/ and libgaim/ to pidgin/ and libpurple/
author | Sean Egan <seanegan@gmail.com> |
---|---|
date | Sat, 20 Jan 2007 02:32:10 +0000 |
parents | |
children | 32c366eeeb99 |
comparison
equal
deleted
inserted
replaced
15372:f79e0f4df793 | 15373:5fe8042783c1 |
---|---|
1 /** | |
2 * @file buddyicon.h Buddy Icon API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
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. | |
10 * | |
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 #ifndef _GAIM_BUDDYICON_H_ | |
26 #define _GAIM_BUDDYICON_H_ | |
27 | |
28 typedef struct _GaimBuddyIcon GaimBuddyIcon; | |
29 | |
30 #include "account.h" | |
31 #include "blist.h" | |
32 #include "prpl.h" | |
33 | |
34 struct _GaimBuddyIcon | |
35 { | |
36 GaimAccount *account; /**< The account the user is on. */ | |
37 char *username; /**< The username the icon belongs to. */ | |
38 | |
39 void *data; /**< The buddy icon data. */ | |
40 size_t len; /**< The length of the buddy icon data. */ | |
41 char *path; /**< The buddy icon's non-cached path. */ | |
42 | |
43 int ref_count; /**< The buddy icon reference count. */ | |
44 }; | |
45 | |
46 #ifdef __cplusplus | |
47 extern "C" { | |
48 #endif | |
49 | |
50 /**************************************************************************/ | |
51 /** @name Buddy Icon API */ | |
52 /**************************************************************************/ | |
53 /*@{*/ | |
54 | |
55 /** | |
56 * Creates a new buddy icon structure. | |
57 * | |
58 * @param account The account the user is on. | |
59 * @param username The username the icon belongs to. | |
60 * @param icon_data The buddy icon data. | |
61 * @param icon_len The buddy icon length. | |
62 * | |
63 * @return The buddy icon structure. | |
64 */ | |
65 GaimBuddyIcon *gaim_buddy_icon_new(GaimAccount *account, const char *username, | |
66 void *icon_data, size_t icon_len); | |
67 | |
68 /** | |
69 * Destroys a buddy icon structure. | |
70 * | |
71 * If the buddy icon's reference count is greater than 1, this will | |
72 * just decrease the reference count and return. | |
73 * | |
74 * @param icon The buddy icon structure to destroy. | |
75 */ | |
76 void gaim_buddy_icon_destroy(GaimBuddyIcon *icon); | |
77 | |
78 /** | |
79 * Increments the reference count on a buddy icon. | |
80 * | |
81 * @param icon The buddy icon. | |
82 * | |
83 * @return @a icon. | |
84 */ | |
85 GaimBuddyIcon *gaim_buddy_icon_ref(GaimBuddyIcon *icon); | |
86 | |
87 /** | |
88 * Decrements the reference count on a buddy icon. | |
89 * | |
90 * If the reference count reaches 0, the icon will be destroyed. | |
91 * | |
92 * @param icon The buddy icon. | |
93 * | |
94 * @return @a icon, or @c NULL if the reference count reached 0. | |
95 */ | |
96 GaimBuddyIcon *gaim_buddy_icon_unref(GaimBuddyIcon *icon); | |
97 | |
98 /** | |
99 * Updates every instance of this icon. | |
100 * | |
101 * @param icon The buddy icon. | |
102 */ | |
103 void gaim_buddy_icon_update(GaimBuddyIcon *icon); | |
104 | |
105 /** | |
106 * Caches a buddy icon associated with a specific buddy to disk. | |
107 * | |
108 * @param icon The buddy icon. | |
109 * @param buddy The buddy that this icon belongs to. | |
110 */ | |
111 void gaim_buddy_icon_cache(GaimBuddyIcon *icon, GaimBuddy *buddy); | |
112 | |
113 /** | |
114 * Removes cached buddy icon for a specific buddy. | |
115 * | |
116 * @param buddy The buddy for which to remove the cached icon. | |
117 */ | |
118 void gaim_buddy_icon_uncache(GaimBuddy *buddy); | |
119 | |
120 /** | |
121 * Sets the buddy icon's account. | |
122 * | |
123 * @param icon The buddy icon. | |
124 * @param account The account. | |
125 */ | |
126 void gaim_buddy_icon_set_account(GaimBuddyIcon *icon, GaimAccount *account); | |
127 | |
128 /** | |
129 * Sets the buddy icon's username. | |
130 * | |
131 * @param icon The buddy icon. | |
132 * @param username The username. | |
133 */ | |
134 void gaim_buddy_icon_set_username(GaimBuddyIcon *icon, const char *username); | |
135 | |
136 /** | |
137 * Sets the buddy icon's icon data. | |
138 * | |
139 * @param icon The buddy icon. | |
140 * @param data The buddy icon data. | |
141 * @param len The length of the icon data. | |
142 */ | |
143 void gaim_buddy_icon_set_data(GaimBuddyIcon *icon, void *data, size_t len); | |
144 | |
145 /** | |
146 * Sets the buddy icon's path. | |
147 * | |
148 * @param icon The buddy icon. | |
149 * @param path The buddy icon's non-cached path. | |
150 */ | |
151 void gaim_buddy_icon_set_path(GaimBuddyIcon *icon, const gchar *path); | |
152 | |
153 /** | |
154 * Returns the buddy icon's account. | |
155 * | |
156 * @param icon The buddy icon. | |
157 * | |
158 * @return The account. | |
159 */ | |
160 GaimAccount *gaim_buddy_icon_get_account(const GaimBuddyIcon *icon); | |
161 | |
162 /** | |
163 * Returns the buddy icon's username. | |
164 * | |
165 * @param icon The buddy icon. | |
166 * | |
167 * @return The username. | |
168 */ | |
169 const char *gaim_buddy_icon_get_username(const GaimBuddyIcon *icon); | |
170 | |
171 /** | |
172 * Returns the buddy icon's data. | |
173 * | |
174 * @param icon The buddy icon. | |
175 * @param len The returned icon length. | |
176 * | |
177 * @return The icon data. | |
178 */ | |
179 const guchar *gaim_buddy_icon_get_data(const GaimBuddyIcon *icon, size_t *len); | |
180 | |
181 /** | |
182 * Returns the buddy icon's path. | |
183 * | |
184 * @param icon The buddy icon. | |
185 * | |
186 * @preturn The buddy icon's non-cached path. | |
187 */ | |
188 const gchar *gaim_buddy_icon_get_path(GaimBuddyIcon *icon); | |
189 | |
190 /** | |
191 * Returns an extension corresponding to the buddy icon's file type. | |
192 * | |
193 * @param icon The buddy icon. | |
194 * | |
195 * @return The icon's extension. | |
196 */ | |
197 const char *gaim_buddy_icon_get_type(const GaimBuddyIcon *icon); | |
198 | |
199 /*@}*/ | |
200 | |
201 /**************************************************************************/ | |
202 /** @name Buddy Icon Subsystem API */ | |
203 /**************************************************************************/ | |
204 /*@{*/ | |
205 | |
206 /** | |
207 * Sets a buddy icon for a user. | |
208 * | |
209 * @param account The account the user is on. | |
210 * @param username The username of the user. | |
211 * @param icon_data The icon data. | |
212 * @param icon_len The length of the icon data. | |
213 * | |
214 * @return The buddy icon set, or NULL if no icon was set. | |
215 */ | |
216 void gaim_buddy_icons_set_for_user(GaimAccount *account, const char *username, | |
217 void *icon_data, size_t icon_len); | |
218 | |
219 /** | |
220 * Returns the buddy icon information for a user. | |
221 * | |
222 * @param account The account the user is on. | |
223 * @param username The username of the user. | |
224 * | |
225 * @return The icon data if found, or @c NULL if not found. | |
226 */ | |
227 GaimBuddyIcon *gaim_buddy_icons_find(GaimAccount *account, | |
228 const char *username); | |
229 | |
230 /** | |
231 * Sets whether or not buddy icon caching is enabled. | |
232 * | |
233 * @param caching TRUE of buddy icon caching should be enabled, or | |
234 * FALSE otherwise. | |
235 */ | |
236 void gaim_buddy_icons_set_caching(gboolean caching); | |
237 | |
238 /** | |
239 * Returns whether or not buddy icon caching should be enabled. | |
240 * | |
241 * The default is TRUE, unless otherwise specified by | |
242 * gaim_buddy_icons_set_caching(). | |
243 * | |
244 * @return TRUE if buddy icon caching is enabled, or FALSE otherwise. | |
245 */ | |
246 gboolean gaim_buddy_icons_is_caching(void); | |
247 | |
248 /** | |
249 * Sets the directory used to store buddy icon cache files. | |
250 * | |
251 * @param cache_dir The directory to store buddy icon cache files to. | |
252 */ | |
253 void gaim_buddy_icons_set_cache_dir(const char *cache_dir); | |
254 | |
255 /** | |
256 * Returns the directory used to store buddy icon cache files. | |
257 * | |
258 * The default directory is GAIMDIR/icons, unless otherwise specified | |
259 * by gaim_buddy_icons_set_cache_dir(). | |
260 * | |
261 * @return The directory to store buddy icon cache files to. | |
262 */ | |
263 const char *gaim_buddy_icons_get_cache_dir(void); | |
264 | |
265 /** | |
266 * Takes a buddy icon and returns a full path. | |
267 * | |
268 * If @a icon is a full path to an existing file, a copy of | |
269 * @a icon is returned. Otherwise, a newly allocated string | |
270 * consiting of gaim_buddy_icons_get_cache_dir() + @a icon is | |
271 * returned. | |
272 * | |
273 * @return The full path for an icon. | |
274 */ | |
275 char *gaim_buddy_icons_get_full_path(const char *icon); | |
276 | |
277 /** | |
278 * Returns the buddy icon subsystem handle. | |
279 * | |
280 * @return The subsystem handle. | |
281 */ | |
282 void *gaim_buddy_icons_get_handle(void); | |
283 | |
284 /** | |
285 * Initializes the buddy icon subsystem. | |
286 */ | |
287 void gaim_buddy_icons_init(void); | |
288 | |
289 /** | |
290 * Uninitializes the buddy icon subsystem. | |
291 */ | |
292 void gaim_buddy_icons_uninit(void); | |
293 | |
294 /*@}*/ | |
295 | |
296 /**************************************************************************/ | |
297 /** @name Buddy Icon Helper API */ | |
298 /**************************************************************************/ | |
299 /*@{*/ | |
300 | |
301 /** | |
302 * Gets display size for a buddy icon | |
303 */ | |
304 void gaim_buddy_icon_get_scale_size(GaimBuddyIconSpec *spec, int *width, int *height); | |
305 | |
306 /*@}*/ | |
307 | |
308 #ifdef __cplusplus | |
309 } | |
310 #endif | |
311 | |
312 #endif /* _GAIM_BUDDYICON_H_ */ |