CEikTextListBox Class Reference

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

Capability Information

Required Capabilities

None

#include <EIKTXLBX.H>

Inherits CEikListBox.

Inherited by CEikColumnListBox, and CEikFormattedCellListBox.

Detailed Description

List box for displaying text.

Text list boxes use the standard list box view, CListBoxView, and a customised item drawer and list box model.

Since:
Symbian 5.0

Public Member Functions
IMPORT_C  ~CEikTextListBox ()
  Destructor.
IMPORT_C  CEikTextListBox ()
  C++ default constructor.
virtual IMPORT_C void  ConstructFromResourceL (TResourceReader &aReader)
  Second phase construction from a resource.
IMPORT_C void  ConstructL (const CCoeControl *aParent, TInt aFlags=0)
  By default Symbian 2nd phase constructor is private.
IMPORT_C CTextListBoxModel *  Model () const
  Gets the text list box model.
virtual IMPORT_C void  GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const
  From CCoeControl.
virtual IMPORT_C void  HandleResourceChange (TInt aType)
  From CCoeControl.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.

Protected Member Functions
IMPORT_C void  WriteInternalStateL (RWriteStream &aWriteStream) const
  From CCoeControl.
virtual IMPORT_C void  CreateItemDrawerL ()
  Creates CTextListItemDrawer for CListBoxView for drawing individual list box items .

Protected Attributes
TInt  iRequiredCellCharWidth

Constructor & Destructor Documentation

IMPORT_C CEikTextListBox::~CEikTextListBox (   ) 
 

Destructor.

IMPORT_C CEikTextListBox::CEikTextListBox (   ) 
 

C++ default constructor.

Member Function Documentation

virtual IMPORT_C void CEikTextListBox::ConstructFromResourceL (  TResourceReader &  aReader  )  [virtual]
 

Second phase construction from a resource.

This constructor initialises the list box model, flags, required dimensions etc. from a resource. The function fully constructs the associated list box model and item drawer for this list box.

Parameters:
aReader  A resource reader initialised to point at a list box resource

Reimplemented in CAknPopupSettingList, CEikColumnListBox, and CEikFormattedCellListBox.

IMPORT_C void CEikTextListBox::ConstructL (  const CCoeControl *  aParent,
TInt  aFlags = 0
)  [virtual]
 

By default Symbian 2nd phase constructor is private.

This initializes the C-classes of a newly-created CEikTextListBox from supplied arguments. This function fully constructs the associated list box model and item drawer for this list box, and then invokes CEikListBox::ConstructL().

Parameters:
aParent  Parent control for this control.
aFlags  Flags for the list box.

Reimplemented from CEikListBox.

Reimplemented in CEikColumnListBox, and CEikFormattedCellListBox.

virtual IMPORT_C void CEikTextListBox::CreateItemDrawerL (   )  [protected, virtual]
 

Creates CTextListItemDrawer for CListBoxView for drawing individual list box items .

Reimplemented in CAknSingleNumberHeadingStyleListBox, CAknDoubleStyle2ListBox, CAknDoubleLargeStyleListBox, CAknDouble2LargeStyleListBox, CAknSinglePopupMenuStyleListBox, CAknSingleGraphicPopupMenuStyleListBox, CAknSingleHeadingPopupMenuStyleListBox, CAknSingleGraphicHeadingPopupMenuStyleListBox, CAknDoublePopupMenuStyleListBox, CAknDoubleLargeGraphicPopupMenuStyleListBox, CAknDouble2PopupMenuStyleListBox, CAknSingle2GraphicPopupMenuStyleListBox, CAknDoubleGraphicPopupMenuStyleListBox, CAknSetStyleListBox, CAknFormGraphicStyleListBox, CEikColumnListBox, CEikFormattedCellListBox, and CEikSettingsListBox.

virtual IMPORT_C void CEikTextListBox::GetColorUseListL (  CArrayFix< TCoeColorUse > &  aColorUseList  )  const [virtual]
 

From CCoeControl.

Gets the list of logical colours employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.

Deprecated:
Parameters:
aColorUseList  List of logical colours.

Reimplemented from CEikListBox.

Reimplemented in CEikColumnListBox, and CEikFormattedCellListBox.

IMPORT_C void CEikTextListBox::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  )  [virtual]
 

From CCoeControl.

Handles pointer events.

Parameters:
aPointerEvent  The pointer event.

Reimplemented from CEikListBox.

Reimplemented in CAknColumnListBox, CAknSingleNumberStyleListBox, CAknSingleGraphicStyleListBox, CAknSingleNumberHeadingStyleListBox, CAknDoubleStyleListBox, CAknDoubleStyle2ListBox, CAknDoubleLargeStyleListBox, CAknDouble2LargeStyleListBox, CAknFormDoubleStyleListBox, CAknSettingNumberStyleListBox, CAknSinglePopupMenuStyleListBox, CAknSingleGraphicPopupMenuStyleListBox, CAknSingleGraphicBtPopupMenuStyleListBox, CAknSingleHeadingPopupMenuStyleListBox, CAknSingleGraphicHeadingPopupMenuStyleListBox, CAknDoublePopupMenuStyleListBox, CAknSinglePopupSubmenuStyleListBox, CAknDoubleLargeGraphicPopupMenuStyleListBox, CAknDouble2PopupMenuStyleListBox, CAknSingle2GraphicPopupMenuStyleListBox, CAknDoubleGraphicPopupMenuStyleListBox, CAknSetStyleListBox, CAknFormGraphicStyleListBox, CAknFormGraphicWideStyleListBox, CAknPopupSettingList, CEikColumnListBox, CEikFormattedCellListBox, and CEikSettingsListBox.

virtual IMPORT_C void CEikTextListBox::HandleResourceChange (  TInt  aType  )  [virtual]
 

From CCoeControl.

Handles a change to the control's resources. These resources are of type aType, which are shared across the environment, for example colours or fonts.

Parameters:
aType  The type of resource that has changed.

Reimplemented from CEikListBox.

Reimplemented in CAknPopupSettingList, CEikColumnListBox, and CEikFormattedCellListBox.

IMPORT_C CTextListBoxModel* CEikTextListBox::Model (   )  const
 

Gets the text list box model.

Returns:
The text list box model used by this list box.

Reimplemented from CEikListBox.

Reimplemented in CEikColumnListBox, and CEikFormattedCellListBox.

IMPORT_C void CEikTextListBox::WriteInternalStateL (  RWriteStream &  aWriteStream  )  const [protected]
 

From CCoeControl.

Write internal state of the CEikTextListBox to the given stream. NOTE: Only operational in debug mode.

Parameters:
aWriteStream  Target stream.

Reimplemented from CEikBorderedControl.

Field Documentation

TInt CEikTextListBox::iRequiredCellCharWidth [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top