MAknPictographDrawer Class Reference

class MAknPictographDrawer

Pictograph drawer interface

N/A 2.6

Constructor & Destructor Documentation

~MAknPictographDrawer()

~MAknPictographDrawer()[inline, virtual]

Destructor.

Member Functions Documentation

ContainsPictographs(const TDesC &)

TBool ContainsPictographs(const TDesC &aText)const [pure virtual]

Tells whether the text contains any pictographs.

2.6

ETrue if the text contains any pictographs, EFalse if not.

Parameters

const TDesC & aTextText.

DrawPictograph(CBitmapContext &, const TPoint &, TText, TAknPictographHeight)

voidDrawPictograph(CBitmapContext &aGc,
const TPoint &aTopLeft,
TTextaCode,
TAknPictographHeightaHeight
)const [pure virtual]

Draws pictograph bitmap in the given position. This method sets aGc to use CGraphicsContext::ENullBrush.

2.6

Parameters

CBitmapContext & aGcGraphics context.
const TPoint & aTopLeftTop left coordinates of the rendering position .
TText aCodePictograph code in Unicode.
TAknPictographHeight aHeightPictograph height.

DrawPictograph(CBitmapContext &, const TRect &, TText, TAknPictographHeight)

voidDrawPictograph(CBitmapContext &aGc,
const TRect &aRect,
TTextaCode,
TAknPictographHeightaHeight
)const [pure virtual]

Draws pictograph bitmap centered in the given rect. This method sets aGc to use CGraphicsContext::ENullBrush.

2.6

Parameters

CBitmapContext & aGcGraphics context.
const TRect & aRectRectangle, where the pictograph is centered in.
TText aCodePictograph code in Unicode.
TAknPictographHeight aHeightPictograph height.

DrawPictograph(CBitmapContext &, const TRect &, const TRect &, TText, TAknPictographHeight)

voidDrawPictograph(CBitmapContext &aGc,
const TRect &aRect,
const TRect &aClipRect,
TTextaCode,
TAknPictographHeightaHeight
)const [pure virtual]

Draws pictograph bitmap centered in the given rect, clipped with clipping rect. This method sets aGc to use CGraphicsContext::ENullBrush.

2.6

Parameters

CBitmapContext & aGcGraphics context.
const TRect & aRectRectangle, where the pictograph is centered in.
const TRect & aClipRectClipping rectangle.
TText aCodePictograph code in Unicode.
TAknPictographHeight aHeightPictograph height.

DrawPictographsInText(CBitmapContext &, const CFont &, const TDesC &, const TPoint &)

voidDrawPictographsInText(CBitmapContext &aGc,
const CFont &aFont,
const TDesC &aText,
const TPoint &aPosition
)const [pure virtual]

Draws pictographs that are encountered in the text. Suitable pictograph height is chosen based on aFont. This method sets aGc to use CGraphicsContext::ENullBrush.

2.6

Parameters

CBitmapContext & aGcGraphics context.
const CFont & aFontUsed font.
const TDesC & aTextText.
const TPoint & aPositionText baseline coordinates of the starting position.

DrawPictographsInText(CBitmapContext &, const CFont &, const TDesC &, const TRect &, TInt, CGraphicsContext::TTextAlign, TInt)

voidDrawPictographsInText(CBitmapContext &aGc,
const CFont &aFont,
const TDesC &aText,
const TRect &aBox,
TIntaBaselineOffset,
CGraphicsContext::TTextAlignaAlignment = CGraphicsContext::ELeft,
TIntaLeftMargin = 0
)const [pure virtual]

Draws pictographs that are encountered in the text. This method sets aGc to use CGraphicsContext::ENullBrush.

2.6

Parameters

CBitmapContext & aGcGraphics context.
const CFont & aFontUsed font.
const TDesC & aTextText.
const TRect & aBoxRectangle, where the text is rendered.
TInt aBaselineOffsetOffset from the top of the rectangle to the baseline to the text.
CGraphicsContext::TTextAlign aAlignment = CGraphicsContext::ELeftText alignment.
TInt aLeftMargin = 0The left margin for left-aligned text, or the right margin for right-aligned text

DrawText(CBitmapContext &, const CFont &, const TDesC &, const TPoint &)

voidDrawText(CBitmapContext &aGc,
const CFont &aFont,
const TDesC &aText,
const TPoint &aPosition
)const [pure virtual]

Draws text using CGraphicsContext::DrawText and then draws pictographs on top of that.

Suitable pictograph height is chosen based on aFont.

The graphics context aGc must be set to use font aFont before calling this method.

This method sets aGc to use CGraphicsContext::ENullBrush.

2.6

Parameters

CBitmapContext & aGcGraphics context.
const CFont & aFontUsed font.
const TDesC & aTextText.
const TPoint & aPositionText baseline coordinates of the starting position.

DrawText(CBitmapContext &, const CFont &, const TDesC &, const TRect &, TInt, CGraphicsContext::TTextAlign, TInt)

voidDrawText(CBitmapContext &aGc,
const CFont &aFont,
const TDesC &aText,
const TRect &aBox,
TIntaBaselineOffset,
CGraphicsContext::TTextAlignaAlignment = CGraphicsContext::ELeft,
TIntaLeftMargin = 0
)const [pure virtual]

Draws text using CGraphicsContext::DrawText and then draws pictographs on top of that.

Suitable pictograph height is chosen based on aFont.

The graphics context aGc must be set to use font aFont before calling this method.

This method sets aGc to use CGraphicsContext::ENullBrush.

2.6

Parameters

CBitmapContext & aGcGraphics context.
const CFont & aFontUsed font.
const TDesC & aTextText.
const TRect & aBoxRectangle, where the text is rendered.
TInt aBaselineOffsetOffset from the top of the rectangle to the baseline to the text.
CGraphicsContext::TTextAlign aAlignment = CGraphicsContext::ELeftText alignment.
TInt aLeftMargin = 0The left margin for left-aligned text, or the right margin for right-aligned text

IsAnimated(TText, TAknPictographHeight)

TBool IsAnimated(TTextaCode,
TAknPictographHeightaHeight
)const [pure virtual]

Tells whether the given pictograph is animated or not.

2.6

Parameters

TText aCodePictograph code in Unicode.
TAknPictographHeight aHeight

IsPictograph(TText)

TBool IsPictograph(TTextaCode)const [pure virtual]

Tells whether the character is in the pictograph code range.

2.6

ETrue if in pictograph code range, EFalse if not.

Parameters

TText aCodeCharacter code in Unicode.

SelectPictographHeightForFont(const CFont &, TAknPictographHeight &)

TInt SelectPictographHeightForFont(const CFont &aFont,
TAknPictographHeight &aHeight
)const [pure virtual]

Tries to find a matching pictograph height for a given font.

2.8

KErrNone if a supported pictograph height is found that matches aFont otherwise returns KErrNotSupported

Parameters

const CFont & aFontUsed font.
TAknPictographHeight & aHeightPictograph height.

SetPictographDrawingMode(TAknPictographDrawingMode)

TAknPictographDrawingMode SetPictographDrawingMode(TAknPictographDrawingModeaDrawingMode)[pure virtual]

Sets the pictograph drawing mode for DrawPictograph calls. Other functions e.g. DrawText, etc are unaffected by this function. The drawing mode is set to EDrawingModeNormal by default. Note: When drawing mode EDrawingModeWhite is set only a single DrawPictograph call is supported per component->Draw() call.

2.8

the value of the previous pictograph drawing mode.

Parameters

TAknPictographDrawingMode aDrawingModethe new pictograph drawing mode to be used.

SupportedPictographCodesL()

HBufC *SupportedPictographCodesL()const [pure virtual]

Returns a heap descriptor filled with all supported pictograph codes. They are sorted in ascending pictograph code order. Ownership of the returned object is transferred to the caller.

2.6

Heap descriptor filled with all supported pictograph codes.