pidgin 2.14.14dev
|
Smiley API. More...
Go to the source code of this file.
Macros | |
#define | PURPLE_TYPE_SMILEY (purple_smiley_get_type ()) |
#define | PURPLE_SMILEY(smiley) (G_TYPE_CHECK_INSTANCE_CAST ((smiley), PURPLE_TYPE_SMILEY, PurpleSmiley)) |
#define | PURPLE_SMILEY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_TYPE_SMILEY, PurpleSmileyClass)) |
#define | PURPLE_IS_SMILEY(smiley) (G_TYPE_CHECK_INSTANCE_TYPE ((smiley), PURPLE_TYPE_SMILEY)) |
#define | PURPLE_IS_SMILEY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_TYPE_SMILEY)) |
#define | PURPLE_SMILEY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_TYPE_SMILEY, PurpleSmileyClass)) |
Typedefs | |
typedef struct _PurpleSmiley | PurpleSmiley |
A custom smiley. | |
typedef struct _PurpleSmileyClass | PurpleSmileyClass |
Functions | |
Custom Smiley API <br> | |
GType | purple_smiley_get_type (void) |
GObject-fu. | |
PurpleSmiley * | purple_smiley_new (PurpleStoredImage *img, const char *shortcut) |
Creates a new custom smiley from a PurpleStoredImage. | |
PurpleSmiley * | purple_smiley_new_from_file (const char *shortcut, const char *filepath) |
Creates a new custom smiley, reading the image data from a file. | |
void | purple_smiley_delete (PurpleSmiley *smiley) |
Destroys the custom smiley and releases the associated resources. | |
gboolean | purple_smiley_set_shortcut (PurpleSmiley *smiley, const char *shortcut) |
Changes the custom smiley's shortcut. | |
void | purple_smiley_set_data (PurpleSmiley *smiley, guchar *smiley_data, size_t smiley_data_len) |
Changes the custom smiley's image data. | |
const char * | purple_smiley_get_shortcut (const PurpleSmiley *smiley) |
Returns the custom smiley's associated shortcut (e.g. | |
const char * | purple_smiley_get_checksum (const PurpleSmiley *smiley) |
Returns the custom smiley data's checksum. | |
PurpleStoredImage * | purple_smiley_get_stored_image (const PurpleSmiley *smiley) |
Returns the PurpleStoredImage with the reference counter incremented. | |
gconstpointer | purple_smiley_get_data (const PurpleSmiley *smiley, size_t *len) |
Returns the custom smiley's data. | |
const char * | purple_smiley_get_extension (const PurpleSmiley *smiley) |
Returns an extension corresponding to the custom smiley's file type. | |
char * | purple_smiley_get_full_path (PurpleSmiley *smiley) |
Returns a full path to an custom smiley. | |
Custom Smiley Subsystem API <br> | |
GList * | purple_smileys_get_all (void) |
Returns a list of all custom smileys. | |
PurpleSmiley * | purple_smileys_find_by_shortcut (const char *shortcut) |
Returns a custom smiley given its shortcut. | |
PurpleSmiley * | purple_smileys_find_by_checksum (const char *checksum) |
Returns a custom smiley given its checksum. | |
const char * | purple_smileys_get_storing_dir (void) |
Returns the directory used to store custom smiley cached files. | |
void | purple_smileys_init (void) |
Initializes the custom smiley subsystem. | |
void | purple_smileys_uninit (void) |
Uninitializes the custom smiley subsystem. | |
#define PURPLE_IS_SMILEY | ( | smiley | ) | (G_TYPE_CHECK_INSTANCE_TYPE ((smiley), PURPLE_TYPE_SMILEY)) |
#define PURPLE_IS_SMILEY_CLASS | ( | klass | ) | (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_TYPE_SMILEY)) |
#define PURPLE_SMILEY | ( | smiley | ) | (G_TYPE_CHECK_INSTANCE_CAST ((smiley), PURPLE_TYPE_SMILEY, PurpleSmiley)) |
#define PURPLE_SMILEY_CLASS | ( | klass | ) | (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_TYPE_SMILEY, PurpleSmileyClass)) |
#define PURPLE_SMILEY_GET_CLASS | ( | obj | ) | (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_TYPE_SMILEY, PurpleSmileyClass)) |
#define PURPLE_TYPE_SMILEY (purple_smiley_get_type ()) |
typedef struct _PurpleSmiley PurpleSmiley |
void purple_smiley_delete | ( | PurpleSmiley * | smiley | ) |
Destroys the custom smiley and releases the associated resources.
smiley | The custom smiley. |
const char * purple_smiley_get_checksum | ( | const PurpleSmiley * | smiley | ) |
Returns the custom smiley data's checksum.
smiley | The custom smiley. |
gconstpointer purple_smiley_get_data | ( | const PurpleSmiley * | smiley, |
size_t * | len | ||
) |
Returns the custom smiley's data.
smiley | The custom smiley. |
len | If not NULL , the length of the image data returned will be set in the location pointed to by this. |
const char * purple_smiley_get_extension | ( | const PurpleSmiley * | smiley | ) |
Returns an extension corresponding to the custom smiley's file type.
smiley | The custom smiley. |
NULL
if the image data has disappeared. char * purple_smiley_get_full_path | ( | PurpleSmiley * | smiley | ) |
Returns a full path to an custom smiley.
If the custom smiley has data and the file exists in the cache, this will return a full path to the cached file.
In general, it is not appropriate to be poking in the file cache directly. If you find yourself wanting to use this function, think very long and hard about it, and then don't.
Think some more.
smiley | The custom smiley. |
NULL
under various conditions. The caller should use g_free to free the returned string. const char * purple_smiley_get_shortcut | ( | const PurpleSmiley * | smiley | ) |
Returns the custom smiley's associated shortcut (e.g.
"(homer)").
smiley | The custom smiley. |
PurpleStoredImage * purple_smiley_get_stored_image | ( | const PurpleSmiley * | smiley | ) |
Returns the PurpleStoredImage with the reference counter incremented.
The returned PurpleStoredImage reference counter must be decremented when the caller is done using it.
smiley | The custom smiley. |
PurpleSmiley * purple_smiley_new | ( | PurpleStoredImage * | img, |
const char * | shortcut | ||
) |
Creates a new custom smiley from a PurpleStoredImage.
If a custom smiley with the given shortcut already exists, it will be automaticaly returned.
img | The image associated with the smiley. |
shortcut | The associated shortcut (e.g. "(homer)"). |
PurpleSmiley * purple_smiley_new_from_file | ( | const char * | shortcut, |
const char * | filepath | ||
) |
Creates a new custom smiley, reading the image data from a file.
If a custom smiley with the given shortcut already exists, it will be automaticaly returned.
shortcut | The associated shortcut (e.g. "(homer)"). |
filepath | The image file. |
void purple_smiley_set_data | ( | PurpleSmiley * | smiley, |
guchar * | smiley_data, | ||
size_t | smiley_data_len | ||
) |
Changes the custom smiley's image data.
smiley | The custom smiley. |
smiley_data | The custom smiley data, which the smiley code takes ownership of and will free. |
smiley_data_len | The length of the data in smiley_data. |
gboolean purple_smiley_set_shortcut | ( | PurpleSmiley * | smiley, |
const char * | shortcut | ||
) |
Changes the custom smiley's shortcut.
smiley | The custom smiley. |
shortcut | The new shortcut. A custom smiley with this shortcut cannot already be in use. |
PurpleSmiley * purple_smileys_find_by_checksum | ( | const char * | checksum | ) |
Returns a custom smiley given its checksum.
checksum | The custom smiley's checksum. |
NULL
if not found. PurpleSmiley * purple_smileys_find_by_shortcut | ( | const char * | shortcut | ) |
Returns a custom smiley given its shortcut.
shortcut | The custom smiley's shortcut. |
NULL
if not found. GList * purple_smileys_get_all | ( | void | ) |
Returns a list of all custom smileys.
The caller is responsible for freeing the list.
const char * purple_smileys_get_storing_dir | ( | void | ) |
Returns the directory used to store custom smiley cached files.
The default directory is PURPLEDIR/custom_smiley.