CTextListBoxModel Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eiktxlbm.h>

Inherits MTextListBoxModel.

Inherited by CAknFilteredTextListBoxModel, and CAknGridM.

Detailed Description

Text list box model.

Public Member Functions
IMPORT_C  CTextListBoxModel ()
  Default constructor.
virtual IMPORT_C  ~CTextListBoxModel ()
  destructor
virtual IMPORT_C TInt  NumberOfItems () const
  Gets the number of text items in this list box model.
virtual IMPORT_C const MDesCArray *  MatchableTextArray () const
  Gets an array of strings for incremental matching of typed characters.
virtual IMPORT_C TPtrC  ItemText (TInt aItemIndex) const
  Gets the text to be displayed in the list box control for the specified item.
virtual IMPORT_C void  ConstructL (MDesCArray *aItemTextArray=NULL, TListBoxModelItemArrayOwnership aOwnershipType=ELbmOwnsItemArray)
  Second-phase constructor.
IMPORT_C void  SetItemTextArray (MDesCArray *aItemTextArray)
  Sets a new text item array.
IMPORT_C void  SetOwnershipType (TListBoxModelItemArrayOwnership aOwnershipType)
  Sets the item array ownership type.
IMPORT_C MDesCArray *  ItemTextArray () const
  The array of text items modelled by this text list box model.

Protected Member Functions
IMPORT_C TListBoxModelItemArrayOwnership  ItemArrayOwnershipType () const
  Gets the item array ownership type.

Protected Attributes
MDesCArray *  iItemTextArray
  The array of text items modelled by this text list box model.

Constructor & Destructor Documentation

IMPORT_C CTextListBoxModel::CTextListBoxModel (   ) 
 

Default constructor.

virtual IMPORT_C CTextListBoxModel::~CTextListBoxModel (   )  [virtual]
 

destructor

Member Function Documentation

virtual IMPORT_C void CTextListBoxModel::ConstructL (  MDesCArray *  aItemTextArray = NULL,
TListBoxModelItemArrayOwnership  aOwnershipType = ELbmOwnsItemArray
)  [virtual]
 

Second-phase constructor.

This function completes construction of a default-constructed CTextListBoxModel, initialising any members which are stored on the heap. Whether ownership of the array is taken depends on the value of the TListBoxModelItemArrayOwnership enum.

Parameters:
aItemTextArray  The item array.
aOwnershipType  Whether or not to take ownership of the array.
IMPORT_C TListBoxModelItemArrayOwnership CTextListBoxModel::ItemArrayOwnershipType (   )  const [protected]
 

Gets the item array ownership type.

Returns:
Item array ownership.
virtual IMPORT_C TPtrC CTextListBoxModel::ItemText (  TInt  aItemIndex  )  const [virtual]
 

Gets the text to be displayed in the list box control for the specified item.

Parameters:
aItemIndex  Index of an item.
Returns:
Text string to be displayed.

Implements MTextListBoxModel.

Reimplemented in CAknGridM, and CAknFilteredTextListBoxModel.

IMPORT_C MDesCArray* CTextListBoxModel::ItemTextArray (   )  const
 

The array of text items modelled by this text list box model.

Returns:
A pointer to the array.
virtual IMPORT_C const MDesCArray* CTextListBoxModel::MatchableTextArray (   )  const [virtual]
 

Gets an array of strings for incremental matching of typed characters.

For the text list box model, these strings are those that are displayed (see ItemText()).

Returns:
A text array for matching.

Implements MListBoxModel.

Reimplemented in CAknFilteredTextListBoxModel.

virtual IMPORT_C TInt CTextListBoxModel::NumberOfItems (   )  const [virtual]
 

Gets the number of text items in this list box model.

Returns:
The number of text items.

Implements MListBoxModel.

Reimplemented in CAknGridM, and CAknFilteredTextListBoxModel.

IMPORT_C void CTextListBoxModel::SetItemTextArray (  MDesCArray *  aItemTextArray  ) 
 

Sets a new text item array.

Panics if aItemTextArray is NULL.

Parameters:
aItemTextArray  New item text array.
IMPORT_C void CTextListBoxModel::SetOwnershipType (  TListBoxModelItemArrayOwnership  aOwnershipType  ) 
 

Sets the item array ownership type.

Parameters:
aOwnershipType  Item array ownership.

Field Documentation

MDesCArray* CTextListBoxModel::iItemTextArray [protected]
 

The array of text items modelled by this text list box model.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top