comparison libpurple/buddyicon.h @ 32672:3828a61c44da

A boring and large patch so I can merge heads.
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Fri, 23 Dec 2011 08:21:58 +0000
parents 108455a3c019
children 98520ee78f12
comparison
equal deleted inserted replaced
32671:0e69949b3e61 32672:3828a61c44da
273 * Returns a boolean indicating if a given blist node has a custom buddy icon. 273 * Returns a boolean indicating if a given blist node has a custom buddy icon.
274 * 274 *
275 * @param node The blist node. 275 * @param node The blist node.
276 * 276 *
277 * @return A boolean indicating if @a node has a custom buddy icon. 277 * @return A boolean indicating if @a node has a custom buddy icon.
278 * @since 2.5.0
279 */ 278 */
280 gboolean 279 gboolean
281 purple_buddy_icons_node_has_custom_icon(PurpleBlistNode *node); 280 purple_buddy_icons_node_has_custom_icon(PurpleBlistNode *node);
282 281
283 /** 282 /**
291 * appropriate icon. 290 * appropriate icon.
292 * 291 *
293 * @param node The node. 292 * @param node The node.
294 * 293 *
295 * @return The custom buddy icon. 294 * @return The custom buddy icon.
296 * @since 2.5.0
297 */ 295 */
298 PurpleStoredImage * 296 PurpleStoredImage *
299 purple_buddy_icons_node_find_custom_icon(PurpleBlistNode *node); 297 purple_buddy_icons_node_find_custom_icon(PurpleBlistNode *node);
300 298
301 /** 299 /**
309 * free. Use NULL to unset the icon. 307 * free. Use NULL to unset the icon.
310 * @param icon_len The length of the data in @a icon_data. 308 * @param icon_len The length of the data in @a icon_data.
311 * 309 *
312 * @return The icon that was set. The caller does NOT own a reference to this, 310 * @return 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. 311 * and must call purple_imgstore_ref() if it wants one.
314 * @since 2.5.0
315 */ 312 */
316 PurpleStoredImage * 313 PurpleStoredImage *
317 purple_buddy_icons_node_set_custom_icon(PurpleBlistNode *node, 314 purple_buddy_icons_node_set_custom_icon(PurpleBlistNode *node,
318 guchar *icon_data, size_t icon_len); 315 guchar *icon_data, size_t icon_len);
319 316
327 * @param filename The path to the icon to set for the blist node. Use NULL 324 * @param filename The path to the icon to set for the blist node. Use NULL
328 * to unset the custom icon. 325 * to unset the custom icon.
329 * 326 *
330 * @return The icon that was set. The caller does NOT own a reference to this, 327 * @return The icon that was set. The caller does NOT own a reference to this,
331 * and must call purple_imgstore_ref() if it wants one. 328 * and must call purple_imgstore_ref() if it wants one.
332 * @since 2.5.0
333 */ 329 */
334 PurpleStoredImage * 330 PurpleStoredImage *
335 purple_buddy_icons_node_set_custom_icon_from_file(PurpleBlistNode *node, 331 purple_buddy_icons_node_set_custom_icon_from_file(PurpleBlistNode *node,
336 const gchar *filename); 332 const gchar *filename);
337 333
338 #if !(defined PURPLE_DISABLE_DEPRECATED) || (defined _PURPLE_BUDDYICON_C_)
339 /**
340 * PurpleContact version of purple_buddy_icons_node_has_custom_icon.
341 *
342 * @copydoc purple_buddy_icons_node_has_custom_icon()
343 *
344 * @deprecated Use purple_buddy_icons_node_has_custom_icon instead.
345 */
346 gboolean
347 purple_buddy_icons_has_custom_icon(PurpleContact *contact);
348
349 /**
350 * PurpleContact version of purple_buddy_icons_node_find_custom_icon.
351 *
352 * @copydoc purple_buddy_icons_node_find_custom_icon()
353 *
354 * @deprecated Use purple_buddy_icons_node_find_custom_icon instead.
355 */
356 PurpleStoredImage *
357 purple_buddy_icons_find_custom_icon(PurpleContact *contact);
358
359 /**
360 * PurpleContact version of purple_buddy_icons_node_set_custom_icon.
361 *
362 * @copydoc purple_buddy_icons_node_set_custom_icon()
363 *
364 * @deprecated Use purple_buddy_icons_node_set_custom_icon instead.
365 */
366 PurpleStoredImage *
367 purple_buddy_icons_set_custom_icon(PurpleContact *contact,
368 guchar *icon_data, size_t icon_len);
369 #endif
370
371 /** 334 /**
372 * Sets whether or not buddy icon caching is enabled. 335 * Sets whether or not buddy icon caching is enabled.
373 * 336 *
374 * @param caching TRUE of buddy icon caching should be enabled, or 337 * @param caching TRUE of buddy icon caching should be enabled, or
375 * FALSE otherwise. 338 * FALSE otherwise.