libpurple/buddyicon.h

branch
gtkdoc-conversion
changeset 35397
31fa3a1aeff5
parent 35393
00f876b129bc
child 35433
8dcae6cd6628
child 37040
91119588bc3a
equal deleted inserted replaced
35396:7bfe75a37af7 35397:31fa3a1aeff5
26 #ifndef _PURPLE_BUDDYICON_H_ 26 #ifndef _PURPLE_BUDDYICON_H_
27 #define _PURPLE_BUDDYICON_H_ 27 #define _PURPLE_BUDDYICON_H_
28 28
29 #define PURPLE_TYPE_BUDDY_ICON (purple_buddy_icon_get_type()) 29 #define PURPLE_TYPE_BUDDY_ICON (purple_buddy_icon_get_type())
30 30
31 /** An opaque structure representing a buddy icon for a particular user on a 31 /**
32 * particular #PurpleAccount. Instances are reference-counted; use 32 * PurpleBuddyIcon:
33 * purple_buddy_icon_ref() and purple_buddy_icon_unref() to take and release 33 *
34 * references. 34 * An opaque structure representing a buddy icon for a particular user on a
35 * particular #PurpleAccount. Instances are reference-counted; use
36 * purple_buddy_icon_ref() and purple_buddy_icon_unref() to take and release
37 * references.
35 */ 38 */
36 typedef struct _PurpleBuddyIcon PurpleBuddyIcon; 39 typedef struct _PurpleBuddyIcon PurpleBuddyIcon;
37 40
38 #include "account.h" 41 #include "account.h"
39 #include "buddylist.h" 42 #include "buddylist.h"
47 /** @name Buddy Icon API */ 50 /** @name Buddy Icon API */
48 /**************************************************************************/ 51 /**************************************************************************/
49 /*@{*/ 52 /*@{*/
50 53
51 /** 54 /**
55 * purple_buddy_icon_get_type:
56 *
52 * Returns the GType for the PurpleBuddyIcon boxed structure. 57 * Returns the GType for the PurpleBuddyIcon boxed structure.
53 */ 58 */
54 GType purple_buddy_icon_get_type(void); 59 GType purple_buddy_icon_get_type(void);
55 60
56 /** 61 /**
57 * Creates a new buddy icon structure and populates it. 62 * purple_buddy_icon_new:
58 *
59 * If an icon for this account+username already exists, you'll get a reference
60 * to that structure, which will have been updated with the data supplied.
61 *
62 * @account: The account the user is on. 63 * @account: The account the user is on.
63 * @username: The username the icon belongs to. 64 * @username: The username the icon belongs to.
64 * @icon_data: The buddy icon data. 65 * @icon_data: The buddy icon data.
65 * @icon_len: The buddy icon length. 66 * @icon_len: The buddy icon length.
66 * @checksum: A protocol checksum from the prpl or %NULL. 67 * @checksum: A protocol checksum from the protocol or %NULL.
68 *
69 * Creates a new buddy icon structure and populates it.
70 *
71 * If an icon for this account+username already exists, you'll get a reference
72 * to that structure, which will have been updated with the data supplied.
67 * 73 *
68 * Returns: The buddy icon structure, with a reference for the caller. 74 * Returns: The buddy icon structure, with a reference for the caller.
69 */ 75 */
70 PurpleBuddyIcon *purple_buddy_icon_new(PurpleAccount *account, const char *username, 76 PurpleBuddyIcon *purple_buddy_icon_new(PurpleAccount *account, const char *username,
71 void *icon_data, size_t icon_len, 77 void *icon_data, size_t icon_len,
72 const char *checksum); 78 const char *checksum);
73 79
74 /** 80 /**
81 * purple_buddy_icon_ref:
82 * @icon: The buddy icon.
83 *
75 * Increments the reference count on a buddy icon. 84 * Increments the reference count on a buddy icon.
76 * 85 *
77 * @icon: The buddy icon. 86 * Returns: @icon.
78 *
79 * Returns: @a icon.
80 */ 87 */
81 PurpleBuddyIcon *purple_buddy_icon_ref(PurpleBuddyIcon *icon); 88 PurpleBuddyIcon *purple_buddy_icon_ref(PurpleBuddyIcon *icon);
82 89
83 /** 90 /**
91 * purple_buddy_icon_unref:
92 * @icon: The buddy icon.
93 *
84 * Decrements the reference count on a buddy icon. 94 * Decrements the reference count on a buddy icon.
85 * 95 *
86 * If the reference count reaches 0, the icon will be destroyed. 96 * If the reference count reaches 0, the icon will be destroyed.
87 *
88 * @icon: The buddy icon.
89 */ 97 */
90 void purple_buddy_icon_unref(PurpleBuddyIcon *icon); 98 void purple_buddy_icon_unref(PurpleBuddyIcon *icon);
91 99
92 /** 100 /**
101 * purple_buddy_icon_update:
102 * @icon: The buddy icon.
103 *
93 * Updates every instance of this icon. 104 * Updates every instance of this icon.
94 *
95 * @icon: The buddy icon.
96 */ 105 */
97 void purple_buddy_icon_update(PurpleBuddyIcon *icon); 106 void purple_buddy_icon_update(PurpleBuddyIcon *icon);
98 107
99 /** 108 /**
100 * Sets the buddy icon's data. 109 * purple_buddy_icon_set_data:
101 *
102 * @icon: The buddy icon. 110 * @icon: The buddy icon.
103 * @data: The buddy icon data, which the buddy icon code 111 * @data: The buddy icon data, which the buddy icon code
104 * takes ownership of and will free. 112 * takes ownership of and will free.
105 * @len: The length of the data in @a data. 113 * @len: The length of the data in @a data.
106 * @checksum: A protocol checksum from the prpl or %NULL. 114 * @checksum: A protocol checksum from the protocol or %NULL.
115 *
116 * Sets the buddy icon's data.
107 */ 117 */
108 void 118 void
109 purple_buddy_icon_set_data(PurpleBuddyIcon *icon, guchar *data, 119 purple_buddy_icon_set_data(PurpleBuddyIcon *icon, guchar *data,
110 size_t len, const char *checksum); 120 size_t len, const char *checksum);
111 121
112 /** 122 /**
123 * purple_buddy_icon_get_account:
124 * @icon: The buddy icon.
125 *
113 * Returns the buddy icon's account. 126 * Returns the buddy icon's account.
114 * 127 *
115 * @icon: The buddy icon.
116 *
117 * Returns: The account. 128 * Returns: The account.
118 */ 129 */
119 PurpleAccount *purple_buddy_icon_get_account(const PurpleBuddyIcon *icon); 130 PurpleAccount *purple_buddy_icon_get_account(const PurpleBuddyIcon *icon);
120 131
121 /** 132 /**
133 * purple_buddy_icon_get_username:
134 * @icon: The buddy icon.
135 *
122 * Returns the buddy icon's username. 136 * Returns the buddy icon's username.
123 * 137 *
124 * @icon: The buddy icon.
125 *
126 * Returns: The username. 138 * Returns: The username.
127 */ 139 */
128 const char *purple_buddy_icon_get_username(const PurpleBuddyIcon *icon); 140 const char *purple_buddy_icon_get_username(const PurpleBuddyIcon *icon);
129 141
130 /** 142 /**
143 * purple_buddy_icon_get_checksum:
144 * @icon: The buddy icon.
145 *
131 * Returns the buddy icon's checksum. 146 * Returns the buddy icon's checksum.
132 * 147 *
133 * This function is really only for prpl use. 148 * This function is really only for protocol use.
134 *
135 * @icon: The buddy icon.
136 * 149 *
137 * Returns: The checksum. 150 * Returns: The checksum.
138 */ 151 */
139 const char *purple_buddy_icon_get_checksum(const PurpleBuddyIcon *icon); 152 const char *purple_buddy_icon_get_checksum(const PurpleBuddyIcon *icon);
140 153
141 /** 154 /**
142 * Returns the buddy icon's data. 155 * purple_buddy_icon_get_data:
143 *
144 * @icon: The buddy icon. 156 * @icon: The buddy icon.
145 * @len: If not %NULL, the length of the icon data returned will be 157 * @len: If not %NULL, the length of the icon data returned will be
146 * set in the location pointed to by this. 158 * set in the location pointed to by this.
147 * 159 *
160 * Returns the buddy icon's data.
161 *
148 * Returns: A pointer to the icon data. 162 * Returns: A pointer to the icon data.
149 */ 163 */
150 gconstpointer purple_buddy_icon_get_data(const PurpleBuddyIcon *icon, size_t *len); 164 gconstpointer purple_buddy_icon_get_data(const PurpleBuddyIcon *icon, size_t *len);
151 165
152 /** 166 /**
167 * purple_buddy_icon_get_extension:
168 * @icon: The buddy icon.
169 *
153 * Returns an extension corresponding to the buddy icon's file type. 170 * Returns an extension corresponding to the buddy icon's file type.
154 *
155 * @icon: The buddy icon.
156 * 171 *
157 * Returns: The icon's extension, "icon" if unknown, or %NULL if 172 * Returns: The icon's extension, "icon" if unknown, or %NULL if
158 * the image data has disappeared. 173 * the image data has disappeared.
159 */ 174 */
160 const char *purple_buddy_icon_get_extension(const PurpleBuddyIcon *icon); 175 const char *purple_buddy_icon_get_extension(const PurpleBuddyIcon *icon);
161 176
162 /** 177 /**
178 * purple_buddy_icon_get_full_path:
179 * @icon: The buddy icon
180 *
163 * Returns a full path to an icon. 181 * Returns a full path to an icon.
164 * 182 *
165 * If the icon has data and the file exists in the cache, this will return 183 * If the icon has data and the file exists in the cache, this will return
166 * a full path to the cache file. 184 * a full path to the cache file.
167 * 185 *
168 * In general, it is not appropriate to be poking in the icon cache 186 * In general, it is not appropriate to be poking in the icon cache
169 * directly. If you find yourself wanting to use this function, think 187 * directly. If you find yourself wanting to use this function, think
170 * very long and hard about it, and then don't. 188 * very long and hard about it, and then don't.
171 * 189 *
172 * @icon: The buddy icon
173 *
174 * Returns: A full path to the file, or %NULL under various conditions. 190 * Returns: A full path to the file, or %NULL under various conditions.
175 */ 191 */
176 char *purple_buddy_icon_get_full_path(PurpleBuddyIcon *icon); 192 char *purple_buddy_icon_get_full_path(PurpleBuddyIcon *icon);
177 193
178 /*@}*/ 194 /*@}*/
181 /** @name Buddy Icon Subsystem API */ 197 /** @name Buddy Icon Subsystem API */
182 /**************************************************************************/ 198 /**************************************************************************/
183 /*@{*/ 199 /*@{*/
184 200
185 /** 201 /**
186 * Sets a buddy icon for a user. 202 * purple_buddy_icons_set_for_user:
187 *
188 * @account: The account the user is on. 203 * @account: The account the user is on.
189 * @username: The username of the user. 204 * @username: The username of the user.
190 * @icon_data: The buddy icon data, which the buddy icon code 205 * @icon_data: The buddy icon data, which the buddy icon code
191 * takes ownership of and will free. 206 * takes ownership of and will free.
192 * @icon_len: The length of the icon data. 207 * @icon_len: The length of the icon data.
193 * @checksum: A protocol checksum from the prpl or %NULL. 208 * @checksum: A protocol checksum from the protocol or %NULL.
209 *
210 * Sets a buddy icon for a user.
194 */ 211 */
195 void 212 void
196 purple_buddy_icons_set_for_user(PurpleAccount *account, const char *username, 213 purple_buddy_icons_set_for_user(PurpleAccount *account, const char *username,
197 void *icon_data, size_t icon_len, 214 void *icon_data, size_t icon_len,
198 const char *checksum); 215 const char *checksum);
199 216
200 /** 217 /**
218 * purple_buddy_icons_get_checksum_for_user:
219 * @buddy: The buddy
220 *
201 * Returns the checksum for the buddy icon of a specified buddy. 221 * Returns the checksum for the buddy icon of a specified buddy.
202 * 222 *
203 * This avoids loading the icon image data from the cache if it's 223 * This avoids loading the icon image data from the cache if it's
204 * not already loaded for some other reason. 224 * not already loaded for some other reason.
205 * 225 *
206 * @buddy: The buddy
207 *
208 * Returns: The checksum. 226 * Returns: The checksum.
209 */ 227 */
210 const char * 228 const char *
211 purple_buddy_icons_get_checksum_for_user(PurpleBuddy *buddy); 229 purple_buddy_icons_get_checksum_for_user(PurpleBuddy *buddy);
212 230
213 /** 231 /**
214 * Returns the buddy icon information for a user. 232 * purple_buddy_icons_find:
215 *
216 * @account: The account the user is on. 233 * @account: The account the user is on.
217 * @username: The username of the user. 234 * @username: The username of the user.
218 * 235 *
236 * Returns the buddy icon information for a user.
237 *
219 * Returns: The icon (with a reference for the caller) if found, or %NULL if 238 * Returns: The icon (with a reference for the caller) if found, or %NULL if
220 * not found. 239 * not found.
221 */ 240 */
222 PurpleBuddyIcon * 241 PurpleBuddyIcon *
223 purple_buddy_icons_find(PurpleAccount *account, const char *username); 242 purple_buddy_icons_find(PurpleAccount *account, const char *username);
224 243
225 /** 244 /**
245 * purple_buddy_icons_find_account_icon:
246 * @account: The account
247 *
226 * Returns the buddy icon image for an account. 248 * Returns the buddy icon image for an account.
227 * 249 *
228 * The caller owns a reference to the image in the store, and must dereference 250 * The caller owns a reference to the image in the store, and must dereference
229 * the image with purple_imgstore_unref() for it to be freed. 251 * the image with purple_imgstore_unref() for it to be freed.
230 * 252 *
231 * This function deals with loading the icon from the cache, if 253 * This function deals with loading the icon from the cache, if
232 * needed, so it should be called in any case where you want the 254 * needed, so it should be called in any case where you want the
233 * appropriate icon. 255 * appropriate icon.
234 * 256 *
235 * @account: The account
236 *
237 * Returns: The account's buddy icon image. 257 * Returns: The account's buddy icon image.
238 */ 258 */
239 PurpleStoredImage * 259 PurpleStoredImage *
240 purple_buddy_icons_find_account_icon(PurpleAccount *account); 260 purple_buddy_icons_find_account_icon(PurpleAccount *account);
241 261
242 /** 262 /**
243 * Sets a buddy icon for an account. 263 * purple_buddy_icons_set_account_icon:
244 *
245 * This function will deal with saving a record of the icon,
246 * caching the data, etc.
247 *
248 * @account: The account for which to set a custom icon. 264 * @account: The account for which to set a custom icon.
249 * @icon_data: The image data of the icon, which the 265 * @icon_data: The image data of the icon, which the
250 * buddy icon code will free. 266 * buddy icon code will free.
251 * @icon_len: The length of the data in @a icon_data. 267 * @icon_len: The length of the data in @icon_data.
268 *
269 * Sets a buddy icon for an account.
270 *
271 * This function will deal with saving a record of the icon,
272 * caching the data, etc.
252 * 273 *
253 * Returns: The icon that was set. The caller does NOT own 274 * Returns: The icon that was set. The caller does NOT own
254 * a reference to this, and must call purple_imgstore_ref() 275 * a reference to this, and must call purple_imgstore_ref()
255 * if it wants one. 276 * if it wants one.
256 */ 277 */
257 PurpleStoredImage * 278 PurpleStoredImage *
258 purple_buddy_icons_set_account_icon(PurpleAccount *account, 279 purple_buddy_icons_set_account_icon(PurpleAccount *account,
259 guchar *icon_data, size_t icon_len); 280 guchar *icon_data, size_t icon_len);
260 281
261 /** 282 /**
283 * purple_buddy_icons_get_account_icon_timestamp:
284 * @account: The account
285 *
262 * Returns the timestamp of when the icon was set. 286 * Returns the timestamp of when the icon was set.
263 * 287 *
264 * This is intended for use in protocols that require a timestamp for 288 * This is intended for use in protocols that require a timestamp for
265 * buddy icon update reasons. 289 * buddy icon update reasons.
266 * 290 *
267 * @account: The account
268 *
269 * Returns: The time the icon was set, or 0 if an error occurred. 291 * Returns: The time the icon was set, or 0 if an error occurred.
270 */ 292 */
271 time_t 293 time_t
272 purple_buddy_icons_get_account_icon_timestamp(PurpleAccount *account); 294 purple_buddy_icons_get_account_icon_timestamp(PurpleAccount *account);
273 295
274 /** 296 /**
297 * purple_buddy_icons_node_has_custom_icon:
298 * @node: The blist node.
299 *
275 * Returns a boolean indicating if a given blist node has a custom buddy icon. 300 * Returns a boolean indicating if a given blist node has a custom buddy icon.
276 * 301 *
277 * @node: The blist node. 302 * Returns: A boolean indicating if @node has a custom buddy icon.
278 *
279 * Returns: A boolean indicating if @a node has a custom buddy icon.
280 */ 303 */
281 gboolean 304 gboolean
282 purple_buddy_icons_node_has_custom_icon(PurpleBlistNode *node); 305 purple_buddy_icons_node_has_custom_icon(PurpleBlistNode *node);
283 306
284 /** 307 /**
308 * purple_buddy_icons_node_find_custom_icon:
309 * @node: The node.
310 *
285 * Returns the custom buddy icon image for a blist node. 311 * Returns the custom buddy icon image for a blist node.
286 * 312 *
287 * The caller owns a reference to the image in the store, and must dereference 313 * The caller owns a reference to the image in the store, and must dereference
288 * the image with purple_imgstore_unref() for it to be freed. 314 * the image with purple_imgstore_unref() for it to be freed.
289 * 315 *
290 * This function deals with loading the icon from the cache, if 316 * This function deals with loading the icon from the cache, if
291 * needed, so it should be called in any case where you want the 317 * needed, so it should be called in any case where you want the
292 * appropriate icon. 318 * appropriate icon.
293 * 319 *
294 * @node: The node.
295 *
296 * Returns: The custom buddy icon. 320 * Returns: The custom buddy icon.
297 */ 321 */
298 PurpleStoredImage * 322 PurpleStoredImage *
299 purple_buddy_icons_node_find_custom_icon(PurpleBlistNode *node); 323 purple_buddy_icons_node_find_custom_icon(PurpleBlistNode *node);
300 324
301 /** 325 /**
302 * Sets a custom buddy icon for a blist node. 326 * purple_buddy_icons_node_set_custom_icon:
303 *
304 * This function will deal with saving a record of the icon, caching the data,
305 * etc.
306 *
307 * @node: The blist node for which to set a custom icon. 327 * @node: The blist node for which to set a custom icon.
308 * @icon_data: The image data of the icon, which the buddy icon code will 328 * @icon_data: The image data of the icon, which the buddy icon code will
309 * free. Use NULL to unset the icon. 329 * free. Use NULL to unset the icon.
310 * @icon_len: The length of the data in @a icon_data. 330 * @icon_len: The length of the data in @icon_data.
331 *
332 * Sets a custom buddy icon for a blist node.
333 *
334 * This function will deal with saving a record of the icon, caching the data,
335 * etc.
311 * 336 *
312 * Returns: The icon that was set. The caller does NOT own a reference to this, 337 * Returns: The icon that was set. The caller does NOT own a reference to this,
313 * and must call purple_imgstore_ref() if it wants one. 338 * and must call purple_imgstore_ref() if it wants one.
314 */ 339 */
315 PurpleStoredImage * 340 PurpleStoredImage *
316 purple_buddy_icons_node_set_custom_icon(PurpleBlistNode *node, 341 purple_buddy_icons_node_set_custom_icon(PurpleBlistNode *node,
317 guchar *icon_data, size_t icon_len); 342 guchar *icon_data, size_t icon_len);
318 343
319 /** 344 /**
320 * Sets a custom buddy icon for a blist node. 345 * purple_buddy_icons_node_set_custom_icon_from_file:
321 *
322 * Convenience wrapper around purple_buddy_icons_node_set_custom_icon.
323 * @see purple_buddy_icons_node_set_custom_icon()
324 *
325 * @node: The blist node for which to set a custom icon. 346 * @node: The blist node for which to set a custom icon.
326 * @filename: The path to the icon to set for the blist node. Use NULL 347 * @filename: The path to the icon to set for the blist node. Use NULL
327 * to unset the custom icon. 348 * to unset the custom icon.
328 * 349 *
350 * Sets a custom buddy icon for a blist node.
351 *
352 * Convenience wrapper around purple_buddy_icons_node_set_custom_icon.
353 * @see purple_buddy_icons_node_set_custom_icon()
354 *
329 * Returns: The icon that was set. The caller does NOT own a reference to this, 355 * Returns: The icon that was set. The caller does NOT own a reference to this,
330 * and must call purple_imgstore_ref() if it wants one. 356 * and must call purple_imgstore_ref() if it wants one.
331 */ 357 */
332 PurpleStoredImage * 358 PurpleStoredImage *
333 purple_buddy_icons_node_set_custom_icon_from_file(PurpleBlistNode *node, 359 purple_buddy_icons_node_set_custom_icon_from_file(PurpleBlistNode *node,
334 const gchar *filename); 360 const gchar *filename);
335 361
336 /** 362 /**
337 * Sets whether or not buddy icon caching is enabled. 363 * purple_buddy_icons_set_caching:
338 *
339 * @caching: TRUE if buddy icon caching should be enabled, or 364 * @caching: TRUE if buddy icon caching should be enabled, or
340 * FALSE otherwise. 365 * FALSE otherwise.
366 *
367 * Sets whether or not buddy icon caching is enabled.
341 */ 368 */
342 void purple_buddy_icons_set_caching(gboolean caching); 369 void purple_buddy_icons_set_caching(gboolean caching);
343 370
344 /** 371 /**
372 * purple_buddy_icons_is_caching:
373 *
345 * Returns whether or not buddy icon caching should be enabled. 374 * Returns whether or not buddy icon caching should be enabled.
346 * 375 *
347 * The default is TRUE, unless otherwise specified by 376 * The default is TRUE, unless otherwise specified by
348 * purple_buddy_icons_set_caching(). 377 * purple_buddy_icons_set_caching().
349 * 378 *
350 * Returns: TRUE if buddy icon caching is enabled, or FALSE otherwise. 379 * Returns: TRUE if buddy icon caching is enabled, or FALSE otherwise.
351 */ 380 */
352 gboolean purple_buddy_icons_is_caching(void); 381 gboolean purple_buddy_icons_is_caching(void);
353 382
354 /** 383 /**
384 * purple_buddy_icons_set_cache_dir:
385 * @cache_dir: The directory to store buddy icon cache files to.
386 *
355 * Sets the directory used to store buddy icon cache files. 387 * Sets the directory used to store buddy icon cache files.
356 *
357 * @cache_dir: The directory to store buddy icon cache files to.
358 */ 388 */
359 void purple_buddy_icons_set_cache_dir(const char *cache_dir); 389 void purple_buddy_icons_set_cache_dir(const char *cache_dir);
360 390
361 /** 391 /**
392 * purple_buddy_icons_get_cache_dir:
393 *
362 * Returns the directory used to store buddy icon cache files. 394 * Returns the directory used to store buddy icon cache files.
363 * 395 *
364 * The default directory is PURPLEDIR/icons, unless otherwise specified 396 * The default directory is PURPLEDIR/icons, unless otherwise specified
365 * by purple_buddy_icons_set_cache_dir(). 397 * by purple_buddy_icons_set_cache_dir().
366 * 398 *
367 * Returns: The directory to store buddy icon cache files to. 399 * Returns: The directory to store buddy icon cache files to.
368 */ 400 */
369 const char *purple_buddy_icons_get_cache_dir(void); 401 const char *purple_buddy_icons_get_cache_dir(void);
370 402
371 /** 403 /**
404 * purple_buddy_icons_get_handle:
405 *
372 * Returns the buddy icon subsystem handle. 406 * Returns the buddy icon subsystem handle.
373 * 407 *
374 * Returns: The subsystem handle. 408 * Returns: The subsystem handle.
375 */ 409 */
376 void *purple_buddy_icons_get_handle(void); 410 void *purple_buddy_icons_get_handle(void);
377 411
378 /** 412 /**
413 * purple_buddy_icons_init:
414 *
379 * Initializes the buddy icon subsystem. 415 * Initializes the buddy icon subsystem.
380 */ 416 */
381 void purple_buddy_icons_init(void); 417 void purple_buddy_icons_init(void);
382 418
383 /** 419 /**
420 * purple_buddy_icons_uninit:
421 *
384 * Uninitializes the buddy icon subsystem. 422 * Uninitializes the buddy icon subsystem.
385 */ 423 */
386 void purple_buddy_icons_uninit(void); 424 void purple_buddy_icons_uninit(void);
387 425
388 /*@}*/ 426 /*@}*/
391 /** @name Buddy Icon Helper API */ 429 /** @name Buddy Icon Helper API */
392 /**************************************************************************/ 430 /**************************************************************************/
393 /*@{*/ 431 /*@{*/
394 432
395 /** 433 /**
434 * purple_buddy_icon_get_scale_size:
435 *
396 * Gets display size for a buddy icon 436 * Gets display size for a buddy icon
397 */ 437 */
398 void purple_buddy_icon_get_scale_size(PurpleBuddyIconSpec *spec, int *width, int *height); 438 void purple_buddy_icon_get_scale_size(PurpleBuddyIconSpec *spec, int *width, int *height);
399 439
400 /*@}*/ 440 /*@}*/

mercurial