Class CListBoxData

class CListBoxData : public CBase;

Description

Base class for list box data classes.

The class stores one or more instances of fonts in normal, bold and italic styles.

Derivation

• CBase - Base class for all classes to be instantiated on the heap
• CListBoxData - Base class for list box data classes

Members

Defined in CListBoxData:
Alignment(), CListBoxData(), ConstructFontL(), ConstructL(), DrawItem(), DrawItem(), Font(), FontBoundValues(), IsSearchString(), RegenerateFonts(), SetAlignmentL(), SetFontHeight(), SetSearchStringL(), SetupGc(), TFontStyle, UpdateFontBoundValues(), iFontProvider, iSearchString, iZoomFactor, ~CListBoxData()

Inherited from CBase:
Delete(), Extension_(), operator new()

IMPORT_C CListBoxData();

Description

Constructor.

Sets data as left aligned.

IMPORT_C ~CListBoxData();

Description

Destructor.

Deletes the search string if present.

IMPORT_C void ConstructL(const CFont *aBaseFont);

Description

Completes construction.

Constructs normal, bold, italic and bold italic fonts based on the specified aBaseFont .

Parameters

virtual IMPORT_C CFont *Font(const TListItemProperties &aItemProperties) const;

Description

Gets the font in which the item is drawn.

Parameters

Return value

IMPORT_C void SetupGc(const TListItemProperties &aItemProperties, CWindowGc &aGc) const;

Description

Sets list box item underline style, pen colour and font.

Parameters

IMPORT_C TListFontBoundValues FontBoundValues() const;

Description

Gets the font bound values.

These are global font properties such as the normal character width in pixels.

Return value

IMPORT_C TInt SetFontHeight(TInt aFontHeightInTwips);

Description

Sets font height in twips.

Parameters

Return value

IMPORT_C void SetSearchStringL(const TDesC *aSearchString);

Description

Sets the search string for search result viewing.

Parameters

IMPORT_C TBool IsSearchString() const;

Description

Tests whether a search string has been set for this list box.

Return value

IMPORT_C void DrawItem(CWindowGc &aGc, const TRect &aItemTextRect, const TDesC &aItemText, const CFont &aItemFont, const TInt aBaseLineOffset, TInt aMargin, const CGraphicsContext::TTextAlign aAlign=CGraphicsContext::ELeft) const;

Description

Draws list item text into the graphics context CWindowGc& aGc , in the rectangle const TRect& aItemTextRect .

Depending on the string, it will either be responsible for drawing a normal text string or a search text string in a rectangle.

Parameters

IMPORT_C void DrawItem(CWindowGc &aGc, const TRect &aItemTextRect, const TDesC &aItemText, const CFont &aItemFont, const TInt aBaseLineOffset, const CGraphicsContext::TTextAlign aAlign=CGraphicsContext::ELeft) const;

Description

Draws list item text into the graphics context CWindowGc& aGc , in the rectangle const TRect& aItemTextRect .

Supports different drawing for the search string.

Parameters

inline void SetAlignmentL(CGraphicsContext::TTextAlign aAlign);

Description

Sets list item text alignment.

Parameters

inline CGraphicsContext::TTextAlign Alignment() const;

Description

Gets the text alignment.

Return value

protected: IMPORT_C void ConstructFontL(const CFont *, TFontStyle, CFontsWithStyle &);

Description

Deprecated. Does nothing.

Parameters

protected: IMPORT_C void UpdateFontBoundValues(const CFont &);

Description

Deprecated. Does nothing.

Parameters

protected: IMPORT_C TInt RegenerateFonts(CFontsWithStyle &, TInt);

Description

Deprecated. Does nothing.

Parameters

Return value

protected: typedef TInt CListBoxData::TFontStyle;

Description

protected: HBufC * iSearchString;

Description

protected: const CCoeFontProvider * iFontProvider;

Description

protected: const TZoomFactor * iZoomFactor;

Description