CEikSettingsListBox Class Reference

API published in: S60 1st Ed

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

Capability Information

Required Capabilities

None

#include <eikslb.h>

Inherits CEikFormattedCellListBox.

Inherited by AknListBoxLinesTemplate< CEikSettingsListBox >.

Detailed Description

List box base class.

Creates listbox view and item drawer classes. This class is used throughout AknListBoxLinesTemplate< T > class. The CEikSettingsListBox uses CSettingsListBoxView as a list box view class and a CSettingsListBoxItemDrawer as an item drawer.


Public Member Functions
IMPORT_C  CEikSettingsListBox ()
  C++ default constructor.
IMPORT_C CSettingsListBoxItemDrawer *  ItemDrawer () const
  Gets an item drawer of CEikSettingListBox which handles drawing of single list box items and manages their properties.
IMPORT_C CListBoxView *  MakeViewClassInstanceL ()
  From CEikListBox.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.

Protected Member Functions
IMPORT_C void  CreateItemDrawerL ()
  Creates an item drawer for CEikSettingsListBox.
CSettingsListBoxView *  View ()
  Gets a list box view class as CSettingsListBoxView.

Constructor & Destructor Documentation

IMPORT_C CEikSettingsListBox::CEikSettingsListBox (   ) 
 

C++ default constructor.

Member Function Documentation

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

Creates an item drawer for CEikSettingsListBox.

Reimplemented from CEikFormattedCellListBox.

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

From CCoeControl.

Handles pointer events.

Parameters:
aPointerEvent  The pointer event.

Reimplemented from CEikFormattedCellListBox.

Reimplemented in CAknSettingStyleListBox.

IMPORT_C CSettingsListBoxItemDrawer* CEikSettingsListBox::ItemDrawer (   )  const
 

Gets an item drawer of CEikSettingListBox which handles drawing of single list box items and manages their properties.

Returns:
Pointer to the item drawer instance.

Reimplemented from CEikFormattedCellListBox.

IMPORT_C CListBoxView* CEikSettingsListBox::MakeViewClassInstanceL (   )  [virtual]
 

From CEikListBox.

Creates the list box view. The function is called by ConstructL() to create an instance of the appropriate list box view class for this list box. The returned instance is owned by this object, and does not have to have its second-phase constructor run. This function is called by CreateViewL().

Returns:
Pointer to a newly constructed list box view for this object.

Reimplemented from CEikFormattedCellListBox.

CSettingsListBoxView* CEikSettingsListBox::View (   )  [inline, protected]
 

Gets a list box view class as CSettingsListBoxView.

Returns:
Pointer to the list box view class object.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top