nsIDaimImageList Interface Reference

import "nsIDaimImageList.idl";

Inherits nsIDaimNotify.

Inherited by nsIDaimColorSpace.

List of all members.

Public Member Functions

void loadBuffer (in ACString url, in PRUint32 index)
void saveBuffer (in ACString url, in PRUint32 index)
PRBool isEmpty (in PRUint32 index)
void releaseBuffer (in PRUint32 index)
void resize (in PRUint32 size)
void createBuffer (in PRUint32 index, in PRInt32 format, in PRUint32 width, in PRUint32 height)
void releaseAll ()
void moveBuffer (in PRUint32 from, in PRUint32 to)
void swapBuffers (in PRUint32 first, in PRUint32 second)
void cloneBuffer (in PRUint32 src, in PRUint32 dst)
void setBufferFormat (in PRUint32 index, in PRInt32 format)
PRInt32 getBufferFormat (in PRUint32 index)
void spliceBuffers (in PRUint32 to, in PRUint32 from, in nsIDaimImageList source, in PRUint32 count)
void copyBuffers (in PRUint32 to, in PRUint32 from, in nsIDaimImageList source, in PRUint32 count)
void loadList (in ACString url, in PRUint32 from, in PRUint32 to, in PRBoolean stop_on_error)
void saveList (in ACString url, in PRUint32 from, in PRUint32 to)
void setCapacity (in PRUint32 capacity)

Public Attributes

readonly attribute PRUint32 size


Detailed Description

nsIDaimImageList

This interface expose methods for a container for storing/retrieving indexed images. Indexation enable the ordering of the images as a sequence.

Implemented by:


Member Function Documentation

void nsIDaimImageList::cloneBuffer in PRUint32  src,
in PRUint32  dst
 

cloneBuffer

Copy images at src to buffer dst.

void nsIDaimImageList::copyBuffers in PRUint32  to,
in PRUint32  from,
in nsIDaimImageList  source,
in PRUint32  count
 

copyBuffers

Copy count images from index from to destination starting at index to

void nsIDaimImageList::createBuffer in PRUint32  index,
in PRInt32  format,
in PRUint32  width,
in PRUint32  height
 

createBuffer

Create a new image in buffer index

PRInt32 nsIDaimImageList::getBufferFormat in PRUint32  index  ) 
 

getBufferFormat

Retrieve the format of the image stored at index

PRBool nsIDaimImageList::isEmpty in PRUint32  index  ) 
 

isEmpty

Check if buffer index contains a valid image.

void nsIDaimImageList::loadBuffer in ACString  url,
in PRUint32  index
 

loadBuffer

Load an image from url at buffer index index.

void nsIDaimImageList::loadList in ACString  url,
in PRUint32  from,
in PRUint32  to,
in PRBoolean  stop_on_error
 

loadList

Load a list of images

Parameters:
url the template url for the images to be loaded. this string will be formatted by subsituting the pattern "%$" to a 4 digits number corresponding to the index part of the name (Which does not necesserily corresponds to a buffer index).
from the first image index
to the last image index (included).
stop_on_error if set to true, then the method will stop at the first error encountered while storing.
Example :
    LoadList("path/image_%$.png",5,7);
Will store 'path/image_0005.png','path/image_0006.png' and 'path/image_0007.png in the list.
Note:
The list will be cleared automatically before attempting to store. One can look at the Size() method to control the number of images really stored successfully

void nsIDaimImageList::moveBuffer in PRUint32  from,
in PRUint32  to
 

moveBuffer

Move the buffer from location from to location to.

void nsIDaimImageList::releaseAll  ) 
 

releaseAll

Release all the images.

void nsIDaimImageList::releaseBuffer in PRUint32  index  ) 
 

releaseBuffer

Delete the image located at buffer index.

void nsIDaimImageList::resize in PRUint32  size  ) 
 

resize

Set the size of the internal array.

void nsIDaimImageList::saveBuffer in ACString  url,
in PRUint32  index
 

saveBuffer

Save the image at buffer index index to url.

void nsIDaimImageList::saveList in ACString  url,
in PRUint32  from,
in PRUint32  to
 

saveList

Save a list of images

Save the content of the image list using the template string url which should have the same format as described in LoadList().

void nsIDaimImageList::setBufferFormat in PRUint32  index,
in PRInt32  format
 

setBufferFormat

Change the format of the buffer index

If index is equal to -1, all images in the list are converted to the given format.

void nsIDaimImageList::setCapacity in PRUint32  capacity  ) 
 

capacity

void nsIDaimImageList::spliceBuffers in PRUint32  to,
in PRUint32  from,
in nsIDaimImageList  source,
in PRUint32  count
 

spliceBuffers

Move count images from index from to destination starting at index to

void nsIDaimImageList::swapBuffers in PRUint32  first,
in PRUint32  second
 

swapBuffers

Swap images between buffer first and buffer second.


Member Data Documentation

readonly attribute PRUint32 nsIDaimImageList::size
 

size


Generated on Tue May 23 17:31:48 2006 for Daim Library XPCOM Interfaces by  doxygen 1.4.6-NO