CAknsImageTableItemData Class Reference

#include <mw/AknsItemData.h>

Link against: AknSkins.lib

class CAknsImageTableItemData : public CAknsImageItemData

Inherits from

CAknsImageTableItemData
- CAknsImageItemData
  - CAknsItemData

Protected Attributes
TAknsItemID *	iImageArray
TInt	iNumberOfImages

Public Member Functions
virtual	~CAknsImageTableItemData()
IMPORT_C TAknsItemID	ImageIID(const TInt)
IMPORT_C TAknsItemID *	Images()
IMPORT_C CAknsImageTableItemData *	NewL()
IMPORT_C TInt	NumberOfImages()
IMPORT_C void	SetImagesL(const TInt, const TAknsItemID *)

Protected Member Functions
	CAknsImageTableItemData(const TAknsItemType)

Inherited Attributes
	CAknsImageItemData::iAttributeData
	CAknsImageItemData::iDrawRect
	CAknsImageItemData::iParentIID
	CAknsItemData::iType

Inherited Functions
	CAknsImageItemData::Attributes()const
	CAknsImageItemData::CAknsImageItemData(const TAknsItemType)
	CAknsImageItemData::DrawRect()
	CAknsImageItemData::ParentIID()
	CAknsImageItemData::SetAttributesL(const TAknsImageAttributeData &)
	CAknsImageItemData::SetDrawRect(const TRect &)
	CAknsImageItemData::SetParentIID(const TAknsItemID &)
	CAknsImageItemData::~CAknsImageItemData()
	CAknsItemData::CAknsItemData(const TAknsItemType)
	CAknsItemData::SetType(const TAknsItemType)
	CAknsItemData::Type()const
	CAknsItemData::~CAknsItemData()
	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()

Detailed Description

Icon table item data. Icon table item data contains (in addition to base class members), an array containing item IDs of images. Item type for image table item data objects is always EAknsITImageTable.

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

Since: 2.0

Member Attribute Documentation

iImageArray

TAknsItemID *

iImageArray

[protected]

Image array.

iNumberOfImages

TInt

iNumberOfImages

[protected]

Number of images.

Constructor & Destructor Documentation

CAknsImageTableItemData ( const TAknsItemType )

CAknsImageTableItemData

(

const TAknsItemType

aType

)

[protected]

C++ protected constructor. Constructs a new CAknsImageTableItemData without an array.

Parameter	Description
aType	Item type of the new item data object. While this is always EAknsITImageTable for instances of this class, derived classes may specify another value.

~CAknsImageTableItemData ( )

~CAknsImageTableItemData

(

)

[virtual]

Destructor. Destroys image array.

Member Function Documentation

ImageIID ( const TInt )

IMPORT_C TAknsItemID

ImageIID

(

const TInt

aIndex

)

const

Returns the item ID of an image.

Since: 2.0

Parameter	Description
aIndex	Index of the image. This value must be within 0 (inclusive) and NumberOfImages (exclusive).

Returns: Item ID of the image.

Images ( )

IMPORT_C TAknsItemID *

Images

(

)

const

Returns pointer to the first entry in the image array, owned by this object.

Since: 2.0

Returns: Pointer to TAknsItemID.

NewL ( )

IMPORT_C CAknsImageTableItemData *

NewL

(

)

[static]

Two-phased constructor. Constructs a new CAknsImageTableItemData object. Values must be set separately using SetImagesL.

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

Returns: Newly constructed CAknsImageTableItemData object.

NumberOfImages ( )

IMPORT_C TInt

NumberOfImages

(

)

const

Returns the number of images.

Since: 2.0

Returns: Number of images as an integer.

SetImagesL ( const TInt, const TAknsItemID * )

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

Sets image table values for this item data instance.

Since: 2.0

Parameter	Description
aNumberOfImages	Number of images in aImages.
aImages	Pointer to first image ID. Values are copied into an internal array.