Collapse all Symbian^3 Product Developer Library

CFrameImageData Class Reference

class CFrameImageData : public CBase

Class to manage lists of frame and image block data.

Inherits from

CFrameImageData
- CBase

Public Member Functions
	~CFrameImageData()
IMPORT_C CFrameImageData *	AllocL()
IMPORT_C TInt	AppendFrameData(const TFrameDataBlock *)
IMPORT_C TInt	AppendImageBuffer(const HBufC8 *)
IMPORT_C TInt	AppendImageData(const TImageDataBlock *)
IMPORT_C TInt	FrameDataCount()
IMPORT_C const TFrameDataBlock *	GetFrameData(TInt)
IMPORT_C TFrameDataBlock *	GetFrameData(TInt)
IMPORT_C const TImageDataBlock *	GetImageData(TInt)
IMPORT_C TImageDataBlock *	GetImageData(TInt)
IMPORT_C TInt	ImageDataCount()
IMPORT_C TInt	InsertFrameData(const TFrameDataBlock *, TInt)
IMPORT_C TInt	InsertImageData(const TImageDataBlock *, TInt)
IMPORT_C CFrameImageData *	NewL()
IMPORT_C CFrameImageData *	NewL(CImageDataArray &, TBool)
IMPORT_C void	RemoveFrameData(TInt)
IMPORT_C void	RemoveImageData(TInt)

Private Member Functions
	CFrameImageData(CImageDataArray &, TBool)
IMPORT_C void	Reserved_1()
IMPORT_C void	Reserved_2()
IMPORT_C void	Reserved_3()
IMPORT_C void	Reserved_4()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
RPointerArray< TFrameDataBlock >	iFrameData
CImageDataArray &	iImageData
TBool	iImageDataOwner
TAny *	iReserved

Constructor & Destructor Documentation

CFrameImageData(CImageDataArray &, TBool)

CFrameImageData	(	CImageDataArray &	aImageData,
		TBool	aImageDataOwner = EFalse
	)	[private]

Parameters

CImageDataArray & aImageData
TBool aImageDataOwner = EFalse

~CFrameImageData()

IMPORT_C

~CFrameImageData

(

)

Destructor for this class.

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

Member Functions Documentation

AllocL()

IMPORT_C CFrameImageData *

AllocL

(

)

const

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

AppendFrameData(const TFrameDataBlock *)

IMPORT_C TInt

AppendFrameData

(

const TFrameDataBlock *

aEntry

)

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.

AppendImageBuffer(const HBufC8 *)

IMPORT_C TInt

AppendImageBuffer

(

const HBufC8 *

aImageBuffer

)

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.

AppendImageData(const TImageDataBlock *)

IMPORT_C TInt

AppendImageData

(

const TImageDataBlock *

aEntry

)

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.

FrameDataCount()

IMPORT_C TInt

FrameDataCount

(

)

const

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

GetFrameData(TInt)

IMPORT_C const TFrameDataBlock *

GetFrameData

(

TInt

aIndex

)

const

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().

GetFrameData(TInt)

IMPORT_C TFrameDataBlock *

GetFrameData

(

TInt

aIndex

)

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().

GetImageData(TInt)

IMPORT_C const TImageDataBlock *

GetImageData

(

TInt

aIndex

)

const

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().

GetImageData(TInt)

IMPORT_C TImageDataBlock *

GetImageData

(

TInt

aIndex

)

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().

ImageDataCount()

IMPORT_C TInt

ImageDataCount

(

)

const

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

InsertFrameData(const TFrameDataBlock *, TInt)

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

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

CFrameImageData::FrameDataCount()

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().

InsertImageData(const TImageDataBlock *, TInt)

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

CFrameImageData::ImageDataCount().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().

NewL()

IMPORT_C CFrameImageData *

NewL

(

)

[static]

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

NewL(CImageDataArray &, TBool)

IMPORT_C CFrameImageData *	NewL	(	CImageDataArray &	aImageData,
			TBool	aImageDataOwner = 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

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

RemoveFrameData(TInt)

IMPORT_C void

RemoveFrameData

(

TInt

aIndex

)

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

CFrameImageData::FrameDataCount().

Parameters

TInt aIndex

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

RemoveImageData(TInt)

IMPORT_C void

RemoveImageData

(

TInt

aIndex

)

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

CFrameImageData::ImageDataCount().

Parameters

TInt aIndex

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

Reserved_1()

IMPORT_C void

Reserved_1

(

)

[private, virtual]

Intended for future proofing - will panic if called.

panic: ImageConversion 30

Reserved_2()

IMPORT_C void

Reserved_2

(

)

[private, virtual]

Intended for future proofing - will panic if called.

panic: ImageConversion 30

Reserved_3()

IMPORT_C void

Reserved_3

(

)

[private, virtual]

Intended for future proofing - will panic if called.

panic: ImageConversion 30

Reserved_4()

IMPORT_C void

Reserved_4

(

)

[private, virtual]

Intended for future proofing - will panic if called.

panic: ImageConversion 30

Member Data Documentation

RPointerArray< TFrameDataBlock > iFrameData

RPointerArray< TFrameDataBlock >

iFrameData

[private]

CImageDataArray & iImageData

CImageDataArray &

iImageData

[private]

TBool iImageDataOwner

TBool

iImageDataOwner

[private]

TAny * iReserved

TAny *

iReserved

[private]