imgstore.h File Reference

IM Image Store API

gaim. More...

Go to the source code of this file.

Typedefs

typedef _GaimStoredImage GaimStoredImage

Functions

int gaim_imgstore_add (const void *data, size_t size, const char *filename)
 Add an image to the store.
GaimStoredImage * gaim_imgstore_get (int id)
 Retrieve an image from the store.
gpointer gaim_imgstore_get_data (GaimStoredImage *i)
 Retrieves a pointer to the image's data.
size_t gaim_imgstore_get_size (GaimStoredImage *i)
 Retrieves the length of the image's data.
const char * gaim_imgstore_get_filename (GaimStoredImage *i)
 Retrieves a pointer to the image's filename.
void gaim_imgstore_ref (int id)
 Increment the reference count for an image in the store.
void gaim_imgstore_unref (int id)
 Decrement the reference count for an image in the store.


Detailed Description

IM Image Store API

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


Function Documentation

int gaim_imgstore_add ( const void *  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 gaim_imgstore_unref for it to be freed.

Parameters:
data Pointer to the image data.
size Image data's size.
filename Filename associated with image.
Returns:
ID for the image.

GaimStoredImage* gaim_imgstore_get ( int  id  ) 

Retrieve an image from the store.

The caller does not own a reference to the image.

Parameters:
id The ID for the image.
Returns:
A pointer to the requested image, or NULL if it was not found.

gpointer gaim_imgstore_get_data ( GaimStoredImage *  i  ) 

Retrieves a pointer to the image's data.

Parameters:
i The Image
Returns:
A pointer to the data, which must not be freed or modified.

const char* gaim_imgstore_get_filename ( GaimStoredImage *  i  ) 

Retrieves a pointer to the image's filename.

Parameters:
i The Image
Returns:
A pointer to the filename, which must not be freed or modified.

size_t gaim_imgstore_get_size ( GaimStoredImage *  i  ) 

Retrieves the length of the image's data.

Parameters:
i The Image
Returns:
The size of the data that the pointer returned by gaim_imgstore_get_data points to.

void gaim_imgstore_ref ( int  id  ) 

Increment the reference count for an image in the store.

The image will be removed from the store when the reference count is zero.

Parameters:
id The ID for the image.

void gaim_imgstore_unref ( int  id  ) 

Decrement the reference count for an image in the store.

The image will be removed from the store when the reference count is zero.

Parameters:
id The ID for the image.


Generated on Wed Aug 9 23:40:41 2006 for gaim by  doxygen 1.4.7