Collapse all Symbian^3 Product Developer Library

MAknPictographDrawer Class Reference

class MAknPictographDrawer

Pictograph drawer interface

N/A

Since: 2.6

Public Member Functions
	~MAknPictographDrawer()
TBool	ContainsPictographs(const TDesC &)
void	DrawPictograph(CBitmapContext &, const TPoint &, TText, TAknPictographHeight)
void	DrawPictograph(CBitmapContext &, const TRect &, TText, TAknPictographHeight)
void	DrawPictograph(CBitmapContext &, const TRect &, const TRect &, TText, TAknPictographHeight)
void	DrawPictographsInText(CBitmapContext &, const CFont &, const TDesC &, const TPoint &)
void	DrawPictographsInText(CBitmapContext &, const CFont &, const TDesC &, const TRect &, TInt, CGraphicsContext::TTextAlign, TInt)
void	DrawText(CBitmapContext &, const CFont &, const TDesC &, const TPoint &)
void	DrawText(CBitmapContext &, const CFont &, const TDesC &, const TRect &, TInt, CGraphicsContext::TTextAlign, TInt)
TBool	IsAnimated(TText, TAknPictographHeight)
TBool	IsPictograph(TText)
TInt	SelectPictographHeightForFont(const CFont &, TAknPictographHeight &)
TAknPictographDrawingMode	SetPictographDrawingMode(TAknPictographDrawingMode)
HBufC *	SupportedPictographCodesL()

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.

Since: 2.6

Parameters

const TDesC & aText

Text.

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

void	DrawPictograph	(	CBitmapContext &	aGc,
			const TPoint &	aTopLeft,
			TText	aCode,
			TAknPictographHeight	aHeight
		)	const [pure virtual]

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

Since: 2.6

Parameters

CBitmapContext & aGc	Graphics context.
const TPoint & aTopLeft	Top left coordinates of the rendering position .
TText aCode	Pictograph code in Unicode.
TAknPictographHeight aHeight	Pictograph height.

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

void	DrawPictograph	(	CBitmapContext &	aGc,
			const TRect &	aRect,
			TText	aCode,
			TAknPictographHeight	aHeight
		)	const [pure virtual]

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

Since: 2.6

Parameters

CBitmapContext & aGc	Graphics context.
const TRect & aRect	Rectangle, where the pictograph is centered in.
TText aCode	Pictograph code in Unicode.
TAknPictographHeight aHeight	Pictograph height.

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

void	DrawPictograph	(	CBitmapContext &	aGc,
			const TRect &	aRect,
			const TRect &	aClipRect,
			TText	aCode,
			TAknPictographHeight	aHeight
		)	const [pure virtual]

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

Since: 2.6

Parameters

CBitmapContext & aGc	Graphics context.
const TRect & aRect	Rectangle, where the pictograph is centered in.
const TRect & aClipRect	Clipping rectangle.
TText aCode	Pictograph code in Unicode.
TAknPictographHeight aHeight	Pictograph height.

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

void	DrawPictographsInText	(	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.

Since: 2.6

Parameters

CBitmapContext & aGc	Graphics context.
const CFont & aFont	Used font.
const TDesC & aText	Text.
const TPoint & aPosition	Text baseline coordinates of the starting position.

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

void	DrawPictographsInText	(	CBitmapContext &	aGc,
			const CFont &	aFont,
			const TDesC &	aText,
			const TRect &	aBox,
			TInt	aBaselineOffset,
			CGraphicsContext::TTextAlign	aAlignment = CGraphicsContext::ELeft,
			TInt	aLeftMargin = 0
		)	const [pure virtual]

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

Since: 2.6

Parameters

CBitmapContext & aGc	Graphics context.
const CFont & aFont	Used font.
const TDesC & aText	Text.
const TRect & aBox	Rectangle, where the text is rendered.
TInt aBaselineOffset	Offset from the top of the rectangle to the baseline to the text.
CGraphicsContext::TTextAlign aAlignment = CGraphicsContext::ELeft	Text alignment.
TInt aLeftMargin = 0	The left margin for left-aligned text, or the right margin for right-aligned text

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

void	DrawText	(	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.

Since: 2.6

Parameters

CBitmapContext & aGc	Graphics context.
const CFont & aFont	Used font.
const TDesC & aText	Text.
const TPoint & aPosition	Text baseline coordinates of the starting position.

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

void	DrawText	(	CBitmapContext &	aGc,
			const CFont &	aFont,
			const TDesC &	aText,
			const TRect &	aBox,
			TInt	aBaselineOffset,
			CGraphicsContext::TTextAlign	aAlignment = CGraphicsContext::ELeft,
			TInt	aLeftMargin = 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.

Since: 2.6

Parameters

CBitmapContext & aGc	Graphics context.
const CFont & aFont	Used font.
const TDesC & aText	Text.
const TRect & aBox	Rectangle, where the text is rendered.
TInt aBaselineOffset	Offset from the top of the rectangle to the baseline to the text.
CGraphicsContext::TTextAlign aAlignment = CGraphicsContext::ELeft	Text alignment.
TInt aLeftMargin = 0	The left margin for left-aligned text, or the right margin for right-aligned text

IsAnimated(TText, TAknPictographHeight)

TBool	IsAnimated	(	TText	aCode,
			TAknPictographHeight	aHeight
		)	const [pure virtual]

Tells whether the given pictograph is animated or not.

Since: 2.6

Parameters

TText aCode	Pictograph code in Unicode.
TAknPictographHeight aHeight

IsPictograph(TText)

TBool

IsPictograph

(

TText

aCode

)

const [pure virtual]

Tells whether the character is in the pictograph code range.

Since: 2.6

Parameters

TText aCode

Character 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.

Since: 2.8

Parameters

const CFont & aFont	Used font.
TAknPictographHeight & aHeight	Pictograph height.

SetPictographDrawingMode(TAknPictographDrawingMode)

TAknPictographDrawingMode

SetPictographDrawingMode

(

TAknPictographDrawingMode

aDrawingMode

)

[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.

Since: 2.8

Parameters

TAknPictographDrawingMode aDrawingMode

the 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.

Since: 2.6