CAknGridM Class Reference

#include <mw/AknGridM.h>

class CAknGridM : public CTextListBoxModel

Inherits from

CAknGridM
- CTextListBoxModel

Public Member Functions
	CAknGridM()
virtual	~CAknGridM()
virtual IMPORT_C TBool	IndexContainsData(TInt)
IMPORT_C TInt	IndexOfFirstDataItem()
IMPORT_C TInt	IndexOfLastDataItem()
virtual IMPORT_C TPtrC	ItemText(TInt)
virtual IMPORT_C TInt	NumberOfData()
virtual IMPORT_C TInt	NumberOfItems()
IMPORT_C void	SetStartCells(TInt)

Inherited Attributes
	CTextListBoxModel::iItemTextArray

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()
	CTextListBoxModel::CTextListBoxModel()
	CTextListBoxModel::ConstructL(MDesCArray *,TListBoxModelItemArrayOwnership)
	CTextListBoxModel::ItemArrayOwnershipType()const
	CTextListBoxModel::ItemTextArray()const
	CTextListBoxModel::MatchableTextArray()const
	CTextListBoxModel::SetItemTextArray(MDesCArray *)
	CTextListBoxModel::SetOwnershipType(TListBoxModelItemArrayOwnership)
	CTextListBoxModel::~CTextListBoxModel()

Detailed Description

Model class to CAknGrid. Usually this class object is instantiated automatically during the construction phase of CAknGrid object.If programmer wants to provide their own model they must instantiate grid model class object of their own and give it to the CAknGrid object using the SetModel function before calling the ConstructL/ConstructFromResourceL function of CAknGrid.

Since: Series60 0.9

Constructor & Destructor Documentation

CAknGridM ( )

IMPORT_C

CAknGridM

(

)

Default C++ constructor.

~CAknGridM ( )

IMPORT_C

~CAknGridM

(

)

[virtual]

Destructor.

Member Function Documentation

IndexContainsData ( TInt )

IMPORT_C TBool

IndexContainsData

(

TInt

aDataIndex

)

const [virtual]

Tests if the given cell index has data.

Parameter	Description
aDataIndex	Index to the item to be checked.

Returns: ETrue if the data index given is a data cell within the grid otherwise returns EFalse.

IndexOfFirstDataItem ( )

IMPORT_C TInt

IndexOfFirstDataItem

(

)

const

Gets the index of the first data item in the model.

Returns: Index of the first data item if data exists in model. Returns -1 if no data exists.

IndexOfLastDataItem ( )

IMPORT_C TInt

IndexOfLastDataItem

(

)

const

Gets the index of the last data item in the model.

Returns: Index of the last data item if data exists in model. Returns -1 if no data exists.

ItemText ( TInt )

IMPORT_C TPtrC

ItemText

(

TInt

aItemIndex

)

const [virtual]

Reimplemented from CTextListBoxModel::ItemText(TInt)const

Gets the text of given index. No check is made that the item index given is a valid grid index. A check should be made using IndexContainsData before the function is called. Empty cells at the start should be taken in account of the index given.

Parameter	Description
aItemIndex	Index of the grid.

Returns: a Pointer descriptor to the associated item text for a cell.

NumberOfData ( )

IMPORT_C TInt

NumberOfData

(

)

const [virtual]

Gives the number of data cells in the grid.

Returns: Number of the non empty cells in the grid.

NumberOfItems ( )

IMPORT_C TInt

NumberOfItems

(

)

const [virtual]

Reimplemented from CTextListBoxModel::NumberOfItems()const

Access to the number of items in the arrays.

Returns: Number of cells within the grid (including empty cells).

SetStartCells ( TInt )

IMPORT_C void

SetStartCells

(

TInt

aNumEmpty

)

This function sets the number of empty data cells at the start of the grid.

Parameter	Description
aNumEmpty	Number of empty cells.