Symbian
 Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]



Location: HLPMODEL.h
Link against: HLPMODEL.LIB

Class CHlpList

class CHlpList : public CBase, public MHlpTitleArray

Support

Supported from 6.0

Description

A list of help items (CHlpItem objects).

Derivation

CBaseBase class for all classes to be instantiated on the heap
CHlpListA list of help items (CHlpItem objects)
MDesCArray 
MHlpTitleArrayInterface to get a topic ID from an array index

Defined in CHlpList:
AppendL(), At(), ConstructL(), Find(), Item(), MdcaCount(), MdcaPoint(), NewL(), NewLC(), Reset(), iList, ~CHlpList()

Inherited from CBase:
operator new()


Construction and destruction


NewL()

static CHlpList* NewL();

Description

Allocates and creates a new help list object.

Return value

CHlpList*

New help list object


NewLC()

static CHlpList* NewLC();

Description

Allocates and creates a new help list object, leaving the object on the cleanup stack.

Return value

CHlpList*

New help list object


~CHlpList()

~CHlpList();

Description

Destructor.

[Top]


Member functions


MdcaCount()

TInt MdcaCount() const;

Description

Gets the number of items in the list.

Return value

TInt

Number of items in the list


MdcaPoint()

TPtrC MdcaPoint(TInt aIndex) const;

Description

Gets the title of the item at the specified index.

Parameters

TInt aIndex

Item index

Return value

TPtrC

Title of the item


At()

TUint32 At(TInt aIndex) const;

Description

Gets the topic ID of the item at the specified index.

Parameters

TInt aIndex

Item index

Return value

TUint32

Topic ID


Item()

CHlpItem* Item(TInt aIndex) const;

Description

Gets the item at the specified index.

Parameters

TInt aIndex

Item index

Return value

CHlpItem*

Item


Find()

TInt Find(TUint32 aId);

Description

Searches the list for a specified item ID.

Parameters

TUint32 aId

Item ID

Return value

TInt

Item index, or KErrNotFound if not found


Reset()

void Reset();

Description

Resets the list.


AppendL()

void AppendL(CHlpItem* aItem);

Description

Appends an item to the list.

Parameters

CHlpItem* aItem

Item to add

[Top]


Internal members


ConstructL()

private: void ConstructL();

Description

This member is internal and not intended for use.


iList

private: CArrayPtr<CHlpItem>* iList;

Description

This member is internal and not intended for use.