CListItemDrawer Class Reference

enum CListItemDrawer::TListItemAttribute

Provides list box attributes for handling multiple selections.

These flags can be set using the CListItemDrawer::SetFlags function.

Enumerator:

EDrawMarkSelection�	If set, specifies the inclusion of a gap into which a tick mark can be drawn if the item is selected. This is used in the following `CListItemDrawer` class functions: `DrawItem()`, `DrawItemMark()`, `SetDrawMark()`
EPaintedSelection�	If set, draws a highlight over a selected list item. This is used in the `CTextListItemDrawer::DoDrawItemText()` function.
EDrawOnlyActiveSelection�	This flag is not supported.
EDisableHighlight�	If set highlight is disabled.

IMPORT_C CListItemDrawer::~CListItemDrawer

Provides attributes for list items.

Enumerator:

ECurrent�	Highlight for current text.
EEmphasized�	Highlight for text when the listbox view is emphasized. This is used in the following `CListBoxView` class functions: `DrawItem()`, `DrawMatcherCursor()`, `SetEmphasized()`.
ESelected�	Highlight for text that is selected. This is used in the following functions: `CColumnListBoxItemDrawer::DrawItemText()`, `CHierarchicalListItemDrawer::DrawActualItem()`, `CDirContentsListItemDrawer::DrawActualItem()`.
EMask�	Sum of all the above attributes. This last attribute is used to control that one can use only valid attributes above. So do not use it at all.

Constructor & Destructor Documentation

IMPORT_C void CListItemDrawer::ClearFlags

�	Destructor.

IMPORT_C CListItemDrawer::CListItemDrawer (� �)� [protected]

�	C++ default constructor.

Member Function Documentation

TRgb CListItemDrawer::BackColor (� �)� const [inline]

�	Gets the colour used to draw the background for non-highlighted items. Returns: Background colour.

Sets the item drawer flags.

Parameters:

aFlags�

The new item drawer flags.

virtual IMPORT_C void CListItemDrawer::ClearRect (� const TRect &� aRect �)� const [virtual]

Clears the specified rectangle of this object's graphics context.

Parameters:

aRect�

Rectangle to clear.

TRgb CListItemDrawer::DimmedBackColor (� �)� const [inline]

�	Gets the colour used to draw the background for dimmed items. Returns: The background colour for dimmed items.

TRgb CListItemDrawer::DimmedTextColor (� �)� const [inline]

�	Gets the colour used to draw dimmed text. Returns: The dimmed text colour.

virtual void CListItemDrawer::DrawActualItem	(�	TInt�	aItemIndex,
		const TRect &�	aActualItemRect,
		TBool�	aItemIsCurrent,
		TBool�	aViewIsEmphasized,
		TBool�	aViewIsDimmed,
		TBool�	aItemIsSelected
	)�	const `[protected, pure virtual]`

Draws item text.

This function is called by CListItemDrawer::DrawItem() with appropriate arguments. Its purpose is to draw the actual item

everything other than the item mark - into the graphics context.

Parameters:

	aItemIndex�	Which item to draw.
	aActualItemRect�	Where the item should be drawn.
	aItemIsCurrent�	Whether the item is current.
	aViewIsEmphasized�	Whether the list box view is emphasised.
	aViewIsDimmed�	Whether the list box view is dimmed.
	aItemIsSelected�	Whether the list box item is selected.

Implemented in CTextListItemDrawer.

IMPORT_C void CListItemDrawer::DrawFrame	(�	CWindowGc &�	aGc,
		const TRect &�	aRect,
		TInt�	aFlags
	)�	const

Draws the frame.

Uses the colours set with the fonts and colour functions described above.

Deprecated:

Parameters:

	aGc�	The graphics context used to draw the frame.
	aRect�	The frame's rectangle.
	aFlags�	The item drawer flags.

virtual IMPORT_C void CListItemDrawer::DrawItem	(�	TInt�	aItemIndex,
		TPoint�	aItemRectPos,
		TBool�	aItemIsSelected,
		TBool�	aItemIsCurrent,
		TBool�	aViewIsEmphasized,
		TBool�	aViewIsDimmed
	)�	const `[virtual]`

IMPORT_C CFont* CListItemDrawer::Font

Draws the entire item.

This function is called by the list box view. As implemented in CListItemDrawer, this function draws the item text using DrawActualItem(), and an item mark using DrawItemMark().

Parameters:

	aItemIndex�	Index of the item to draw.
	aItemRectPos�	Position of the rectangle to draw.
	aItemIsSelected�	Whether the item is selected.
	aItemIsCurrent�	Whether the item is current.
	aViewIsEmphasized�	Whether the list box view has the emphasised flag set (see `CListBoxView::SetEmphasized()`).
	aViewIsDimmed�	Whether the list box view has its dimmed flag set (see `CListBoxView::SetDimmed()`).

Reimplemented in CSingleHeadingStyleItemDrawer, CDoubleLargeStyleItemDrawer, and CWordWrappedFormattedCellItemDrawer.

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

�	Not Used in S60. Reimplemented in CColumnListBoxItemDrawer, and CFormattedCellListBoxItemDrawer.

TInt CListItemDrawer::Flags (� �)� const [inline]

�	Gets the item drawer flags. Returns: The item drawer flags.

Gets the font for the specified item.

The function returns NULL if no font storage data has been set.

Parameters:

The index of the item for which the font is returned.

Returns:: The item's font.

Reimplemented in CTextListItemDrawer.

IMPORT_C CWindowGc* CListItemDrawer::Gc

IMPORT_C TSize CListItemDrawer::ItemCellSize

�	Gets graphics context which is used for drawing. Returns: Pointer to the graphics context used for drawing.

TRgb CListItemDrawer::HighlightedBackColor (� �)� const [inline]

�	Gets the colour used to draw the background for highlighted items. Returns: The highlighted background colour.

TRgb CListItemDrawer::HighlightedTextColor (� �)� const [inline]

�	Gets the colour used to draw highlighted text. Returns: The highlighted text colour.

�	Gets current item cell size. Returns: Item cell size

virtual IMPORT_C TInt CListItemDrawer::ItemWidthInPixels (� TInt� aItemIndex �)� const [virtual]

Gets the width of the specified item.

Parameters:

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

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

Reimplemented in CColumnListBoxItemDrawer, CFormattedCellListBoxItemDrawer, and CTextListItemDrawer.

TRgb CListItemDrawer::MarkColor (� �)� const [inline, protected]

�	Gets the colour used to draw tick marks. A tick mark usually indicates that an item is selected. Returns: The tick mark colour.

IMPORT_C TInt CListItemDrawer::MarkColumn

IMPORT_C TInt CListItemDrawer::MarkGutter

�	Gets mark column width. Returns: Mark column width.

�	Gets the width of the gap between the column containig the lists item marks and the text column. Returns: Size of the inter-column gutter.

virtual IMPORT_C TInt CListItemDrawer::MatcherCursorAscent (� TInt� aCurrentItemIndex �)� const [virtual]

Item index of the target item.

Gets the ascent of the matcher cursor.

This is obtained for the item at index aCurrentItemIndex. The function returns 0 by default.

Deprecated:

Parameters:

aCurrentItemIndex�

Returns:: The height of the matcher cursor.

Reimplemented in CTextListItemDrawer.

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

Gets a rectangle describing where the matcher cursor should be drawn.

The default behavious is to return uninitialised TRect.

Deprecated:

Parameters:

	aMatchableText�	The text of the currently matched string.
	aCharPos�	The position in the string of the character just matched in the current incremental match.
	aItemCellYPos�	Y position of the item cell.
	aCurrentItemIndex�	Item index for the current item.

Returns:: Where the cursor should be drawn.

Reimplemented in CTextListItemDrawer.

virtual IMPORT_C TSize CListItemDrawer::MinimumCellSize (� �)� const [virtual]

�	Gets the minimum cell size. Returns: The minimum size for a cell. This is `TSize(0, 0)` in `CListItemDrawer`. Reimplemented in CColumnListBoxItemDrawer, CFormattedCellListBoxItemDrawer, and CTextListItemDrawer.

virtual IMPORT_C TListItemProperties CListItemDrawer::Properties (� TInt� aItemIndex �)� const [virtual]

Gets the colour and style properties of the specified item.

Parameters:

The index of the item for which properties are obtained (Not Used).

Returns:: The item's properties.

Reimplemented in CColumnListBoxItemDrawer, and CFormattedCellListBoxItemDrawer.

virtual IMPORT_C void CListItemDrawer::ResetGc (� �)� const [protected, virtual]

�	Resets the pen style, brush style, brush colour etc. to suitable starting values for this class. This function is called after every drawing operation. Reimplemented in CTextListItemDrawer.

void CListItemDrawer::SetBackColor (� TRgb� aColor �)� [inline]

Sets the colour used to draw the background for non-highlighted items.

Parameters:

IMPORT_C void CListItemDrawer::SetData

The background colour.

Sets the font storage data for the item drawer and transfer ownership of that data.

Parameters:

aData�

Font storage data .

void CListItemDrawer::SetDimmedBackColor (� TRgb� aColor �)� [inline]

Sets the colour used to draw the background for dimmed items.

Parameters:

The background colour for dimmed items.

void CListItemDrawer::SetDimmedTextColor (� TRgb� aColor �)� [inline]

Sets the colour used to draw dimmed text.

Parameters:

IMPORT_C void CListItemDrawer::SetDrawMark

The dimmed text colour.

Sets whether item tick marks are drawn.

If the draw mark flag iDrawMark is set, DrawItem() leaves space for the marks column to the left of the text column, and DrawItemMark() draws the item marks.

Parameters:

aDrawMark�

New value for iDrawMark.

IMPORT_C void CListItemDrawer::SetFlags

Sets the item drawer flags.

Parameters:

aFlags�

The new item drawer flags.

virtual IMPORT_C void CListItemDrawer::SetGc (� CWindowGc *� aGc �)� [virtual]

Pointer to the context to use.

Sets the graphics context which this object uses for drawing.

Parameters:

aGc�

Reimplemented in CTextListItemDrawer.

void CListItemDrawer::SetHighlightedBackColor (� TRgb� aColor �)� [inline]

Sets the colour used to draw the background for highlighted items.

Parameters:

The highlighted background colour.

void CListItemDrawer::SetHighlightedTextColor (� TRgb� aColor �)� [inline]

Sets the colour used to draw highlighted text.

Parameters:

The highlighted text colour.

virtual IMPORT_C void CListItemDrawer::SetItemCellSize (� const TSize &� aSizeInPixels �)� [virtual]

New size for the item cell.

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:

aSizeInPixels�

Reimplemented in CColumnListBoxItemDrawer, and CFormattedCellListBoxItemDrawer.

virtual IMPORT_C void CListItemDrawer::SetMarkColumnWidth (� TInt� aWidthInPixels �)� [virtual]

New width for the mark column.

Sets the width of the column containing the mark.

Parameters:

aWidthInPixels�

virtual IMPORT_C void CListItemDrawer::SetMarkGutter (� TInt� aGapInPixels �)� [virtual]

IMPORT_C void CListItemDrawer::SetSkinEnabledL

Sets the width of the gap between the column containing the lists item marks and the text column.

Parameters:

aGapInPixels�

New gap size.

Ability to enable skins in listboxes.

Parameters:

aEnabled� parameter for enabling/disabling skin. ETrue enables skin, EFalse disables skin

IMPORT_C void CListItemDrawer::SetSymbolFont

Sets symbol font for the item drawer.

The symbol font is used to draw the standard tick item marks.

Parameters:

aFont�

The font to be used.

void CListItemDrawer::SetTextColor (� TRgb� aColor �)� [inline]

Sets the colour used to draw non-highlighted text.

Parameters:

The text colour.

IMPORT_C void CListItemDrawer::SetupGc (� TInt� aItemIndex �)� const [protected]

Sets up the graphics context for the specified item.

Parameters:

The item for which the graphics context will be set up.

IMPORT_C void CListItemDrawer::SetVerticalInterItemGap

Sets the vertical gap between items in the list.

Parameters:

aGapInPixels�

New value for the vertical gap between items in pixels.

virtual IMPORT_C void CListItemDrawer::SetViewRect (� const TRect &� aRect �)� [virtual]

IMPORT_C MAknsControlContext* CListItemDrawer::SkinBackgroundControlContext

Sets the viewing rectangle for this item drawer.

This value is not used by the CListItemViewer, but may be used by its derived classes.

Parameters:

aRect� New value for iViewRect.