#include "account.h"
#include "blist.h"
#include "imgstore.h"
#include "prpl.h"
#include "util.h"
Include dependency graph for buddyicon.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Buddy Icon API | |
PurpleBuddyIcon * | purple_buddy_icon_new (PurpleAccount *account, const char *username, void *icon_data, size_t icon_len, const char *checksum) |
Creates a new buddy icon structure and populates it. | |
PurpleBuddyIcon * | purple_buddy_icon_ref (PurpleBuddyIcon *icon) |
Increments the reference count on a buddy icon. | |
PurpleBuddyIcon * | purple_buddy_icon_unref (PurpleBuddyIcon *icon) |
Decrements the reference count on a buddy icon. | |
void | purple_buddy_icon_update (PurpleBuddyIcon *icon) |
Updates every instance of this icon. | |
void | purple_buddy_icon_set_data (PurpleBuddyIcon *icon, guchar *data, size_t len, const char *checksum) |
Sets the buddy icon's data. | |
PurpleAccount * | purple_buddy_icon_get_account (const PurpleBuddyIcon *icon) |
Returns the buddy icon's account. | |
const char * | purple_buddy_icon_get_username (const PurpleBuddyIcon *icon) |
Returns the buddy icon's username. | |
const char * | purple_buddy_icon_get_checksum (const PurpleBuddyIcon *icon) |
Returns the buddy icon's checksum. | |
gconstpointer | purple_buddy_icon_get_data (const PurpleBuddyIcon *icon, size_t *len) |
Returns the buddy icon's data. | |
const char * | purple_buddy_icon_get_extension (const PurpleBuddyIcon *icon) |
Returns an extension corresponding to the buddy icon's file type. | |
char * | purple_buddy_icon_get_full_path (PurpleBuddyIcon *icon) |
Returns a full path to an icon. | |
Buddy Icon Subsystem API | |
void | purple_buddy_icons_set_for_user (PurpleAccount *account, const char *username, void *icon_data, size_t icon_len, const char *checksum) |
Sets a buddy icon for a user. | |
const char * | purple_buddy_icons_get_checksum_for_user (PurpleBuddy *buddy) |
Returns the checksum for the buddy icon of a specified buddy. | |
PurpleBuddyIcon * | purple_buddy_icons_find (PurpleAccount *account, const char *username) |
Returns the buddy icon information for a user. | |
PurpleStoredImage * | purple_buddy_icons_find_account_icon (PurpleAccount *account) |
Returns the buddy icon image for an account. | |
PurpleStoredImage * | purple_buddy_icons_set_account_icon (PurpleAccount *account, guchar *icon_data, size_t icon_len) |
Sets a buddy icon for an account. | |
time_t | purple_buddy_icons_get_account_icon_timestamp (PurpleAccount *account) |
Returns the timestamp of when the icon was set. | |
gboolean | purple_buddy_icons_node_has_custom_icon (PurpleBlistNode *node) |
Returns a boolean indicating if a given blist node has a custom buddy icon. | |
PurpleStoredImage * | purple_buddy_icons_node_find_custom_icon (PurpleBlistNode *node) |
Returns the custom buddy icon image for a blist node. | |
PurpleStoredImage * | purple_buddy_icons_node_set_custom_icon (PurpleBlistNode *node, guchar *icon_data, size_t icon_len) |
Sets a custom buddy icon for a blist node. | |
PurpleStoredImage * | purple_buddy_icons_node_set_custom_icon_from_file (PurpleBlistNode *node, const gchar *filename) |
Sets a custom buddy icon for a blist node. | |
gboolean | purple_buddy_icons_has_custom_icon (PurpleContact *contact) |
PurpleContact version of purple_buddy_icons_node_has_custom_icon. | |
PurpleStoredImage * | purple_buddy_icons_find_custom_icon (PurpleContact *contact) |
PurpleContact version of purple_buddy_icons_node_find_custom_icon. | |
PurpleStoredImage * | purple_buddy_icons_set_custom_icon (PurpleContact *contact, guchar *icon_data, size_t icon_len) |
PurpleContact version of purple_buddy_icons_node_set_custom_icon. | |
void | purple_buddy_icons_set_caching (gboolean caching) |
Sets whether or not buddy icon caching is enabled. | |
gboolean | purple_buddy_icons_is_caching (void) |
Returns whether or not buddy icon caching should be enabled. | |
void | purple_buddy_icons_set_cache_dir (const char *cache_dir) |
Sets the directory used to store buddy icon cache files. | |
const char * | purple_buddy_icons_get_cache_dir (void) |
Returns the directory used to store buddy icon cache files. | |
void * | purple_buddy_icons_get_handle (void) |
Returns the buddy icon subsystem handle. | |
void | purple_buddy_icons_init (void) |
Initializes the buddy icon subsystem. | |
void | purple_buddy_icons_uninit (void) |
Uninitializes the buddy icon subsystem. | |
Buddy Icon Helper API | |
void | purple_buddy_icon_get_scale_size (PurpleBuddyIconSpec *spec, int *width, int *height) |
Gets display size for a buddy icon. | |
Typedefs | |
typedef _PurpleBuddyIcon | PurpleBuddyIcon |
An opaque structure representing a buddy icon for a particular user on a particular PurpleAccount. |
Definition in file buddyicon.h.
|
An opaque structure representing a buddy icon for a particular user on a particular PurpleAccount. Instances are reference-counted; use purple_buddy_icon_ref() and purple_buddy_icon_unref() to take and release references. Definition at line 34 of file buddyicon.h. |
|
Returns the buddy icon's account.
|
|
Returns the buddy icon's checksum. This function is really only for prpl use.
|
|
Returns the buddy icon's data.
|
|
Returns an extension corresponding to the buddy icon's file type.
|
|
Returns a full path to an icon. If the icon has data and the file exists in the cache, this will return a full path to the cache file. In general, it is not appropriate to be poking in the icon cache directly. If you find yourself wanting to use this function, think very long and hard about it, and then don't.
|
|
Returns the buddy icon's username.
|
|
Creates a new buddy icon structure and populates it. If the buddy icon already exists, you'll get a reference to that structure, which will have been updated with the data supplied.
|
|
Increments the reference count on a buddy icon.
|
|
Sets the buddy icon's data.
|
|
Decrements the reference count on a buddy icon. If the reference count reaches 0, the icon will be destroyed.
|
|
Updates every instance of this icon.
|
|
Returns the buddy icon information for a user.
|
|
Returns the buddy icon image for an account. The caller owns a reference to the image in the store, and must dereference the image with purple_imgstore_unref() for it to be freed. This function deals with loading the icon from the cache, if needed, so it should be called in any case where you want the appropriate icon.
|
|
PurpleContact version of purple_buddy_icons_node_find_custom_icon. The caller owns a reference to the image in the store, and must dereference the image with purple_imgstore_unref() for it to be freed. This function deals with loading the icon from the cache, if needed, so it should be called in any case where you want the appropriate icon.
|
|
Returns the timestamp of when the icon was set. This is intended for use in protocols that require a timestamp for buddy icon update reasons.
|
|
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().
|
|
Returns the checksum for the buddy icon of a specified buddy. This avoids loading the icon image data from the cache if it's not already loaded for some other reason.
|
|
Returns the buddy icon subsystem handle.
|
|
PurpleContact version of purple_buddy_icons_node_has_custom_icon.
|
|
Returns whether or not buddy icon caching should be enabled. The default is TRUE, unless otherwise specified by purple_buddy_icons_set_caching().
|
|
Returns the custom buddy icon image for a blist node. The caller owns a reference to the image in the store, and must dereference the image with purple_imgstore_unref() for it to be freed. This function deals with loading the icon from the cache, if needed, so it should be called in any case where you want the appropriate icon.
|
|
Returns a boolean indicating if a given blist node has a custom buddy icon.
|
|
Sets a custom buddy icon for a blist node. This function will deal with saving a record of the icon, caching the data, etc.
|
|
Sets a custom buddy icon for a blist node. Convenience wrapper around purple_buddy_icons_node_set_custom_icon.
|
|
Sets a buddy icon for an account. This function will deal with saving a record of the icon, caching the data, etc.
|
|
Sets the directory used to store buddy icon cache files.
|
|
Sets whether or not buddy icon caching is enabled.
|
|
PurpleContact version of purple_buddy_icons_node_set_custom_icon. This function will deal with saving a record of the icon, caching the data, etc.
|
|
Sets a buddy icon for a user.
|