#include <glib.h>
Include dependency graph for imgstore.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Typedefs | |
typedef _PurpleStoredImage | PurpleStoredImage |
Functions | |
PurpleStoredImage * | purple_imgstore_add (gpointer data, size_t size, const char *filename) |
Add an image to the store. | |
int | purple_imgstore_add_with_id (gpointer data, size_t size, const char *filename) |
Add an image to the store, allocating an ID. | |
PurpleStoredImage * | purple_imgstore_find_by_id (int id) |
Retrieve an image from the store. | |
gconstpointer | purple_imgstore_get_data (PurpleStoredImage *img) |
Retrieves a pointer to the image's data. | |
const char * | purple_imgstore_get_extension (PurpleStoredImage *img) |
Returns an extension corresponding to the image's file type. | |
const char * | purple_imgstore_get_filename (const PurpleStoredImage *img) |
Retrieves a pointer to the image's filename. | |
void * | purple_imgstore_get_handle (void) |
Returns the image store subsystem handle. | |
size_t | purple_imgstore_get_size (PurpleStoredImage *img) |
Retrieves the length of the image's data. | |
void | purple_imgstore_init (void) |
Initializes the image store subsystem. | |
PurpleStoredImage * | purple_imgstore_ref (PurpleStoredImage *img) |
Increment the reference count. | |
void | purple_imgstore_ref_by_id (int id) |
Increment the reference count using an ID. | |
void | purple_imgstore_uninit (void) |
Uninitializes the image store subsystem. | |
PurpleStoredImage * | purple_imgstore_unref (PurpleStoredImage *img) |
Decrement the reference count. | |
void | purple_imgstore_unref_by_id (int id) |
Decrement the reference count using an ID. |
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
Definition in file imgstore.h.
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.
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. |
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.
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. |
PurpleStoredImage* purple_imgstore_find_by_id | ( | int | id | ) |
Retrieve an image from the store.
The caller does not own a reference to the image.
id | The ID for the image. |
gconstpointer purple_imgstore_get_data | ( | PurpleStoredImage * | img | ) |
Retrieves a pointer to the image's data.
img | The Image |
const char* purple_imgstore_get_extension | ( | PurpleStoredImage * | img | ) |
Returns an extension corresponding to the image's file type.
img | The image. |
const char* purple_imgstore_get_filename | ( | const PurpleStoredImage * | img | ) |
Retrieves a pointer to the image's filename.
img | The image |
void* purple_imgstore_get_handle | ( | void | ) |
Returns the image store subsystem handle.
size_t purple_imgstore_get_size | ( | PurpleStoredImage * | img | ) |
Retrieves the length of the image's data.
img | The Image |
PurpleStoredImage* purple_imgstore_ref | ( | PurpleStoredImage * | img | ) |
Increment the reference count.
img | The image. |
void purple_imgstore_ref_by_id | ( | int | id | ) |
Increment the reference count using an ID.
This is a convience wrapper for purple_imgstore_find_by_id() and purple_imgstore_ref(), so if you have a PurpleStoredImage, it'll be more efficient to call purple_imgstore_ref() directly.
id | The ID for the image. |
PurpleStoredImage* purple_imgstore_unref | ( | PurpleStoredImage * | img | ) |
Decrement the reference count.
If the reference count reaches zero, the image will be freed.
img | The image. |
NULL
if the reference count reached zero. void purple_imgstore_unref_by_id | ( | int | id | ) |
Decrement the reference count using an ID.
This is a convience wrapper for purple_imgstore_find_by_id() and purple_imgstore_unref(), so if you have a PurpleStoredImage, it'll be more efficient to call purple_imgstore_unref() directly.
id | The ID for the image. |