Class CFrameImageData

class CFrameImageData : public CBase;

Description

Class to manage lists of frame and image block data.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CFrameImageData - Class to manage lists of frame and image block data

Members

Defined in CFrameImageData:
AllocL(), AppendFrameData(), AppendImageBuffer(), AppendImageData(), FrameDataCount(), GetFrameData(), GetFrameData(), GetImageData(), GetImageData(), ImageDataCount(), InsertFrameData(), InsertImageData(), NewL(), NewL(), RemoveFrameData(), RemoveImageData(), Reserved_1(), Reserved_2(), Reserved_3(), Reserved_4(), ~CFrameImageData()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CFrameImageData *NewL();

Description

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

Return value

CFrameImageData * A pointer to a fully constructed CFrameImageData.

static IMPORT_C CFrameImageData *NewL(CImageDataArray &aImageData, TBool aImageDataOwner=EFalse);

Description

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

CImageDataArray &aImageData A reference to an externally created CImageDataArray. TBool aImageDataOwner If set to true, responsibility for deleting CImageDataArray is passed to the CFrameImageData object.

Return value

CFrameImageData * A pointer to a fully constructed CFrameImageData.

IMPORT_C ~CFrameImageData();

Description

Destructor for this class.

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

IMPORT_C CFrameImageData *AllocL() const;

Description

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

Return value

CFrameImageData * A pointer to the new copy of the frame data.

IMPORT_C TInt InsertImageData(const TImageDataBlock *aEntry, TInt aPos);

Description

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

Parameters

const TImageDataBlock *aEntry The image data block pointer to be inserted. TInt aPos The 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

TInt An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

See also:

• CFrameImageData::ImageDataCount()

IMPORT_C TInt AppendImageData(const TImageDataBlock *aEntry);

Description

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

Parameters

const TImageDataBlock *aEntry The image data block pointer to be inserted.

Return value

TInt An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

IMPORT_C void RemoveImageData(TInt aIndex);

Description

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

Parameters

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

See also:

• CFrameImageData::ImageDataCount()

IMPORT_C TInt InsertFrameData(const TFrameDataBlock *aEntry, TInt aPos);

Description

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

Parameters

const TFrameDataBlock *aEntry The frame data block pointer to be inserted. TInt aPos The 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

TInt An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

See also:

• CFrameImageData::FrameDataCount()

IMPORT_C TInt AppendFrameData(const TFrameDataBlock *aEntry);

Description

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

Parameters

const TFrameDataBlock *aEntry The frame data block pointer to be inserted.

Return value

TInt An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

IMPORT_C void RemoveFrameData(TInt aIndex);

Description

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

Parameters

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

See also:

• CFrameImageData::FrameDataCount()

IMPORT_C const TImageDataBlock *GetImageData(TInt aIndex) const;

Description

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

Parameters

TInt aIndex The position of the image data block to retrieve. Must be in the range 0 to ImageDataCount().

Return value

const TImageDataBlock * A pointer to the image data block.

IMPORT_C TImageDataBlock *GetImageData(TInt aIndex);

Description

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

Parameters

TInt aIndex The position of the image data block to retrieve. Must be in the range 0 to ImageDataCount().

Return value

TImageDataBlock * A pointer to the image data block.

IMPORT_C const TFrameDataBlock *GetFrameData(TInt aIndex) const;

Description

Const version.

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

Parameters

TInt aIndex The position of the frame data block to retrieve. Must be in the range 0 to FrameDataCount().

Return value

const TFrameDataBlock * A pointer to the image data block.

IMPORT_C TFrameDataBlock *GetFrameData(TInt aIndex);

Description

Non const version.

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

Parameters

TInt aIndex The position of the frame data block to retrieve. Must be in the range 0 to FrameDataCount().

Return value

TFrameDataBlock * A pointer to the image data block.

IMPORT_C TInt ImageDataCount() const;

Description

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

Return value

TInt The number of image data blocks.

IMPORT_C TInt FrameDataCount() const;

Description

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

Return value

TInt The number of image data blocks.

IMPORT_C TInt AppendImageBuffer(const HBufC8 *aImageBuffer);

Description

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

Parameters

const HBufC8 *aImageBuffer The HBufC8 pointer to take ownership of.

Return value

TInt An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

private: virtual IMPORT_C void Reserved_1();

Description

Intended for future proofing - will panic if called.

Panic codes

EReservedCall

private: virtual IMPORT_C void Reserved_2();

Description

Intended for future proofing - will panic if called.

Panic codes

EReservedCall

private: virtual IMPORT_C void Reserved_3();

Description

Intended for future proofing - will panic if called.

Panic codes

EReservedCall

private: virtual IMPORT_C void Reserved_4();

Description

Intended for future proofing - will panic if called.

Panic codes

EReservedCall