Class MListBoxModel

MListBoxModel

Support

Supported from 6.0

Description

List box data model interface.

This mixin protocol is implemented by all list box models. List box models provide information needed to display the required data in a list box.

Writing derived classes:

This class should be implemented by anything providing data for display in a CEikListBox-derived class. The very basic interface offered by MListBoxModel is usually expanded upon to provide more information for the specialised subclasses of CEikListBox. It is usual when deriving specialised list boxes to subclass the list box class, its view classes and its model together. See also:

Defined in MListBoxModel:
MatchableTextArray(), NumberOfItems(), ~MListBoxModel()

See also:

• CEikListBox
• CTextListBoxModel
• CEikTextListBox
• CTextListItemDrawer

Description

The interface of MListBoxModes provides the bare bones of what a list box requires — strings for by-character matching and for display, and a count of the items present.

virtual ~MListBoxModel();

Description

Virtual destructor with an empty implementation.

virtual TInt NumberOfItems() const = 0;

Description

Gets the number of items in the list box

Return value

TInt Number of items for the list box to display.

virtual const MDesCArray* MatchableTextArray() const = 0;

Description

Gets an array of strings used by the list box for matching user keypresses incrementally.

Return value

MDesCArray* An array of matchable strings.