Mercurial > pidgin.yaz
diff libpurple/buddyicon.h @ 15374: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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/libpurple/buddyicon.h Sat Jan 20 02:32:10 2007 +0000 @@ -0,0 +1,312 @@ +/** + * @file buddyicon.h Buddy Icon API + * @ingroup core + * + * gaim + * + * Gaim 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 _GAIM_BUDDYICON_H_ +#define _GAIM_BUDDYICON_H_ + +typedef struct _GaimBuddyIcon GaimBuddyIcon; + +#include "account.h" +#include "blist.h" +#include "prpl.h" + +struct _GaimBuddyIcon +{ + GaimAccount *account; /**< The account the user is on. */ + char *username; /**< The username the icon belongs to. */ + + void *data; /**< The buddy icon data. */ + size_t len; /**< The length of the buddy icon data. */ + char *path; /**< The buddy icon's non-cached path. */ + + int ref_count; /**< The buddy icon reference count. */ +}; + +#ifdef __cplusplus +extern "C" { +#endif + +/**************************************************************************/ +/** @name Buddy Icon API */ +/**************************************************************************/ +/*@{*/ + +/** + * Creates a new buddy icon structure. + * + * @param account The account the user is on. + * @param username The username the icon belongs to. + * @param icon_data The buddy icon data. + * @param icon_len The buddy icon length. + * + * @return The buddy icon structure. + */ +GaimBuddyIcon *gaim_buddy_icon_new(GaimAccount *account, const char *username, + void *icon_data, size_t icon_len); + +/** + * Destroys a buddy icon structure. + * + * If the buddy icon's reference count is greater than 1, this will + * just decrease the reference count and return. + * + * @param icon The buddy icon structure to destroy. + */ +void gaim_buddy_icon_destroy(GaimBuddyIcon *icon); + +/** + * Increments the reference count on a buddy icon. + * + * @param icon The buddy icon. + * + * @return @a icon. + */ +GaimBuddyIcon *gaim_buddy_icon_ref(GaimBuddyIcon *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. + */ +GaimBuddyIcon *gaim_buddy_icon_unref(GaimBuddyIcon *icon); + +/** + * Updates every instance of this icon. + * + * @param icon The buddy icon. + */ +void gaim_buddy_icon_update(GaimBuddyIcon *icon); + +/** + * Caches a buddy icon associated with a specific buddy to disk. + * + * @param icon The buddy icon. + * @param buddy The buddy that this icon belongs to. + */ +void gaim_buddy_icon_cache(GaimBuddyIcon *icon, GaimBuddy *buddy); + +/** + * Removes cached buddy icon for a specific buddy. + * + * @param buddy The buddy for which to remove the cached icon. + */ +void gaim_buddy_icon_uncache(GaimBuddy *buddy); + +/** + * Sets the buddy icon's account. + * + * @param icon The buddy icon. + * @param account The account. + */ +void gaim_buddy_icon_set_account(GaimBuddyIcon *icon, GaimAccount *account); + +/** + * Sets the buddy icon's username. + * + * @param icon The buddy icon. + * @param username The username. + */ +void gaim_buddy_icon_set_username(GaimBuddyIcon *icon, const char *username); + +/** + * Sets the buddy icon's icon data. + * + * @param icon The buddy icon. + * @param data The buddy icon data. + * @param len The length of the icon data. + */ +void gaim_buddy_icon_set_data(GaimBuddyIcon *icon, void *data, size_t len); + +/** + * Sets the buddy icon's path. + * + * @param icon The buddy icon. + * @param path The buddy icon's non-cached path. + */ +void gaim_buddy_icon_set_path(GaimBuddyIcon *icon, const gchar *path); + +/** + * Returns the buddy icon's account. + * + * @param icon The buddy icon. + * + * @return The account. + */ +GaimAccount *gaim_buddy_icon_get_account(const GaimBuddyIcon *icon); + +/** + * Returns the buddy icon's username. + * + * @param icon The buddy icon. + * + * @return The username. + */ +const char *gaim_buddy_icon_get_username(const GaimBuddyIcon *icon); + +/** + * Returns the buddy icon's data. + * + * @param icon The buddy icon. + * @param len The returned icon length. + * + * @return The icon data. + */ +const guchar *gaim_buddy_icon_get_data(const GaimBuddyIcon *icon, size_t *len); + +/** + * Returns the buddy icon's path. + * + * @param icon The buddy icon. + * + * @preturn The buddy icon's non-cached path. + */ +const gchar *gaim_buddy_icon_get_path(GaimBuddyIcon *icon); + +/** + * Returns an extension corresponding to the buddy icon's file type. + * + * @param icon The buddy icon. + * + * @return The icon's extension. + */ +const char *gaim_buddy_icon_get_type(const GaimBuddyIcon *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 gaim_buddy_icons_set_for_user(GaimAccount *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. + */ +GaimBuddyIcon *gaim_buddy_icons_find(GaimAccount *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 gaim_buddy_icons_set_caching(gboolean caching); + +/** + * Returns whether or not buddy icon caching should be enabled. + * + * The default is TRUE, unless otherwise specified by + * gaim_buddy_icons_set_caching(). + * + * @return TRUE if buddy icon caching is enabled, or FALSE otherwise. + */ +gboolean gaim_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 gaim_buddy_icons_set_cache_dir(const char *cache_dir); + +/** + * Returns the directory used to store buddy icon cache files. + * + * The default directory is GAIMDIR/icons, unless otherwise specified + * by gaim_buddy_icons_set_cache_dir(). + * + * @return The directory to store buddy icon cache files to. + */ +const char *gaim_buddy_icons_get_cache_dir(void); + +/** + * Takes a buddy icon and returns a full path. + * + * If @a icon is a full path to an existing file, a copy of + * @a icon is returned. Otherwise, a newly allocated string + * consiting of gaim_buddy_icons_get_cache_dir() + @a icon is + * returned. + * + * @return The full path for an icon. + */ +char *gaim_buddy_icons_get_full_path(const char *icon); + +/** + * Returns the buddy icon subsystem handle. + * + * @return The subsystem handle. + */ +void *gaim_buddy_icons_get_handle(void); + +/** + * Initializes the buddy icon subsystem. + */ +void gaim_buddy_icons_init(void); + +/** + * Uninitializes the buddy icon subsystem. + */ +void gaim_buddy_icons_uninit(void); + +/*@}*/ + +/**************************************************************************/ +/** @name Buddy Icon Helper API */ +/**************************************************************************/ +/*@{*/ + +/** + * Gets display size for a buddy icon + */ +void gaim_buddy_icon_get_scale_size(GaimBuddyIconSpec *spec, int *width, int *height); + +/*@}*/ + +#ifdef __cplusplus +} +#endif + +#endif /* _GAIM_BUDDYICON_H_ */