m+I.list - Working with Image Lists>j Pair








NAME

&

list - Working with Image Lists






(

SYNOPSIS

`

Image * CloneImageList( const Image *images, ExceptionInfo *exception );

Z

unsigned int DeleteImageList( Image *images, const long offset );

?

void DestroyImageList( Image *image );

q

Image * GetImageList( const Image *images, const long offset, ExceptionInfo *exception );

G

long GetImageListIndex( const Image *images );

O

unsigned long GetImageListSize( const Image *images );

D

Image * GetNextImage( const Image *images );

d

Image ** ImageListToArray( const Image *images, ExceptionInfo *exception );

5

Image * NewImageList( void );

@

Image * PopImageList( Image ** images );

s

unsigned int PushImageList( Image *images, const Image *image, ExceptionInfo *exception );

b

Image * ReverseImageList( const Image *images, ExceptionInfo *exception );

unsigned int SetImageList( Image *images, const Image *image, const long offset, ExceptionInfo *exception );

B

Image * ShiftImageList( Image ** images );

Image * SpliceImageList( Image *images, const long offset, const unsigned long length, const Image *splices, ExceptionInfo *exception );

v

unsigned int UnshiftImageList( Image *images, const Image *image, ExceptionInfo *exception );






B

FUNCTION DESCRIPTIONS





4

CloneImageList

CloneImageList() returns a duplicate of the image list.

The format of the CloneImageList method is:

Image *CloneImageList ( const Image *images, ExceptionInfo *exception );

A description of each parameter follows:


C
o images:


The image list.


I
o exception:


0Return any errors or warnings in this structure.





6

DeleteImageList

DeleteImageList() deletes an image at the specified position in the list.

The format of the DeleteImageList method is:

unsigned int DeleteImageList ( Image *images, const long offset );

A description of each parameter follows:


$
o images:


The image list.


C
o offset:


The position within the list.





8

DestroyImageList

x
DestroyImageList() destroys an image list.

The format of the DestroyImageList method is:

void DestroyImageList ( Image *image );

A description of each parameter follows:


A
o image:


The image sequence.





0

GetImageList

GetImageList() returns an image at the specified position in the list.

The format of the GetImageList method is:


Image *GetImageList ( const Image *images, const long offset, ExceptionInfo *exception );

A description of each parameter follows:


$
o images:


The image list.


$
o offset:


The position within the list.


'
o exception:


0Return any errors or warnings in this structure.





:

GetImageListIndex

GetImageListIndex() returns the position in the list of the specified image.

The format of the GetImageListIndex method is:

long GetImageListIndex ( const Image *images );

A description of each parameter follows:


$
o images:


The image list.





8

GetImageListSize

GetImageListSize() returns the number of images in the list.

The format of the GetImageListSize method is:

unsigned long GetImageListSize ( const Image *images );

A description of each parameter follows:


$
o images:


The image list.





0

GetNextImage

z
GetNextImage() returns the next image in a list.

The format of the GetNextImage method is:

Image *GetNextImage ( const Image *images );

A description of each parameter follows:


$
o images:


The image list.





8

ImageListToArray

:
ImageListToArray() is a convenience method that converts an image list to a sequential array. For example,
group = ImageListToArray ( images, exception ); for ( i = 0; i < n; i++ ) puts ( group[i]->filename ) ;;

The format of the ImageListToArray method is:

Image **ImageListToArray ( const Image *images, ExceptionInfo *exception );

A description of each parameter follows:


#
o image:


The image list.


'
o exception:


0Return any errors or warnings in this structure.





0

NewImageList

u
NewImageList() creates an empty image list.

The format of the NewImageList method is:

Y
Image *NewImageList ( void );



0

PopImageList

|
PopImageList() removes the last image in the list.

The format of the PopImageList method is:

Image *PopImageList ( Image **images );

A description of each parameter follows:


$
o images:


The image list.





2

PushImageList

PushImageList() adds an image to the end of the list.

The format of the PushImageList method is:


unsigned int PushImageList ( Image *images, const Image *image, ExceptionInfo *exception );

A description of each parameter follows:


$
o images:


The image list.


#
o image:


The image.


'
o exception:


0Return any errors or warnings in this structure.





8

ReverseImageList

y
ReverseImageList() reverses the image list.

The format of the ReverseImageList method is:

Image *ReverseImageList ( const Image *images, ExceptionInfo *exception );

A description of each parameter follows:


$
o images:


The image list.


'
o exception:


0Return any errors or warnings in this structure.





0

SetImageList

SetImageList() inserts an image into the list at the specified position.

The format of the SetImageList method is:


unsigned int SetImageList ( Image *images, const Image *image, const long offset, ExceptionInfo *exception );

A description of each parameter follows:


$
o images:


The image list.


#
o image:


The image.


$
o offset:


The position within the list.


'
o exception:


0Return any errors or warnings in this structure.





4

ShiftImageList

ShiftImageList() removes an image from the beginning of the list.

The format of the ShiftImageList method is:

Image *ShiftImageList ( Image **images );

A description of each parameter follows:


$
o images:


The image list.





6

SpliceImageList

SpliceImageList() removes the images designated by offset and length from the list and replaces them with the specified list.

The format of the SpliceImageList method is:

U
Image *SpliceImageList ( Image *images, const long offset, const unsigned long length, const Image *splices, ExceptionInfo *exception );

A description of each parameter follows:


$
o images:


The image list.


$
o offset:


The position within the list.


C
o length:


'The length of the image list to remove.


C
o splice:


.Replace the removed image list with this list.


'
o exception:


0Return any errors or warnings in this structure.





8

UnshiftImageList

UnshiftImageList() adds the image to the beginning of the list.

The format of the UnshiftImageList method is:


unsigned int UnshiftImageList ( Image *images, const Image *image, ExceptionInfo *exception );

A description of each parameter follows:


$
o images:


The image list.


#
o image:


The image.


'
o exception:


0Return any errors or warnings in this structure.