Collapse all Symbian^3 Product Developer Library

CColumnListBoxItemDrawer Class Reference

class CColumnListBoxItemDrawer : public CTextListItemDrawer

Draws the contents of list box items.

Since: 5.0

Inherits from

CColumnListBoxItemDrawer
- CTextListItemDrawer
  - CListItemDrawer
    - CBase

Nested Classes and Structures

CColumnListBoxItemDrawer::SListProperties

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

Private Member Functions
IMPORT_C void	CColumnListBoxItemDrawer_Reserved()
IMPORT_C TAny *	Reserved_1()

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()

Inherited Enumerations
	CListItemDrawer:TFlags
	CListItemDrawer:TListItemAttribute

Protected Attributes
CArrayFix< SListProperties > *	iPropertyArray
TInt	iSpare

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

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.

Parameters

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

~CColumnListBoxItemDrawer()

IMPORT_C

~CColumnListBoxItemDrawer

(

)

Destructor.

Member Functions Documentation

CColumnListBoxItemDrawer_Reserved()

IMPORT_C void

CColumnListBoxItemDrawer_Reserved

(

)

[private]

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

DrawItemMark(TBool, TBool, const TPoint &)

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

Not used in S60.

Parameters

TBool aItemIsSelected
TBool aViewIsDimmed
const TPoint & aMarkPos

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

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

From CTextListItemDrawer.

Draw item text.

Parameters

TInt aItemIndex	Index of the item to draw.
const TRect & aItemTextRect	Area to draw into.
TBool aItemIsCurrent	ETrue if the item is current.
TBool aViewIsEmphasized	ETrue if the view is emphasised.
TBool aItemIsSelected	ETrue if the item is selected.

ItemWidthInPixels(TInt)

IMPORT_C TInt

ItemWidthInPixels

(

TInt

aItemIndex

)

const [virtual]

From CListItemDrawer.

Gets the width of the specified item.

Parameters

TInt aItemIndex

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

LafItemSize()

TSize

LafItemSize

(

)

[inline]

Get Item Cell Size.

MinimumCellSize()

IMPORT_C TSize

MinimumCellSize

(

)

const [virtual]

From CListItemDrawer.

Gets the minimum cell size.

Properties(TInt)

IMPORT_C TListItemProperties

Properties

(

TInt

aItemIndex

)

const [virtual]

Get properties for an item.

Parameters

TInt aItemIndex

Item's index for identifying.

Reserved_1()

IMPORT_C TAny *

Reserved_1

(

)

[private, virtual]

SetItemCellSize(const TSize &)

IMPORT_C void

SetItemCellSize

(

const TSize &

aSizeInPixels

)

[virtual]

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.

Parameters

const TSize & 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

Parameters

TInt aItemIndex

Item index

TListItemProperties 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.

Member Data Documentation

CArrayFix< SListProperties > * iPropertyArray

CArrayFix< SListProperties > *

iPropertyArray

[protected]

Array of properties.

TInt iSpare

TInt

iSpare

[protected]

Not used.

CColumnListBoxItemDrawer Class Reference

Inherits from

Nested Classes and Structures

Constructor & Destructor Documentation

CColumnListBoxItemDrawer()

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

Parameters

~CColumnListBoxItemDrawer()

Member Functions Documentation

CColumnListBoxItemDrawer_Reserved()

ClearAllPropertiesL()

ColumnData()

DrawItemMark(TBool, TBool, const TPoint &)

Parameters

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

Parameters

ItemWidthInPixels(TInt)

Parameters

LafItemSize()

MinimumCellSize()

Properties(TInt)

Parameters

Reserved_1()

SetItemCellSize(const TSize &)

Parameters

SetPropertiesL(TInt, TListItemProperties)

Parameters

Member Data Documentation

CArrayFix< SListProperties > * iPropertyArray

TInt iSpare

CColumnListBoxItemDrawer(MTextListBoxModel , const CFont , CColumnListBoxData *)