MParser Class Reference

#include <mparser.h>

class MParser
Public Member Functions
pure virtual voidActivateThisTextL(const CRichText &, TInt, TInt)
virtual IMPORT_C TBoolConfirmCursorOverTag(const CRichText &, TInt, TInt, TInt)
pure virtual const TDesC &CreateDoItText(const CRichText &, TInt, TInt)
virtual IMPORT_C voidGetRecogniseFormat(TCharFormat &)
virtual IMPORT_C voidGetRolloverFormat(TCharFormat &)
virtual IMPORT_C voidMParser_Reserved_2()
pure virtual TBool ParseThisText(const CRichText &, TBool, TInt, TInt, TInt &, TInt &)
virtual IMPORT_C TBoolReformatOnRecognise()
virtual IMPORT_C TBoolReformatOnRollover()
pure virtual voidRelease()

Detailed Description

Implement ParseThisText() in order to parse text

Member Function Documentation

ActivateThisTextL ( const CRichText &, TInt, TInt )

voidActivateThisTextL(const CRichText &aTextObj,
TIntaStartText,
TIntaLength
)[pure virtual]

ConfirmCursorOverTag ( const CRichText &, TInt, TInt, TInt )

IMPORT_C TBoolConfirmCursorOverTag(const CRichText &aTextObj,
TIntaTagStart,
TIntaTagLen,
TIntaCurPos
)[virtual]

This confirmation routine is called by the parsing framework when it's logic determines the cursor is over a tag. It gives the parser a chance to override the default cursor-tag rollover matching. This is not necessary if the default behaviour is acceptable. It is called from the CRichText::CursorOverTag() when the framework tests for format redraw when over a tag and CRichText::OverrideFormatForParsersIfApplicable() when Tagma is formatting text.

Parameters
aTextObjA reference to the text document tag is within.
aTagStartThe document position of the first tag character.
aTagLenThe number of characters in the tag.
aCurPosThe cursor position used in calculation of calling routines.
Return Value
TBool ETrue if parser agrees cursor over a tag, EFalse otherwise.

CreateDoItText ( const CRichText &, TInt, TInt )

const TDesC &CreateDoItText(const CRichText &aTextObj,
TIntaStartText,
TIntaLength
)[pure virtual]

GetRecogniseFormat ( TCharFormat & )

IMPORT_C voidGetRecogniseFormat(TCharFormat &aFormat)[virtual]

GetRolloverFormat ( TCharFormat & )

IMPORT_C voidGetRolloverFormat(TCharFormat &aFormat)[virtual]

MParser_Reserved_2 ( )

IMPORT_C voidMParser_Reserved_2()[virtual]

ParseThisText ( const CRichText &, TBool, TInt, TInt, TInt &, TInt & )

TBool ParseThisText(const CRichText &aTextObj,
TBoolaAllowBack,
TIntaStartScan,
TIntaScanLength,
TInt &aStartTag,
TInt &aTagLength
)[pure virtual]

ReformatOnRecognise ( )

IMPORT_C TBoolReformatOnRecognise()const [virtual]

ReformatOnRollover ( )

IMPORT_C TBoolReformatOnRollover()const [virtual]

Release ( )

voidRelease()[pure virtual]