Collapse all Symbian^3 Product Developer Library

CTextListItemDrawer Class Reference

class CTextListItemDrawer : public CListItemDrawer

Item drawer which can handle text.

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

Inherits from

CTextListItemDrawer
- CListItemDrawer
  - CBase

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

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

Private Member Functions
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::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()

Inherited Enumerations
	CListItemDrawer:TFlags
	CListItemDrawer:TListItemAttribute

Protected Attributes
const CFont *	iFont
MTextListBoxModel *	iModel

Private Attributes
TInt	iItemMarkPos
TPtrC	iItemMarkReplacement
TBool	iItemMarkReverse
TInt	iNumOfCharsInCell

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

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.

Parameters

MTextListBoxModel * aTextListBoxModel	The model whose items will be drawn.
const CFont * aFont	The font in which the items will be drawn.

~CTextListItemDrawer()

IMPORT_C

~CTextListItemDrawer

(

)

Destructor.

Member Functions Documentation

ConstructL(const CFont *)

IMPORT_C void

ConstructL

(

const CFont *

aFont

)

Handles 2nd phase construction.

Parameters

const CFont * 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.

Parameters

const TDesC & aDes	The string 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.
TInt 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]

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

Draws the actual item contents for the item at index aItemIndex in the rectangle aActualItemRect.

Parameters

TInt aItemIndex	Index of the item to draw.
const TRect & aActualItemRect	Area to draw into.
TBool aItemIsCurrent	ETrue if the item is current.
TBool aViewIsEmphasized	ETrue if the view is emphasised.
TBool aViewIsDimmed	Ignored
TBool 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.

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.

Font(TInt)

IMPORT_C const CFont *

Font

(

TInt

aIndex

)

const [inline]

Gets font for the specified item.

Parameters

TInt aIndex

The index of the target item.

ItemMarkPosition()

TInt

ItemMarkPosition

(

)

const [inline]

Gets item mark position.

ItemMarkReplacement()

TPtrC

ItemMarkReplacement

(

)

const [inline]

Gets item mark replacement.

ItemMarkReverse()

TBool

ItemMarkReverse

(

)

const [inline]

Check if the item has been marked reversed is active.

ItemWidthInPixels(TInt)

IMPORT_C TInt

ItemWidthInPixels

(

TInt

aItemIndex

)

const [virtual]

Gets the width in pixels of the specified item.

Parameters

TInt aItemIndex

The index of the item for which the width is obtained.

MatcherCursorAscent(TInt)

IMPORT_C TInt

MatcherCursorAscent

(

TInt

aCurrentItemIndex

)

const [virtual]

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.

Parameters

TInt aCurrentItemIndex

Index of the current item. Not Used.

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

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

Gets the position and size of the matcher cursor.

Parameters

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

MinimumCellSize()

IMPORT_C TSize

MinimumCellSize

(

)

const [virtual]

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

Reserved_1()

IMPORT_C TAny *

Reserved_1

(

)

[private, virtual]

ResetGc()

IMPORT_C void

ResetGc

(

)

const [protected, virtual]

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

Parameters

TInt aNumOfCharsToDisplayInCell

Number of characters to display in a cell.

SetFont(const CFont *)

IMPORT_C void

SetFont

(

const CFont *

aFont

)

Sets the font.

Parameters

const CFont * aFont

The new font.

SetGc(CWindowGc *)

IMPORT_C void

SetGc

(

CWindowGc *

aGc

)

[virtual]

Sets the graphics context.

Parameters

CWindowGc * aGc

The graphics context to use.

SetItemMarkPosition(TInt)

void

SetItemMarkPosition

(

TInt

aPos

)

[inline]

Sets item mark position.

Parameters

TInt aPos

The new position.

SetItemMarkReplacement(const TDesC &)

void

SetItemMarkReplacement

(

const TDesC &

aReplacement

)

[inline]

Sets the item mark replacement.

Parameters

const TDesC & aReplacement

The new replacement descriptor.

SetItemMarkReverse(TBool)

void

SetItemMarkReverse

(

TBool

aReverse

)

[inline]

Sets item mark reverse to be active or not.

Parameters

TBool aReverse

The new setting. ETrue if item is marked reversed.

SetSearchStringL(const TDesC *)

IMPORT_C void

SetSearchStringL

(

const TDesC *

aSearchString

)

Sets the search string.

Parameters

const TDesC * aSearchString

The new search string.

Member Data Documentation

const CFont * iFont

const CFont *

iFont

[protected]

Font used by the drawer.

TInt iItemMarkPos

TInt

iItemMarkPos

[private]

TPtrC iItemMarkReplacement

TPtrC

iItemMarkReplacement

[private]

TBool iItemMarkReverse

TBool

iItemMarkReverse

[private]

MTextListBoxModel * iModel

MTextListBoxModel *

iModel

[protected]

List box model for the drawer.

TInt iNumOfCharsInCell

TInt

iNumOfCharsInCell

[private]

CTextListItemDrawer Class Reference

Inherits from

Constructor & Destructor Documentation

CTextListItemDrawer()

CTextListItemDrawer(MTextListBoxModel *, const CFont *)

Parameters

~CTextListItemDrawer()

Member Functions Documentation

ConstructL(const CFont *)

Parameters

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

Parameters

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

Parameters

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

Parameters

Font(TInt)

Parameters

ItemMarkPosition()

ItemMarkReplacement()

ItemMarkReverse()

ItemWidthInPixels(TInt)

Parameters

MatcherCursorAscent(TInt)

Parameters

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

Parameters

MinimumCellSize()

Reserved_1()

ResetGc()

SetCellWidthInChars(TInt)

Parameters

SetFont(const CFont *)

Parameters

SetGc(CWindowGc *)

Parameters

SetItemMarkPosition(TInt)

Parameters

SetItemMarkReplacement(const TDesC &)

Parameters

SetItemMarkReverse(TBool)

Parameters

SetSearchStringL(const TDesC *)

Parameters

Member Data Documentation

const CFont * iFont

TInt iItemMarkPos

TPtrC iItemMarkReplacement

TBool iItemMarkReverse

MTextListBoxModel * iModel

TInt iNumOfCharsInCell

CTextListItemDrawer(MTextListBoxModel , const CFont )