CEikColumnListBox Class Reference

API published in: S60 1st Ed

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

Capability Information

Required Capabilities

None

#include <eikclb.h>

Inherits CEikTextListBox.

Inherited by CAknColumnListBox.

Detailed Description

Column list box control.

This is a list box whose lines consist of cells that are grouped vertically into columns. The columns can be either textual or graphical, and column widths and fonts can be set explicitly through CColumnListBoxData.

Starting from 3.0 listbox uses highlight animations. Starting and stopping animation is connected to focus events. To support highlight animations properly you have to make sure that the list has focus when it has 'visual focus'. Common issues:

In many cases list is in a container which sits on top of the control stack. The container receives all focus events and should hand them to the list too. E.g. void CContainer::FocusChanged( TDrawNow aDrawNow ) { ... some code ... if( iListBox ) iListBox->SetFocus( IsFocused(), aDrawNow ); }
When switching components programmatically, e.g. from one list to another in the same view, make sure that you remove focus from the other component.
In more complex cases you may have to add a dummy interceptor control to the top of control stack to hand focus events to list.
Make sure you handle resource changes correctly. If resource handle chain is solid it should reach CCoeControl::HandleResourceChange, which informs


Public Member Functions
IMPORT_C	CEikColumnListBox ()
	C++ default constructor.
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 void	EditItemL (TInt aColumn, TInt aMaxLength)
	Not supported in S60.
IMPORT_C CTextListBoxModel *	Model () const
	Gets the list box model.
IMPORT_C CColumnListBoxItemDrawer *	ItemDrawer () const
	Gets the object used by this list box to draw its items.
IMPORT_C void	EnableExtendedDrawingL ()
	This method needs to be called to enable extended drawing features such as skinning, pictograph drawing and marquee text in the listbox draw routine.
void	SetIconSizes ()
	Helper function that setst icon sizes for visible list items.
IMPORT_C void	EnableStretching (const TBool aEnabled)
	Enables/disables list stretching.
IMPORT_C CListBoxView *	MakeViewClassInstanceL ()
	From `CEikListBox`.
IMPORT_C void	FocusChanged (TDrawNow aDrawNow)
	From `CEikListBox`.
IMPORT_C void	GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const
	From `CCoeControl`.
IMPORT_C void	HandleResourceChange (TInt aType)
	From `CCoeControl`.
IMPORT_C TTypeUid::Ptr	MopSupplyObject (TTypeUid aUid)
	From `CCoeControl`.
IMPORT_C void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	From `CCoeControl`.
Protected Member Functions
virtual IMPORT_C void	CreateItemDrawerL ()
	This member is internal and not intended for use.
virtual IMPORT_C void	CreateModelL ()
	Creates a new `CTextListBoxModel`.

Constructor & Destructor Documentation

IMPORT_C CEikColumnListBox::CEikColumnListBox

(

)

C++ default constructor.

Member Function Documentation

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

Second-phase construction from a resource.

This function completes the construction of a column list box, initialising any members from the specified resource reader.

Parameters:

aReader

A resource file reader

Reimplemented from CEikTextListBox.

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

By default Symbian 2nd phase constructor is private.

This function completes the construction of a column list box.

Parameters:

	aParent	Parent control for the column list box.
	aFlags	Flags for the column list box.

Reimplemented from CEikTextListBox.

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

This member is internal and not intended for use.

Reimplemented from CEikTextListBox.

Reimplemented in CAknSingleGraphicHeadingStyleListBox.

virtual IMPORT_C void CEikColumnListBox::CreateModelL ( ) [protected, virtual]

Creates a new CTextListBoxModel.

Reimplemented in CAknColumnListBox.

IMPORT_C void CEikColumnListBox::EditItemL	(	TInt	aColumn,
		TInt	aMaxLength
	)

Not supported in S60.

IMPORT_C void CEikColumnListBox::EnableExtendedDrawingL

(

)

This method needs to be called to enable extended drawing features such as skinning, pictograph drawing and marquee text in the listbox draw routine.

Methods CEikFormattedCellListBox::ConstructL and CEikFormattedCellListBox::ConstructFromResourceL call this method. So, you only need to call this if your listbox implementation does not call either of those.

This method can be safely called more than once. Item drawer must be created before calling this method, or a panic is raised.

IMPORT_C void CEikColumnListBox::EnableStretching

(

const TBool

aEnabled

)

Enables/disables list stretching.

When a column list is stretched its layout is optimized to take advantage of the extra screen space. This is intented for devices with a large screen. This feature might be set as default by a product specific flag.

Item drawer must be created before calling this method.

Parameters:

aEnabled

ETrue to enable list stretching.

IMPORT_C void CEikColumnListBox::FocusChanged ( TDrawNow aDrawNow ) [virtual]

From CEikListBox.

Handles focus changes.

The function emphasises or de-emphasises the view as needed, and shows or hides the matcher cursor.

Parameters:

aDrawNow If EDrawNow, a redraw is performed immediately

Reimplemented from CEikListBox.

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

From CCoeControl.

Not used in S60

Parameters:

aColorUseList

The colour list

Reimplemented from CEikTextListBox.

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

From CCoeControl.

Handles pointer events.

This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer. The control should implement this function to handle pointer events.

Note: events of type EButton1Down are processed before HandlePointerEventL() is called, in order to transfer keyboard focus to the control in which the EButton1Down event occurred.

If overriding HandlePointerEventL(), the implementation must include a base call to CCoeControl's HandlePointerEventL().

Parameters:

aPointerEvent

The pointer event

Reimplemented from CEikTextListBox.

Reimplemented in CAknColumnListBox, CAknSingleStyleListBox, CAknSingleGraphicStyleListBox, CAknSingleGraphicHeadingStyleListBox, and CAknSingleLargeStyleListBox.

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

From CCoeControl.

Handles a change to the control's resources.

The types of resources handled are those which are shared across the environment, e.g. colours or fonts. For colour scheme changes, DrawDeferred() is called in order to redraw the control.

If overriding HandleResourceChange(), the implementation must include a base call to CCoeControl's HandleResourceChange().

Parameters:

aType

A message UID value

Reimplemented from CEikTextListBox.

IMPORT_C CColumnListBoxItemDrawer* CEikColumnListBox::ItemDrawer

(

)

const

Gets the object used by this list box to draw its items.

Returns:: A pointer to the list box drawer.

IMPORT_C CListBoxView* CEikColumnListBox::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 CEikListBox.

Reimplemented in CAknColumnListBox, and CAknSingleGraphicHeadingStyleListBox.

IMPORT_C CTextListBoxModel* CEikColumnListBox::Model

(

)

const

Gets the list box model.

Returns:: Pointer to the model used by this list box

Reimplemented from CEikTextListBox.

IMPORT_C TTypeUid::Ptr CEikColumnListBox::MopSupplyObject

(

TTypeUid

aUid

)

From CCoeControl.

Retrieves an object of the same type as that encapsulated in aId.

This function is used to allow controls to ask their owners for access to other objects that they own.

Other than in the case where NULL is returned, the object returned must be of the same object type - that is, the ETypeId member of the object pointed to by the pointer returned by this function must be equal to the iUid member of aUid.

Parameters:

aUid

An encapsulated object type ID.

Returns:: Pointer to the type UID of the wanted object.

void CEikColumnListBox::SetIconSizes

(

)

Helper function that setst icon sizes for visible list items.

The documentation for this class was generated from the following file:

eikclb.h

CEikColumnListBox Class Reference

Capability Information

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation