CColumnListBoxItemDrawer Class Reference

#include <mw/eikclb.h>

Link against: eikctl.lib

class CColumnListBoxItemDrawer : public CTextListItemDrawer

Inherits from

CColumnListBoxItemDrawer
- CTextListItemDrawer
  - CListItemDrawer

Nested Classes and Structures

CColumnListBoxItemDrawer::SListProperties

Protected Attributes
CArrayFix< SListProperties > *	iPropertyArray
TInt	iSpare

Public Member Functions
	CColumnListBoxItemDrawer()
	CColumnListBoxItemDrawer(MTextListBoxModel , const CFont , CColumnListBoxData *)
	~CColumnListBoxItemDrawer()
IMPORT_C void	ClearAllPropertiesL()
IMPORT_C CColumnListBoxData *	ColumnData()
virtual IMPORT_C void	DrawItemMark(TBool, TBool, const TPoint &)
virtual IMPORT_C void	DrawItemText(TInt, const TRect &, TBool, TBool, TBool)
virtual IMPORT_C TInt	ItemWidthInPixels(TInt)
TSize	LafItemSize()
virtual IMPORT_C TSize	MinimumCellSize()
virtual IMPORT_C TListItemProperties	Properties(TInt)
virtual IMPORT_C void	SetItemCellSize(const TSize &)
IMPORT_C void	SetPropertiesL(TInt, TListItemProperties)

Inherited Attributes
	CListItemDrawer::iBackColor
	CListItemDrawer::iData
	CListItemDrawer::iDimmedBackColor
	CListItemDrawer::iDimmedTextColor
	CListItemDrawer::iDrawMark
	CListItemDrawer::iGc
	CListItemDrawer::iHighlightedBackColor
	CListItemDrawer::iHighlightedTextColor
	CListItemDrawer::iItemCellSize
	CListItemDrawer::iMarkColor
	CListItemDrawer::iMarkColumnWidth
	CListItemDrawer::iMarkGutter
	CListItemDrawer::iTextColor
	CListItemDrawer::iViewRect
	CTextListItemDrawer::iFont
	CTextListItemDrawer::iModel

Inherited Enumerations
	CListItemDrawer:TFlags
	CListItemDrawer:TListItemAttribute

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CListItemDrawer::BackColor()const
	CListItemDrawer::CListItemDrawer()
	CListItemDrawer::ClearFlags(TInt)
	CListItemDrawer::ClearRect(const TRect &)const
	CListItemDrawer::DimmedBackColor()const
	CListItemDrawer::DimmedTextColor()const
	CListItemDrawer::DrawFrame(CWindowGc &,const TRect &,TInt)const
	CListItemDrawer::DrawItem(TInt,TPoint,TBool,TBool,TBool,TBool)const
	CListItemDrawer::Flags()const
	CListItemDrawer::Gc()const
	CListItemDrawer::HighlightedBackColor()const
	CListItemDrawer::HighlightedTextColor()const
	CListItemDrawer::ItemCellSize()const
	CListItemDrawer::MarkColor()const
	CListItemDrawer::MarkColumn()const
	CListItemDrawer::MarkGutter()const
	CListItemDrawer::SetBackColor(TRgb)
	CListItemDrawer::SetData(CListBoxData *)
	CListItemDrawer::SetDimmedBackColor(TRgb)
	CListItemDrawer::SetDimmedTextColor(TRgb)
	CListItemDrawer::SetDrawMark(TBool)
	CListItemDrawer::SetFlags(TInt)
	CListItemDrawer::SetHighlightedBackColor(TRgb)
	CListItemDrawer::SetHighlightedTextColor(TRgb)
	CListItemDrawer::SetMarkColumnWidth(TInt)
	CListItemDrawer::SetMarkGutter(TInt)
	CListItemDrawer::SetSkinEnabledL(TBool)
	CListItemDrawer::SetSymbolFont(const CFont *)
	CListItemDrawer::SetTextColor(TRgb)
	CListItemDrawer::SetVerticalInterItemGap(TInt)
	CListItemDrawer::SetViewRect(const TRect &)
	CListItemDrawer::SetupGc(TInt)const
	CListItemDrawer::SkinBackgroundControlContext()const
	CListItemDrawer::TextColor()const
	CListItemDrawer::VerticalInterItemGap()const
	CListItemDrawer::~CListItemDrawer()
	CTextListItemDrawer::CTextListItemDrawer()
	CTextListItemDrawer::CTextListItemDrawer(MTextListBoxModel ,const CFont )
	CTextListItemDrawer::ConstructL(const CFont *)
	CTextListItemDrawer::DoDrawItemText(const TDesC &,const TRect &,TBool,TBool,TBool,TInt)const
	CTextListItemDrawer::DrawActualItem(TInt,const TRect &,TBool,TBool,TBool,TBool)const
	CTextListItemDrawer::Font(TInt)const
	CTextListItemDrawer::ItemMarkPosition()const
	CTextListItemDrawer::ItemMarkReplacement()const
	CTextListItemDrawer::ItemMarkReverse()const
	CTextListItemDrawer::MatcherCursorAscent(TInt)const
	CTextListItemDrawer::MatcherCursorRect(const TDesC &,TInt,TInt,TInt)const
	CTextListItemDrawer::ResetGc()const
	CTextListItemDrawer::SetCellWidthInChars(TInt)
	CTextListItemDrawer::SetFont(const CFont *)
	CTextListItemDrawer::SetGc(CWindowGc *)
	CTextListItemDrawer::SetItemMarkPosition(TInt)
	CTextListItemDrawer::SetItemMarkReplacement(const TDesC &)
	CTextListItemDrawer::SetItemMarkReverse(TBool)
	CTextListItemDrawer::SetSearchStringL(const TDesC *)
	CTextListItemDrawer::~CTextListItemDrawer()

Detailed Description

Draws the contents of list box items.

Since: 5.0

Member Attribute Documentation

iPropertyArray

CArrayFix< SListProperties > *

iPropertyArray

[protected]

Array of properties.

iSpare

TInt

iSpare

[protected]

Not used.

Constructor & Destructor Documentation

CColumnListBoxItemDrawer ( )

IMPORT_C

CColumnListBoxItemDrawer

(

)

CColumnListBoxItemDrawer ( MTextListBoxModel , const CFont , CColumnListBoxData * )

IMPORT_C	CColumnListBoxItemDrawer	(	MTextListBoxModel *	aTextListBoxModel,
			const CFont *	aFont,
			CColumnListBoxData *	aColumnData
		)

C++ default constructor.

Initialises the list box item drawer with the specified model, font and data.

Parameter	Description
aTextListBoxModel	The model whose items will be drawn. This provides the item text that is drawn using DrawItemText().
aFont	The font in which the items will be drawn.
aColumnData	The column list box data. This comprises: the column widths, gaps, fonts, aligments and bitmaps.

~CColumnListBoxItemDrawer ( )

IMPORT_C

~CColumnListBoxItemDrawer

(

)

Destructor.

Member Function Documentation

ClearAllPropertiesL ( )

IMPORT_C void

ClearAllPropertiesL

(

)

Clears all properties from the CColumnListBoxItemDrawer.

ColumnData ( )

IMPORT_C CColumnListBoxData *

ColumnData

(

)

const

Gets a pointer to the column list box data as set during construction. Does not transfer ownership.

Returns a pointer to the column data. Does not imply transfer of ownership.

Since: ER5U

Returns: The column list box data.

DrawItemMark ( TBool, TBool, const TPoint & )

IMPORT_C void	DrawItemMark	(	TBool	aItemIsSelected,
			TBool	aViewIsDimmed,
			const TPoint &	aMarkPos
		)	const [virtual]

Reimplemented from CListItemDrawer::DrawItemMark(TBool,TBool,const TPoint &)const

Not used in S60.

DrawItemText ( TInt, const TRect &, TBool, TBool, TBool )

IMPORT_C void	DrawItemText	(	TInt	aItemIndex,
			const TRect &	aItemTextRect,
			TBool	aItemIsCurrent,
			TBool	aViewIsEmphasized,
			TBool	aItemIsSelected
		)	const [virtual]

Reimplemented from CTextListItemDrawer::DrawItemText(TInt,const TRect &,TBool,TBool,TBool)const

From CTextListItemDrawer.

Draw item text.

Parameter	Description
aItemIndex	Index of the item to draw.
aItemTextRect	Area to draw into.
aItemIsCurrent	ETrue if the item is current.
aViewIsEmphasized	ETrue if the view is emphasised.
aItemIsSelected	ETrue if the item is selected.

ItemWidthInPixels ( TInt )

IMPORT_C TInt

ItemWidthInPixels

(

TInt

aItemIndex

)

const [virtual]

Reimplemented from CTextListItemDrawer::ItemWidthInPixels(TInt)const

From CListItemDrawer.

Gets the width of the specified item.

Parameter	Description
aItemIndex	The index of the item whose width is to be returned.

Returns: The width of the item. This is 0 in CListItemDrawer

LafItemSize ( )

TSize

LafItemSize

(

)

[inline]

Get Item Cell Size.

Returns: Cell size of an item.

MinimumCellSize ( )

IMPORT_C TSize

MinimumCellSize

(

)

const [virtual]

Reimplemented from CTextListItemDrawer::MinimumCellSize()const

From CListItemDrawer.

Gets the minimum cell size.

Returns: The minimum size for a cell. This is TSize(0, 0) in CListItemDrawer.

Properties ( TInt )

IMPORT_C TListItemProperties

Properties

(

TInt

aItemIndex

)

const [virtual]

Reimplemented from CListItemDrawer::Properties(TInt)const

Get properties for an item.

Parameter	Description
aItemIndex	Item's index for identifying.

Returns: Wanted property set.

SetItemCellSize ( const TSize & )

IMPORT_C void

SetItemCellSize

(

const TSize &

aSizeInPixels

)

[virtual]

Reimplemented from CListItemDrawer::SetItemCellSize(const TSize &)

From CListItemDrawer.

Sets the item cell size.

The cell size is the on-screen size of the entire item, including its text and its item mark.

Parameter	Description
aSizeInPixels	New size for the item cell.

SetPropertiesL ( TInt, TListItemProperties )

IMPORT_C void	SetPropertiesL	(	TInt	aItemIndex,
			TListItemProperties	aProperty
		)

Set the property for an item with aItemIndex

Parameter	Description
aItemIndex	Item index
aProperty	The new property setting The SetProperties is convinience method for normal cases. NOTE that it does NOT work correctly if you can insert/delete items from the list -- You need to update all properties if any changes to the item text array happen! Often it is convinient to override the Properties() method. Further, use this only for small lists as it causes O(n) time if you need to set all properties.

Parameter

Description

aItemIndex

Item index

aProperty

The new property setting The SetProperties is convinience method for normal cases. NOTE that it does NOT work correctly if you can insert/delete items from the list -- You need to update all properties if any changes to the item text array happen! Often it is convinient to override the Properties() method. Further, use this only for small lists as it causes O(n) time if you need to set all properties.

CColumnListBoxItemDrawer Class Reference

Inherits from

Nested Classes and Structures

Detailed Description

Member Attribute Documentation

iPropertyArray

iSpare

Constructor & Destructor Documentation

CColumnListBoxItemDrawer ( )

CColumnListBoxItemDrawer ( MTextListBoxModel *, const CFont *, CColumnListBoxData * )

~CColumnListBoxItemDrawer ( )

Member Function Documentation

ClearAllPropertiesL ( )

ColumnData ( )

DrawItemMark ( TBool, TBool, const TPoint & )

DrawItemText ( TInt, const TRect &, TBool, TBool, TBool )

ItemWidthInPixels ( TInt )

LafItemSize ( )

MinimumCellSize ( )

Properties ( TInt )

SetItemCellSize ( const TSize & )

SetPropertiesL ( TInt, TListItemProperties )

CColumnListBoxItemDrawer ( MTextListBoxModel , const CFont , CColumnListBoxData * )