CEikSnakingTextListBox Class Reference

API published in: S60 1st Ed

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

Capability Information

Required Capabilities

None

#include <eiktxlbx.h>

Inherits CEikSnakingListBox.

Detailed Description

Horizontal snaking text list box.

This snaking list box is intended for displaying text. The list box lays its items out using the CEikSnakingListBox algorithms, and uses a CTextListItemDrawer to draw its items.


Public Member Functions
IMPORT_C  ~CEikSnakingTextListBox ()
  Destructor.
IMPORT_C  CEikSnakingTextListBox ()
  C++ default constructor.
IMPORT_C void  ConstructL (const CCoeControl *aParent, TInt aFlags=0)
  By default Symbian 2nd phase constructor is private.
IMPORT_C CTextListBoxModel *  Model () const
  Gets a pointer to the model used by this list box.
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.

Constructor & Destructor Documentation

IMPORT_C CEikSnakingTextListBox::~CEikSnakingTextListBox (   ) 
 

Destructor.

IMPORT_C CEikSnakingTextListBox::CEikSnakingTextListBox (   ) 
 

C++ default constructor.

Member Function Documentation

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

By default Symbian 2nd phase constructor is private.

Completes the construction of a default-constructed snaking text list box, initialising its heap-stored members from the supplied arguments. This function will leave if any of the pointer members being constructed leave.

Parameters:
aParent  Parent control.
aFlags  Flags for the control.
See also:
CEikListBox::TFlags

Reimplemented from CEikListBox.

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

From CCoeControl.

Not implemented or used in S60.

Parameters:
aColorUseList  On return, a list of logical colours.

Reimplemented from CEikSnakingListBox.

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

From CCoeControl.

Handles pointer events.

Parameters:
aPointerEvent  The pointer event.

Reimplemented from CEikSnakingListBox.

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

From CCoeControl.

Handles a change in a resource.

The types (aType) of list box resources handled are those which are shared across the environment, for example, colours or fonts.

Parameters:
aType  The type of resource that has changed.

Reimplemented from CEikSnakingListBox.

IMPORT_C CTextListBoxModel* CEikSnakingTextListBox::Model (   )  const
 

Gets a pointer to the model used by this list box.

Returns:
This list box model.

Reimplemented from CEikListBox.

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