Class CHlpList

class CHlpList : public CBase, public MHlpTitleArray;

Description

A list of help items (CHlpItem objects).

Derivation

• MDesC16Array - Interface class for 16 bit descriptor arrays

• MHlpTitleArray - Interface to get a topic ID from an array index
• CBase - Base class for all classes to be instantiated on the heap

• CHlpList - A list of help items ( CHlpItem objects)

Members

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

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CHlpList *NewL();

Description

Allocates and creates a new help list object.

Return value

CHlpList * New help list object

static IMPORT_C 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

IMPORT_C ~CHlpList();

Description

Destructor.

virtual IMPORT_C TInt MdcaCount() const;

Description

Gets the number of items in the list.

Return value

TInt Number of items in the list

virtual IMPORT_C 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

virtual IMPORT_C 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

IMPORT_C CHlpItem *Item(TInt aIndex) const;

Description

Gets the item at the specified index.

Parameters

TInt aIndex Item index

Return value

CHlpItem * Item

IMPORT_C 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

IMPORT_C void Reset();

Description

Resets the list.

IMPORT_C void AppendL(CHlpItem *aItem);

Description

Appends an item to the list.

Parameters

CHlpItem *aItem Item to add