Collapse all Symbian^3 Product Developer Library

CAknsImageTableItemDef Class Reference

class CAknsImageTableItemDef : public CAknsImageItemDef

Image table item definition. Image table item definition contains (in addition to base class data) an array containing image IDs. Item type for image table item definitions is always EAknsITImageTable.

This is a public class with exported functions. The class is not intended for derivation outside the library.

AknSkinSrv.lib

Since: 2.0

Inherits from

CAknsImageTableItemDef
- CAknsImageItemDef
  - CAknsItemDef
    - CBase

Public Member Functions
	~CAknsImageTableItemDef()
IMPORT_C const TAknsItemID *	Images()
IMPORT_C CAknsImageTableItemDef *	NewL(const TAknsItemID &, const TInt, const TAknsItemID *const )
IMPORT_C CAknsImageTableItemDef *	NewL(const TAknsItemID &)
IMPORT_C TInt	NumberOfImages()
IMPORT_C void	SetImages(const TInt, const TAknsItemID *const )
IMPORT_C void	SetImagesL(const TInt, const TAknsItemID *const )

Protected Member Functions
	CAknsImageTableItemDef(const TAknsItemType, const TAknsItemID &)

Inherited Functions
	CAknsImageItemDef::Attributes()const
	CAknsImageItemDef::CAknsImageItemDef(const TAknsItemType,const TAknsItemID &)
	CAknsImageItemDef::SetAttributesL(const TAknsImageAttributeData &)
	CAknsImageItemDef::~CAknsImageItemDef()
	CAknsItemDef::CAknsItemDef(const TAknsItemType,const TAknsItemID &)
	CAknsItemDef::ID()const
	CAknsItemDef::LinearOrder(const CAknsItemDef &,const CAknsItemDef &)
	CAknsItemDef::Type()const
	CAknsItemDef::~CAknsItemDef()
	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()

Protected Attributes
const TAknsItemID *	iImageArray
TAknsItemID *	iInternalImageArray
TInt	iNumberOfImages

Inherited Attributes
	CAknsImageItemDef::iAttributeData
	CAknsItemDef::iID
	CAknsItemDef::iSpare1
	CAknsItemDef::iSpare2
	CAknsItemDef::iType

Constructor & Destructor Documentation

CAknsImageTableItemDef(const TAknsItemType, const TAknsItemID &)

CAknsImageTableItemDef	(	const TAknsItemType	aType,
		const TAknsItemID &	aID
	)	[protected]

C++ constructor for internal use. Constructs image table item definition object with given ID. The image array must be set separately.

Parameters

const TAknsItemType aType	Type of the definition object. While this is always EAknsITImageTable for CAknsImageTableItemDef objects, derived classes may specify other values.
const TAknsItemID & aID	Item ID of the new item definition.

~CAknsImageTableItemDef()

~CAknsImageTableItemDef

(

)

[virtual]

Destructor. If the object owns an array, it is destroyed.

Member Functions Documentation

Images()

IMPORT_C const TAknsItemID *

Images

(

)

const

Returns pointer to the first element of the image array.

Since: 2.0

NewL(const TAknsItemID &, const TInt, const TAknsItemID *const)

IMPORT_C CAknsImageTableItemDef *	NewL	(	const TAknsItemID &	aID,
			const TInt	aNumberOfImages,
			const TAknsItemID *const	aImages
		)	[static]

Two-phased constructor, complete initialization. Constructs an image table item definition object.

Exceptions:: If allocation fails, function leaves with a system-wide error code.

Parameters

const TAknsItemID & aID	Item ID of the new object.
const TInt aNumberOfImages	Number of entries in aImages.
const TAknsItemID *const aImages	Pointer to the first item ID. An internal pointer is set to point to the same place as the given one. Ownership of the array stays with the caller and it must ensure that its lifetime is appropriate.

NewL(const TAknsItemID &)

IMPORT_C CAknsImageTableItemDef *

NewL

(

const TAknsItemID &

aID

)

[static]

Two-phased constructor, partial initialization. Constructs a new image table item definition object. Images must be set separately by using SetImagesL or SetImages.

Exceptions:: If allocation fails, function leaves with a system-wide error code.

Parameters

const TAknsItemID & aID

Item ID of the new object.

NumberOfImages()

IMPORT_C TInt

NumberOfImages

(

)

const

Returns the number of images.

Since: 2.0

SetImages(const TInt, const TAknsItemID *const)

IMPORT_C void	SetImages	(	const TInt	aNumberOfImages,
			const TAknsItemID *const	aImages
		)

Sets the images, ownership of the image item ID array stays with the caller. If this object already owns an array, it is destroyed.

Since: 2.0

Parameters

const TInt aNumberOfImages	Number of images in aImages.
const TAknsItemID *const aImages	Pointer to the first TAknsItemID. The caller still owns the array and must ensure that its lifetime is appropriate.

SetImagesL(const TInt, const TAknsItemID *const)

IMPORT_C void	SetImagesL	(	const TInt	aNumberOfImages,
			const TAknsItemID *const	aImages
		)

Sets the images, content of the array is copied to an internal array. If this object already owns an array, it is destroyed.

Since: 2.0

Exceptions:: If allocation fails, returns with an error code.

Parameters

const TInt aNumberOfImages	Number of images in aImages.
const TAknsItemID *const aImages	Pointer to the first image item ID.

Member Data Documentation

const TAknsItemID * iImageArray

const TAknsItemID *

iImageArray

[protected]

TAknsItemID * iInternalImageArray

TAknsItemID *

iInternalImageArray

[protected]

TInt iNumberOfImages

TInt

iNumberOfImages

[protected]