CTextListItemDrawer Class Reference

#include <mw/eiklbi.h>

Link against: ConnectionUiUtilities.lib

class CTextListItemDrawer : public CListItemDrawer

Inherits from

CTextListItemDrawer
- CListItemDrawer

Protected Attributes
const CFont *	iFont
MTextListBoxModel *	iModel

Public Member Functions
	CTextListItemDrawer()
	CTextListItemDrawer(MTextListBoxModel , const CFont )
	~CTextListItemDrawer()
IMPORT_C void	ConstructL(const CFont *)
virtual IMPORT_C void	DrawActualItem(TInt, const TRect &, TBool, TBool, TBool, TBool)
IMPORT_C const CFont *	Font(TInt)
TInt	ItemMarkPosition()
TPtrC	ItemMarkReplacement()
TBool	ItemMarkReverse()
virtual IMPORT_C TInt	ItemWidthInPixels(TInt)
virtual IMPORT_C TInt	MatcherCursorAscent(TInt)
virtual IMPORT_C TRect	MatcherCursorRect(const TDesC &, TInt, TInt, TInt)
virtual IMPORT_C TSize	MinimumCellSize()
IMPORT_C void	SetCellWidthInChars(TInt)
IMPORT_C void	SetFont(const CFont *)
virtual IMPORT_C void	SetGc(CWindowGc *)
void	SetItemMarkPosition(TInt)
void	SetItemMarkReplacement(const TDesC &)
void	SetItemMarkReverse(TBool)
IMPORT_C void	SetSearchStringL(const TDesC *)

Protected Member Functions
virtual IMPORT_C void	DoDrawItemText(const TDesC &, const TRect &, TBool, TBool, TBool, TInt)
virtual IMPORT_C void	DrawItemText(TInt, const TRect &, TBool, TBool, TBool)
virtual IMPORT_C void	ResetGc()

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

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::DrawItemMark(TBool,TBool,const TPoint &)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::Properties(TInt)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::SetItemCellSize(const TSize &)
	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()

Detailed Description

Item drawer which can handle text.

Used by CListBoxView to draw individual list box items for a CEikTextListBox

Member Attribute Documentation

iFont

const CFont *

iFont

[protected]

Font used by the drawer.

iModel

MTextListBoxModel *

iModel

[protected]

List box model for the drawer.

Constructor & Destructor Documentation

CTextListItemDrawer ( )

IMPORT_C

CTextListItemDrawer

(

)

C++ default constructor.

CTextListItemDrawer ( MTextListBoxModel , const CFont )

IMPORT_C	CTextListItemDrawer	(	MTextListBoxModel *	aTextListBoxModel,
			const CFont *	aFont
		)

C++ default constructor.

Constructs a new text item drawer which draws the data of the specified model using the supplied font.

Parameter	Description
aTextListBoxModel	The model whose items will be drawn.
aFont	The font in which the items will be drawn.

~CTextListItemDrawer ( )

IMPORT_C

~CTextListItemDrawer

(

)

Destructor.

Member Function Documentation

ConstructL ( const CFont * )

IMPORT_C void

ConstructL

(

const CFont *

aFont

)

Handles 2nd phase construction.

Parameter	Description
aFont	The font in which the list box items will be drawn.

DoDrawItemText ( const TDesC &, const TRect &, TBool, TBool, TBool, TInt )

IMPORT_C void	DoDrawItemText	(	const TDesC &	aDes,
			const TRect &	aItemTextRect,
			TBool	aItemIsCurrent,
			TBool	aViewIsEmphasized,
			TBool	aItemIsSelected,
			TInt	aItemIndex
		)	const [protected, virtual]

Draws text.

This function is invoked by DrawItemText() to draw a string into a rectangular area of iGc.

Parameter	Description
aDes	The string 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.
aItemIndex	The item s index.

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

IMPORT_C void	DrawActualItem	(	TInt	aItemIndex,
			const TRect &	aActualItemRect,
			TBool	aItemIsCurrent,
			TBool	aViewIsEmphasized,
			TBool	aViewIsDimmed,
			TBool	aItemIsSelected
		)	const [virtual]

Reimplemented from CListItemDrawer::DrawActualItem(TInt,const TRect &,TBool,TBool,TBool,TBool)const

Draws the actual item contents for the specified item in the specified rectangle.

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

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

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

Draw item text.

This function is invoked by DrawActualItem() to draw the 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.

Font ( TInt )

IMPORT_C const CFont *

Font

(

TInt

aIndex

)

const

Reimplemented from CListItemDrawer::Font(TInt)const

Gets font for the specified item.

Parameter	Description
aIndex	The index of the target item.

Returns: Specified item's font.

ItemMarkPosition ( )

TInt

ItemMarkPosition

(

)

const [inline]

Gets item mark position.

Returns: Position of the Item mark.

ItemMarkReplacement ( )

TPtrC

ItemMarkReplacement

(

)

const [inline]

Gets item mark replacement.

Returns: Pointer to the replacement string.

ItemMarkReverse ( )

TBool

ItemMarkReverse

(

)

const [inline]

Check if the item has been marked reversed is active.

Returns: Indicates if active or not. ETrue if active

ItemWidthInPixels ( TInt )

IMPORT_C TInt

ItemWidthInPixels

(

TInt

aItemIndex

)

const [virtual]

Reimplemented from CListItemDrawer::ItemWidthInPixels(TInt)const

Gets the width in pixels of the specified item.

Parameter	Description
aItemIndex	The index of the item for which the width is obtained.

Returns: The specified item s width in pixels.

MatcherCursorAscent ( TInt )

IMPORT_C TInt

MatcherCursorAscent

(

TInt

aCurrentItemIndex

)

const [virtual]

Reimplemented from CListItemDrawer::MatcherCursorAscent(TInt)const

No Implementation.

Derived classes that deal with text and want to support incremental matching in listboxes need to redefine this function. Should be used to get the ascent of the matcher cursor in pixels.

Deprecated

Parameter	Description
aCurrentItemIndex	Index of the current item. Not Used.

Returns: Always returns 0;

MatcherCursorRect ( const TDesC &, TInt, TInt, TInt )

IMPORT_C TRect	MatcherCursorRect	(	const TDesC &	aMatchableText,
			TInt	aCharPos,
			TInt	aItemCellYPos,
			TInt	aCurrentItemIndex
		)	const [virtual]

Reimplemented from CListItemDrawer::MatcherCursorRect(const TDesC &,TInt,TInt,TInt)const

Gets the position and size of the matcher cursor.

Deprecated

Parameter	Description
aMatchableText	String currently being matched. Not Used.
aCharPos	Position within the string. Not Used.
aItemCellYPos	Y position of the item cell in pixels. Not Used.
aCurrentItemIndex	Item index for the current item. Not Used.

Returns: The rectangle covered by the matcher cursor, in pixels.

MinimumCellSize ( )

IMPORT_C TSize

MinimumCellSize

(

)

const [virtual]

Reimplemented from CListItemDrawer::MinimumCellSize()const

Gets the minimum size of a cell based on the font and the number of characters in the cell.

Returns: The minimum size for a cell, in pixels.

ResetGc ( )

IMPORT_C void

ResetGc

(

)

const [protected, virtual]

Reimplemented from CListItemDrawer::ResetGc()const

Resets the graphics context. This function invokes CListItemDrawer::ResetGc() and resets the pen colour to iTextColor.

SetCellWidthInChars ( TInt )

IMPORT_C void

SetCellWidthInChars

(

TInt

aNumOfCharsToDisplayInCell

)

Sets the number of characters in a cell. This value affects only MinimumCellSize().

Parameter	Description
aNumOfCharsToDisplayInCell	Number of characters to display in a cell.

SetFont ( const CFont * )

IMPORT_C void

SetFont

(

const CFont *

aFont

)

Sets the font.

Parameter	Description
aFont	The new font.

SetGc ( CWindowGc * )

IMPORT_C void

SetGc

(

CWindowGc *

aGc

)

[virtual]

Reimplemented from CListItemDrawer::SetGc(CWindowGc *)

Sets the graphics context.

Parameter	Description
aGc	The graphics context to use.

SetItemMarkPosition ( TInt )

void

SetItemMarkPosition

(

TInt

aPos

)

[inline]

Sets item mark position.

Parameter	Description
aPos	The new position.

SetItemMarkReplacement ( const TDesC & )

void

SetItemMarkReplacement

(

const TDesC &

aReplacement

)

[inline]

Sets the item mark replacement.

Parameter	Description
aReplacement	The new replacement descriptor.

SetItemMarkReverse ( TBool )

void

SetItemMarkReverse

(

TBool

aReverse

)

[inline]

Sets item mark reverse to be active or not.

Parameter	Description
aReverse	The new setting. ETrue if item is marked reversed.

SetSearchStringL ( const TDesC * )

IMPORT_C void

SetSearchStringL

(

const TDesC *

aSearchString

)

Sets the search string.

Parameter	Description
aSearchString	The new search string.

CTextListItemDrawer Class Reference

Inherits from

Detailed Description

Member Attribute Documentation

iFont

iModel

Constructor & Destructor Documentation

CTextListItemDrawer ( )

CTextListItemDrawer ( MTextListBoxModel *, const CFont * )

~CTextListItemDrawer ( )

Member Function Documentation

ConstructL ( const CFont * )

DoDrawItemText ( const TDesC &, const TRect &, TBool, TBool, TBool, TInt )

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

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

Font ( TInt )

ItemMarkPosition ( )

ItemMarkReplacement ( )

ItemMarkReverse ( )

ItemWidthInPixels ( TInt )

MatcherCursorAscent ( TInt )

MatcherCursorRect ( const TDesC &, TInt, TInt, TInt )

MinimumCellSize ( )

ResetGc ( )

SetCellWidthInChars ( TInt )

SetFont ( const CFont * )

SetGc ( CWindowGc * )

SetItemMarkPosition ( TInt )

SetItemMarkReplacement ( const TDesC & )

SetItemMarkReverse ( TBool )

SetSearchStringL ( const TDesC * )

CTextListItemDrawer ( MTextListBoxModel , const CFont )