CTmText Class Reference

class CTmText : public CBase

A self-contained text object. It owns both layout and content. It is intended for labels and the general display of small-to-medium-sized amounts of text.

Inherits from

Public Member Functions
~CTmText()
IMPORT_C voidChangeFormatL(const TTmFormatParamBase &)
IMPORT_C voidClear()
IMPORT_C voidCustomizeL(const MTmCustom *)
voidDraw(CGraphicsContext &, const TPoint &, const TRect &, const TLogicalRgb *, TBool)
IMPORT_C voidGetFormat(TTmFormatParamBase &)
IMPORT_C voidInsertL(TInt, const TDesC &, const TTmCharFormat *, const RTmParFormat *, TRect *, TInt *)
IMPORT_C TIntMemoryUsed()
IMPORT_C CTmText *NewL(MGraphicsDeviceMap *, const TTmFormatParamBase *)
IMPORT_C CTmText *NewL(MGraphicsDeviceMap &, const TTmFormatParamBase &)
IMPORT_C CTmText *NewL(MGraphicsDeviceMap &, TInt, TInt)
IMPORT_C voidSetWrapWidthL(TInt)
Private Member Functions
CTmText()
IMPORT_C voidSpare1()
const CTmTextLayout &TextLayout()
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()
Private Attributes
CTmTextImp *iImp

Constructor & Destructor Documentation

CTmText()

CTmText()[private]

~CTmText()

IMPORT_C~CTmText()

Member Functions Documentation

ChangeFormatL(const TTmFormatParamBase &)

IMPORT_C voidChangeFormatL(const TTmFormatParamBase &aFormatParam)

Parameters

const TTmFormatParamBase & aFormatParam

Clear()

IMPORT_C voidClear()

CustomizeL(const MTmCustom *)

IMPORT_C voidCustomizeL(const MTmCustom *aCustom)

Parameters

const MTmCustom * aCustom

Draw(CGraphicsContext &, const TPoint &, const TRect &, const TLogicalRgb *, TBool)

voidDraw(CGraphicsContext &aGc,
const TPoint &aTopLeft,
const TRect &aClipRect,
const TLogicalRgb *aDocBackground,
TBoolaDrawParBackground
)[inline]

Draws the formatted text. This inline function just calls CTmText::DrawLayout and is identical to it. It is provided for coding convenience because of the expectation that a drawing function called Draw exists.

Parameters

CGraphicsContext & aGc
const TPoint & aTopLeft
const TRect & aClipRect
const TLogicalRgb * aDocBackground
TBool aDrawParBackground

GetFormat(TTmFormatParamBase &)

IMPORT_C voidGetFormat(TTmFormatParamBase &aFormatParam)const

Parameters

TTmFormatParamBase & aFormatParam

InsertL(TInt, const TDesC &, const TTmCharFormat *, const RTmParFormat *, TRect *, TInt *)

IMPORT_C voidInsertL(TIntaPos,
const TDesC &aText,
const TTmCharFormat *aCharFormat = NULL,
const RTmParFormat *aParFormat = NULL,
TRect *aRedrawRect = NULL,
TInt *aScroll = NULL
)

Parameters

TInt aPos
const TDesC & aText
const TTmCharFormat * aCharFormat = NULL
const RTmParFormat * aParFormat = NULL
TRect * aRedrawRect = NULL
TInt * aScroll = NULL

MemoryUsed()

IMPORT_C TIntMemoryUsed()const

NewL(MGraphicsDeviceMap *, const TTmFormatParamBase *)

IMPORT_C CTmText *NewL(MGraphicsDeviceMap *aDevice = NULL,
const TTmFormatParamBase *aFormatParam = NULL
)[static]

Parameters

MGraphicsDeviceMap * aDevice = NULL
const TTmFormatParamBase * aFormatParam = NULL

NewL(MGraphicsDeviceMap &, const TTmFormatParamBase &)

IMPORT_C CTmText *NewL(MGraphicsDeviceMap &aDevice,
const TTmFormatParamBase &aFormatParam
)[static]

Parameters

MGraphicsDeviceMap & aDevice
const TTmFormatParamBase & aFormatParam

NewL(MGraphicsDeviceMap &, TInt, TInt)

IMPORT_C CTmText *NewL(MGraphicsDeviceMap &aDevice,
TIntaWrapWidth,
TIntaFlags
)[static]

Parameters

MGraphicsDeviceMap & aDevice
TInt aWrapWidth
TInt aFlags

SetWrapWidthL(TInt)

IMPORT_C voidSetWrapWidthL(TIntaWrapWidth)

Parameters

TInt aWrapWidth

Spare1()

IMPORT_C voidSpare1()[private]

TextLayout()

const CTmTextLayout &TextLayout()const [private]

Member Data Documentation

CTmTextImp * iImp

CTmTextImp *iImp[private]
© Nokia 2010.