CFrameImageData Class Reference

#include <icl/imagedata.h>

Link against: imageconversion.lib

class CFrameImageData : public CBase

Inherits from

Detailed Description

Class to manage lists of frame and image block data.

Constructor & Destructor Documentation

~CFrameImageData ( )

IMPORT_C~CFrameImageData()

Destructor for this class.

If ownership of the image data was transfered, it is now destroyed.

Member Function Documentation

AllocL ( )

IMPORT_C CFrameImageData *AllocL()const

Creates a full copy of the objects data. Ownership is transferred to the caller.

Return Value
A pointer to the new copy of the frame data.

AppendFrameData ( const TFrameDataBlock * )

IMPORT_C TIntAppendFrameData(const TFrameDataBlock *aEntry)

Adds a pointer to a frame data block to the end of the internally held list.

Parameters
aEntryThe frame data block pointer to be inserted.
Return Value
An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

AppendImageBuffer ( const HBufC8 * )

IMPORT_C TIntAppendImageBuffer(const HBufC8 *aImageBuffer)

Stores the supplied image data in a newly allocated entry in the image buffer array.

Parameters
aImageBufferThe HBufC8 pointer to take ownership of.
Return Value
An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

AppendImageData ( const TImageDataBlock * )

IMPORT_C TIntAppendImageData(const TImageDataBlock *aEntry)

Adds a pointer to an image data block to the end of the internally held list.

Parameters
aEntryThe image data block pointer to be inserted.
Return Value
An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

FrameDataCount ( )

IMPORT_C TIntFrameDataCount()const

Returns the number of frame data blocks in the internally held list.

Return Value
The number of image data blocks.

GetFrameData ( TInt )

IMPORT_C const TFrameDataBlock *GetFrameData(TIntaIndex)const

Const version.

Returns the frame data block at the given position from the internally held list.

Parameters
aIndexThe position of the frame data block to retrieve. Must be in the range 0 to FrameDataCount().
Return Value
A pointer to the image data block.

GetFrameData ( TInt )

IMPORT_C TFrameDataBlock *GetFrameData(TIntaIndex)

Non const version.

Returns the frame data block at the given position from the internally held list.

Parameters
aIndexThe position of the frame data block to retrieve. Must be in the range 0 to FrameDataCount().
Return Value
A pointer to the image data block.

GetImageData ( TInt )

IMPORT_C const TImageDataBlock *GetImageData(TIntaIndex)const

Returns the image data block at the given position from the internally held list.

Parameters
aIndexThe position of the image data block to retrieve. Must be in the range 0 to ImageDataCount().
Return Value
A pointer to the image data block.

GetImageData ( TInt )

IMPORT_C TImageDataBlock *GetImageData(TIntaIndex)

Returns the image data block at the given position from the internally held list.

Parameters
aIndexThe position of the image data block to retrieve. Must be in the range 0 to ImageDataCount().
Return Value
A pointer to the image data block.

ImageDataCount ( )

IMPORT_C TIntImageDataCount()const

Returns the number of image data blocks in the internally held list.

Return Value
The number of image data blocks.

InsertFrameData ( const TFrameDataBlock *, TInt )

IMPORT_C TIntInsertFrameData(const TFrameDataBlock *aEntry,
TIntaPos
)

Inserts a pointer to a frame data block into the internally held list in front of the item at position aPos.

See also: CFrameImageData::FrameDataCount()

Parameters
aEntryThe frame data block pointer to be inserted.
aPosThe position at which to insert the pointer into the internal list. Must not be less than 0 or greater than the value returned by CFrameImageData::FrameDataCount().
Return Value
An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

InsertImageData ( const TImageDataBlock *, TInt )

IMPORT_C TIntInsertImageData(const TImageDataBlock *aEntry,
TIntaPos
)

See also: CFrameImageData::ImageDataCount().

Inserts a pointer to an image data block into the internally held list in front of the item at position aPos.

Parameters
aEntryThe image data block pointer to be inserted.
aPosThe position at which to insert the pointer into the internal list. Must not be less than 0 or greater than the value returned by CFrameImageData::ImageDataCount().
Return Value
An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

NewL ( )

IMPORT_C CFrameImageData *NewL()[static]

Static factory function for creating instances of CFrameImageData. The managed list of image data is created/destroyed internally.

Return Value
A pointer to a fully constructed CFrameImageData.

NewL ( CImageDataArray &, TBool )

IMPORT_C CFrameImageData *NewL(CImageDataArray &aImageData,
TBoolaImageDataOwner = EFalse
)[static]

Static factory function for creating instances of CFrameImageData.

The managed list of image data is created internally. If a data owner is specified then the responsibility for destroying the managed list is that of the owner. If no owner is specified the managed list is destroyed internally.

Parameters
aImageDataA reference to an externally created CImageDataArray.
aImageDataOwnerIf set to true, responsibility for deleting CImageDataArray is passed to the CFrameImageData object.
Return Value
A pointer to a fully constructed CFrameImageData.

RemoveFrameData ( TInt )

IMPORT_C voidRemoveFrameData(TIntaIndex)

Removes a pointer to a frame data block at position aIndex from the internally held list.

See also: CFrameImageData::FrameDataCount().

Parameters
aIndexPosition of the pointer to delete. Must not be less than 0 or greater than the value returned by CFrameImageData::ImageDataCount().

RemoveImageData ( TInt )

IMPORT_C voidRemoveImageData(TIntaIndex)

Removes a pointer to an image data block at position aIndex from the internally held list.

See also: CFrameImageData::ImageDataCount().

Parameters
aIndexThe index into the list. Must not be less than 0 or greater than the value returned by CFrameImageData::ImageDataCount().