MTmTextLayoutForwarder Class Reference

#include <tagma.h>

Link against: tagma.lib

class MTmTextLayoutForwarder
Public Member Functions
IMPORT_C TBoolDocPosToLine(const TTmDocPosSpec &, TTmLineInfo &)
IMPORT_C TBoolDocPosToLine(const TTmDocPos &, TTmLineInfo &)
IMPORT_C voidDrawBackground(CGraphicsContext &, const TPoint &, const TRect &, const TLogicalRgb &)
IMPORT_C voidDrawLayout(CGraphicsContext &, const TPoint &, const TRect &, const TLogicalRgb *, TBool)
IMPORT_C TIntEndChar()
IMPORT_C TBoolFindDocPos(const TTmDocPosSpec &, TTmPosInfo2 &, TTmLineInfo &)
IMPORT_C TBoolFindDocPos(const TTmDocPos &, TTmPosInfo &, TTmLineInfo &)
IMPORT_C TBoolFindXyPos(const TPoint &, TTmPosInfo2 &, TTmLineInfo &)
IMPORT_C TBoolFindXyPos(const TPoint &, TTmPosInfo &, TTmLineInfo &)
IMPORT_C TBoolFindXyPosWithDisambiguation(const TPoint &, TTmPosInfo2 &, TTmPosInfo2 &, TTmLineInfo &)
IMPORT_C TBoolGetCursor(const TTmDocPosSpec &, TTmCursorPlacement, TTmLineInfo &, TPoint &, TInt &, TInt &, TInt &)
IMPORT_C TBoolGetCursor(const TTmDocPos &, TTmCursorPlacement, TTmLineInfo &, TPoint &, TInt &, TInt &, TInt &)
IMPORT_C TBoolGetDisplayedText(TInt, TDes &, TInt &)
IMPORT_C voidGetMinimumLayoutSizeL(TInt, TSize &)
IMPORT_C voidGetMinimumLayoutSizeL(TInt, TBool, TSize &)
IMPORT_C TBoolGetNextPosLeftWithDisambiguation(const TTmDocPosSpec &, TTmPosInfo2 &, TTmPosInfo2 &)
IMPORT_C TBoolGetNextPosRightWithDisambiguation(const TTmDocPosSpec &, TTmPosInfo2 &, TTmPosInfo2 &)
IMPORT_C TBoolGetNextVisualCursorPos(const TTmDocPosSpec &, TTmPosInfo2 &, TBool)
IMPORT_C TBoolGetNextVisualCursorPos(const TTmDocPos &, TTmPosInfo &, TBool)
IMPORT_C voidHorizontalExtremes(TInt &, TInt &, TInt, TInt)
IMPORT_C voidInvertLayout(CGraphicsContext &, const TPoint &, TInt, TInt)
IMPORT_C TIntLayoutHeight()
IMPORT_C TIntLayoutWidth()
IMPORT_C TBoolLineNumberToLine(TInt, TTmLineInfo &)
IMPORT_C TIntLines()
IMPORT_C TBoolParNumberToLine(TInt, TInt, TTmLineInfo &)
IMPORT_C TIntParagraphs()
IMPORT_C TIntStartChar()
IMPORT_C TIntWidthOfWidestLine(TInt, TInt)
IMPORT_C TBoolYPosToLine(TInt, TTmLineInfo &)

Detailed Description

A mixin class to make it easy for higher-level classes that own a CTmTextLayout object to have enquiry functions without it being necessary to implement them all as forwarding functions. The owner class just implements TextLayout and overrides GetOrigin if necessary.

Non-const CTmTextLayout functions like Clear are not included because allowing them to be called on owner classes would probably put the owner class into an inconsistent state.

The word Layout is prefixed, suffixed or infixed to functions with names that would usually conflict with owner class names. For example, we have DrawLayout, not Draw, and GetMinimumLayoutSizeL, not GetMinimumSizeL.

The class should only be used internally by FORM component.

Member Function Documentation

DocPosToLine ( const TTmDocPosSpec &, TTmLineInfo & )

IMPORT_C TBoolDocPosToLine(const TTmDocPosSpec &aDocPos,
TTmLineInfo &aLineInfo
)const

DocPosToLine ( const TTmDocPos &, TTmLineInfo & )

IMPORT_C TBoolDocPosToLine(const TTmDocPos &aDocPos,
TTmLineInfo &aLineInfo
)const

Deprecated7.0s

DrawBackground ( CGraphicsContext &, const TPoint &, const TRect &, const TLogicalRgb & )

IMPORT_C voidDrawBackground(CGraphicsContext &aGc,
const TPoint &aTopLeft,
const TRect &aClipRect,
const TLogicalRgb &aBackground
)const

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

IMPORT_C voidDrawLayout(CGraphicsContext &aGc,
const TPoint &aTopLeft,
const TRect &aClipRect,
const TLogicalRgb *aDocBackground,
TBoolaDrawParBackground
)const

EndChar ( )

IMPORT_C TIntEndChar()const

Return the character after the last formatted character.

FindDocPos ( const TTmDocPosSpec &, TTmPosInfo2 &, TTmLineInfo & )

IMPORT_C TBoolFindDocPos(const TTmDocPosSpec &aDocPos,
TTmPosInfo2 &aPosInfo,
TTmLineInfo &aLineInfo
)const

FindDocPos ( const TTmDocPos &, TTmPosInfo &, TTmLineInfo & )

IMPORT_C TBoolFindDocPos(const TTmDocPos &aDocPos,
TTmPosInfo &aPosInfo,
TTmLineInfo &aLineInfo
)const

Deprecated7.0s

FindXyPos ( const TPoint &, TTmPosInfo2 &, TTmLineInfo & )

IMPORT_C TBoolFindXyPos(const TPoint &aXyPos,
TTmPosInfo2 &aPosInfo,
TTmLineInfo &aLineInfo
)const

FindXyPos ( const TPoint &, TTmPosInfo &, TTmLineInfo & )

IMPORT_C TBoolFindXyPos(const TPoint &aXyPos,
TTmPosInfo &aPosInfo,
TTmLineInfo &aLineInfo
)const

Deprecated7.0s

FindXyPosWithDisambiguation ( const TPoint &, TTmPosInfo2 &, TTmPosInfo2 &, TTmLineInfo & )

IMPORT_C TBoolFindXyPosWithDisambiguation(const TPoint &aXyPos,
TTmPosInfo2 &aPosLeft,
TTmPosInfo2 &aPosRight,
TTmLineInfo &aLineInfo
)const

GetCursor ( const TTmDocPosSpec &, TTmCursorPlacement, TTmLineInfo &, TPoint &, TInt &, TInt &, TInt & )

IMPORT_C TBoolGetCursor(const TTmDocPosSpec &aDocPos,
TTmCursorPlacementaPlacement,
TTmLineInfo &aLineInfo,
TPoint &aOrigin,
TInt &aWidth,
TInt &aAscent,
TInt &aDescent
)const

GetCursor ( const TTmDocPos &, TTmCursorPlacement, TTmLineInfo &, TPoint &, TInt &, TInt &, TInt & )

IMPORT_C TBoolGetCursor(const TTmDocPos &aDocPos,
TTmCursorPlacementaPlacement,
TTmLineInfo &aLineInfo,
TPoint &aOrigin,
TInt &aWidth,
TInt &aAscent,
TInt &aDescent
)const

Deprecated7.0s

GetDisplayedText ( TInt, TDes &, TInt & )

IMPORT_C TBoolGetDisplayedText(TIntaLineNumber,
TDes &aText,
TInt &aNeeded
)const

Return the displayed form of the text for a particular line. See CTmLayout::GetDisplayedText for details.

GetMinimumLayoutSizeL ( TInt, TSize & )

IMPORT_C voidGetMinimumLayoutSizeL(TIntaWrapWidth,
TSize &aSize
)const

Get the minimum size of the formatted text. See CTmTextLayout::GetMinimumLayoutSizeL for details.

GetMinimumLayoutSizeL ( TInt, TBool, TSize & )

IMPORT_C voidGetMinimumLayoutSizeL(TIntaWrapWidth,
TBoolaAllowLegalLineBreaksOnly,
TSize &aSize
)const

Get the minimum size of the formatted text. See CTmTextLayout::GetMinimumLayoutSizeL for details.

GetNextPosLeftWithDisambiguation ( const TTmDocPosSpec &, TTmPosInfo2 &, TTmPosInfo2 & )

IMPORT_C TBoolGetNextPosLeftWithDisambiguation(const TTmDocPosSpec &aDocPos,
TTmPosInfo2 &aPosLeft,
TTmPosInfo2 &aPosRight
)const

GetNextPosRightWithDisambiguation ( const TTmDocPosSpec &, TTmPosInfo2 &, TTmPosInfo2 & )

IMPORT_C TBoolGetNextPosRightWithDisambiguation(const TTmDocPosSpec &aDocPos,
TTmPosInfo2 &aPosLeft,
TTmPosInfo2 &aPosRight
)const

GetNextVisualCursorPos ( const TTmDocPosSpec &, TTmPosInfo2 &, TBool )

IMPORT_C TBoolGetNextVisualCursorPos(const TTmDocPosSpec &aDocPos,
TTmPosInfo2 &aInfo,
TBoolaToLeft
)const

GetNextVisualCursorPos ( const TTmDocPos &, TTmPosInfo &, TBool )

IMPORT_C TBoolGetNextVisualCursorPos(const TTmDocPos &aDocPos,
TTmPosInfo &aInfo,
TBoolaToLeft
)const

deprecated 7.0s

HorizontalExtremes ( TInt &, TInt &, TInt, TInt )

IMPORT_C voidHorizontalExtremes(TInt &aLeft,
TInt &aRight,
TIntaTopY = 0,
TIntaBottomY =  KMaxTInt
)const

InvertLayout ( CGraphicsContext &, const TPoint &, TInt, TInt )

IMPORT_C voidInvertLayout(CGraphicsContext &aGc,
const TPoint &aTopLeft,
TIntaStartDocPos,
TIntaEndDocPos
)

LayoutHeight ( )

IMPORT_C TIntLayoutHeight()const

Return the height in pixels of the formatted text.

LayoutWidth ( )

IMPORT_C TIntLayoutWidth()const

Return the width in pixels of the formatted text, not including paragraph labels if present.

LineNumberToLine ( TInt, TTmLineInfo & )

IMPORT_C TBoolLineNumberToLine(TIntaLineNumber,
TTmLineInfo &aLineInfo
)const

Lines ( )

IMPORT_C TIntLines()const

Return the number of lines in the text.

ParNumberToLine ( TInt, TInt, TTmLineInfo & )

IMPORT_C TBoolParNumberToLine(TIntaParNumber,
TIntaLineInPar,
TTmLineInfo &aLineInfo
)const

Paragraphs ( )

IMPORT_C TIntParagraphs()const

Return the number of paragraphs in the text.

StartChar ( )

IMPORT_C TIntStartChar()const

Return the first formatted character.

WidthOfWidestLine ( TInt, TInt )

IMPORT_C TIntWidthOfWidestLine(TIntaTop = 0,
TIntaBottom =  KMaxTInt
)const

YPosToLine ( TInt, TTmLineInfo & )

IMPORT_C TBoolYPosToLine(TIntaYPos,
TTmLineInfo &aLineInfo
)const
© Nokia 2005.