Mercurial > pidgin.yaz
view libpurple/buddyicon.h @ 16373:c9b4ff420140
The buddy icon code as it stands, with lots of bugs and design flaws.
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Mon, 23 Apr 2007 17:39:58 +0000 |
parents | b449dc6b8a20 |
children | 391a79778f89 |
line wrap: on
line source
/** * @file buddyicon.h Buddy Icon API * @ingroup core * * purple * * Purple is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _PURPLE_BUDDYICON_H_ #define _PURPLE_BUDDYICON_H_ typedef struct _PurpleBuddyIcon PurpleBuddyIcon; #include "account.h" #include "blist.h" #include "prpl.h" #ifdef __cplusplus extern "C" { #endif // TODO: Deal with this. char *purple_buddy_icons_get_full_path(const char *icon); /**************************************************************************/ /** @name Buddy Icon API */ /**************************************************************************/ /*@{*/ /** * Create a buddy icon structure and populate it. * * If the buddy icon already exists, you'll get a reference to that structure, * which will have been updated with the data supplied. * * @param account The account the user is on. * @param username The username the icon belongs to. * @param protocol_icon_data The buddy icon data received over the wire. * @param protocol_icon_len The length of the data in @a protocol_icon_data. * @param custom_icon_data The data for a custom buddy icon set by the user. * @param custom_icon_len The length of the data in @a custom_icon-data. * @return The buddy icon structure, referenced for you. If you don't * want the reference, then call purple_buddy_icon_unref(). However, * you may want to use purple_buddy_icon_set_for_user() instead. */ PurpleBuddyIcon * purple_buddy_icon_new(PurpleAccount *account, const char *username, void *protocol_icon_data, size_t protocol_icon_len, void *custom_icon_data, size_t custom_icon_len); /** * Increments the reference count on a buddy icon. * * @param icon The buddy icon. * * @return @a icon. */ PurpleBuddyIcon *purple_buddy_icon_ref(PurpleBuddyIcon *icon); /** * Decrements the reference count on a buddy icon. * * If the reference count reaches 0, the icon will be destroyed. * * @param icon The buddy icon. * * @return @a icon, or @c NULL if the reference count reached 0. */ PurpleBuddyIcon *purple_buddy_icon_unref(PurpleBuddyIcon *icon); /** * Updates every instance of this icon. * * @param icon The buddy icon. */ void purple_buddy_icon_update(PurpleBuddyIcon *icon); /** * Sets the buddy icon's data for a custom icon set by the user. * * @param icon The buddy icon. * @param data The buddy icon data for the custom icon set by the user. * @param len The length of the data in @a data. */ void purple_buddy_icon_set_custom_data(PurpleBuddyIcon *icon, guchar *data, size_t len); /** * Sets the buddy icon's data that was received over the wire. * * @param icon The buddy icon. * @param data The buddy icon data received over the wire. * @param len The length of the data in @a data. */ void purple_buddy_icon_set_protocol_data(PurpleBuddyIcon *icon, guchar *data, size_t len); /** * Returns the buddy icon's account. * * @param icon The buddy icon. * * @return The account. */ PurpleAccount *purple_buddy_icon_get_account(const PurpleBuddyIcon *icon); /** * Returns the buddy icon's username. * * @param icon The buddy icon. * * @return The username. */ const char *purple_buddy_icon_get_username(const PurpleBuddyIcon *icon); /** * Returns the buddy icon's data. * * This will return the data for a custom icon, if one has been set by the * user. Otherwise, it will return the protocol data, if available. If * no data is available (which can happen if you're holding on to a * reference to an icon and the protocol and/or custom icon(s) are deleted * under you), it will return @c NULL. * * @param icon The buddy icon. * @param len If not @c NULL, the length of the icon data returned will be * set in the location pointed to by this. * * @return The icon data. */ const guchar *purple_buddy_icon_get_data(const PurpleBuddyIcon *icon, size_t *len); /** * Returns an extension corresponding to the buddy icon's file type. * * This will return the type of a custom icon, if one has been set by the * user. Otherwise, it will return the type of the protocol icon, if * available. If no data is available (which can happen if you're holding on * to a reference to an icon and the protocol and/or custom icon(s) are deleted * under you), it will return @c NULL. * * @param icon The buddy icon. * * @return The icon's extension, or "icon" if unknown. */ const char *purple_buddy_icon_get_type(const PurpleBuddyIcon *icon); /*@}*/ /**************************************************************************/ /** @name Buddy Icon Subsystem API */ /**************************************************************************/ /*@{*/ /** * Sets a buddy icon for a user. * * @param account The account the user is on. * @param username The username of the user. * @param icon_data The icon data. * @param icon_len The length of the icon data. * * @return The buddy icon set, or NULL if no icon was set. */ void purple_buddy_icons_set_for_user(PurpleAccount *account, const char *username, void *icon_data, size_t icon_len); /** * Returns the buddy icon information for a user. * * @param account The account the user is on. * @param username The username of the user. * * @return The icon data if found, or @c NULL if not found. */ PurpleBuddyIcon * purple_buddy_icons_find(PurpleAccount *account, const char *username); /** * Sets whether or not buddy icon caching is enabled. * * @param caching TRUE of buddy icon caching should be enabled, or * FALSE otherwise. */ void purple_buddy_icons_set_caching(gboolean caching); /** * Returns whether or not buddy icon caching should be enabled. * * The default is TRUE, unless otherwise specified by * purple_buddy_icons_set_caching(). * * @return TRUE if buddy icon caching is enabled, or FALSE otherwise. */ gboolean purple_buddy_icons_is_caching(void); /** * Sets the directory used to store buddy icon cache files. * * @param cache_dir The directory to store buddy icon cache files to. */ void purple_buddy_icons_set_cache_dir(const char *cache_dir); /** * Returns the directory used to store buddy icon cache files. * * The default directory is PURPLEDIR/icons, unless otherwise specified * by purple_buddy_icons_set_cache_dir(). * * @return The directory to store buddy icon cache files to. */ const char *purple_buddy_icons_get_cache_dir(void); /** * Returns the buddy icon subsystem handle. * * @return The subsystem handle. */ void *purple_buddy_icons_get_handle(void); /** * Initializes the buddy icon subsystem. */ void purple_buddy_icons_init(void); /** * Uninitializes the buddy icon subsystem. */ void purple_buddy_icons_uninit(void); /*@}*/ /**************************************************************************/ /** @name Buddy Icon Helper API */ /**************************************************************************/ /*@{*/ /** * Gets display size for a buddy icon */ void purple_buddy_icon_get_scale_size(PurpleBuddyIconSpec *spec, int *width, int *height); /*@}*/ #ifdef __cplusplus } #endif #endif /* _PURPLE_BUDDYICON_H_ */