• NAME
• SYNOPSIS
• FUNCTION DESCRIPTIONS
  • CloneImageList
  • DeleteImageList
  • DestroyImageList
  • GetImageList
  • GetImageListIndex
  • GetImageListSize
  • GetNextImage
  • ImageListToArray
  • NewImageList
  • PopImageList
  • PushImageList
  • ReverseImageList
  • SetImageList
  • ShiftImageList
  • SpliceImageList
  • UnshiftImageList

NAME

list - Working with Image Lists

SYNOPSIS

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

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

void DestroyImageList( Image *image );

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

size_t GetImageListIndex( const Image *images );

size_t GetImageListSize( const Image *images );

Image * GetNextImage( Image *images );

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

Image * NewImageList( void );

Image * PopImageList( Image ** images );

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

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

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

Image * ShiftImageList( Image ** images );

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

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

FUNCTION DESCRIPTIONS

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:

images:

The image list.

exception:

Return any errors or warnings in this structure.

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 unsigned long offset );

A description of each parameter follows:

images:

The image list.

offset:

The position within the list.

DestroyImageList

DestroyImageList() destroys an image list.

The format of the DestroyImageList method is:

void DestroyImageList ( Image *image );

A description of each parameter follows:

image:

The image sequence.

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 unsigned long offset, ExceptionInfo *exception );

A description of each parameter follows:

images:

The image list.

offset:

The position within the list.

exception:

Return 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:

size_t GetImageListIndex ( const Image *images );

A description of each parameter follows:

images:

The image list.

GetImageListSize

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

The format of the GetImageListSize method is:

size_t GetImageListSize ( const Image *images );

A description of each parameter follows:

images:

The image list.

GetNextImage

GetNextImage() returns the next image in a list.

The format of the GetNextImage method is:

Image *GetNextImage ( Image *images );

A description of each parameter follows:

images:

The image list.

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:

image:

The image list.

exception:

Return any errors or warnings in this structure.

NewImageList

NewImageList() creates an empty image list.

The format of the NewImageList method is:

Image *NewImageList ( void );

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:

images:

The image list.

PushImageList

PushImageList() add 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:

images:

The image list.

image:

The image.

exception:

Return any errors or warnings in this structure.

ReverseImageList

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:

images:

The image list.

exception:

Return any errors or warnings in this structure.

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 unsigned long offset, ExceptionInfo *exception );

A description of each parameter follows:

images:

The image list.

image:

The image.

offset:

The position within the list.

exception:

Return any errors or warnings in this structure.

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:

images:

The image list.

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:

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

A description of each parameter follows:

images:

The image list.

offset:

The position within the list.

offset:

The length of the image list to remove.

splice:

Replace the removed image list with this list.

exception:

Return any errors or warnings in this structure.

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:

images:

The image list.

image:

The image.

exception:

Return any errors or warnings in this structure.