IM Image Store API.
More...
#include <glib.h>
Go to the source code of this file.
Detailed Description
IM Image Store API.
- See also:
- Image Store Signals
Definition in file imgstore.h.
Function Documentation
PurpleStoredImage* purple_imgstore_add |
( |
gpointer |
data, |
|
|
size_t |
size, |
|
|
const char * |
filename |
|
) |
| |
Add an image to the store.
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.
No ID is allocated when using this function. If you need to reference the image by an ID, use purple_imgstore_add_with_id() instead.
- Parameters:
-
data | Pointer to the image data, which the imgstore will take ownership of and free as appropriate. If you want a copy of the data, make it before calling this function. |
size | Image data's size. |
filename | Filename associated with image. This is for your convenience. It could be the full path to the image or, more commonly, the filename of the image without any directory information. It can also be NULL, if you don't need to keep track of a filename. |
- Returns:
- The stored image.
int purple_imgstore_add_with_id |
( |
gpointer |
data, |
|
|
size_t |
size, |
|
|
const char * |
filename |
|
) |
| |
Add an image to the store, allocating an ID.
The caller owns a reference to the image in the store, and must dereference the image with purple_imgstore_unref_by_id() or purple_imgstore_unref() for it to be freed.
- Parameters:
-
data | Pointer to the image data, which the imgstore will take ownership of and free as appropriate. If you want a copy of the data, make it before calling this function. |
size | Image data's size. |
filename | Filename associated with image. This is for your convenience. It could be the full path to the image or, more commonly, the filename of the image without any directory information. It can also be NULL, if you don't need to keep track of a filename. |
- Returns:
- ID for the image. This is a unique number that can be used within libpurple to reference the image.
Retrieve an image from the store.
The caller does not own a reference to the image.
- Parameters:
-
- Returns:
- A pointer to the requested image, or NULL if it was not found.
Retrieves a pointer to the image's data.
- Parameters:
-
- Returns:
- A pointer to the data, which must not be freed or modified.
Looks at the magic numbers of the image data (the first few bytes) and returns an extension corresponding to the image's file type.
- Parameters:
-
- Returns:
- The image's extension (for example "png") or "icon" if unknown.
Retrieves a pointer to the image's filename.
- Parameters:
-
- Returns:
- A pointer to the filename, which must not be freed or modified.
void* purple_imgstore_get_handle |
( |
void |
| ) |
|
Returns the image store subsystem handle.
- Returns:
- The subsystem handle.
Retrieves the length of the image's data.
- Parameters:
-
- Returns:
- The size of the data that the pointer returned by purple_imgstore_get_data points to.
Create an image and add it to the store.
- Parameters:
-
path | The path to the image. |
- Returns:
- The stored image.
- Since:
- 2.X.X
Increment the reference count.
- Parameters:
-
- Returns:
- img
void purple_imgstore_ref_by_id |
( |
int |
id | ) |
|
Decrement the reference count.
If the reference count reaches zero, the image will be freed.
- Parameters:
-
- Returns:
- img or
NULL
if the reference count reached zero.
void purple_imgstore_unref_by_id |
( |
int |
id | ) |
|