Class CShgFormulaTextLexer

class CShgFormulaTextLexer : public CBase;

Description

Breaks down a formula stored as text into formula tokens.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CShgFormulaTextLexer - Breaks down a formula stored as text into formula tokens

Members

Defined in CShgFormulaTextLexer:
GetNextTokenL(), LexCellOrRange(), NewL(), Offset(), Start(), Token(), UnGetToken(), ~CShgFormulaTextLexer()

Inherited from CBase:
Delete(), Extension_(), operator new()

virtual IMPORT_C ~CShgFormulaTextLexer();

Description

Destructor.

static IMPORT_C CShgFormulaTextLexer *NewL(const CShgNameSet *aNameSet, const CShgWorkBook *aWorkBook, const CShgFormulaViewer *aFormulaViewer);

Description

Allocates and constructs a formula lexer.

Parameters

const CShgNameSet *aNameSet Name set to use const CShgWorkBook *aWorkBook Workbook to use const CShgFormulaViewer *aFormulaViewer Formula viewer to use

Return value

CShgFormulaTextLexer * New formula viewer object

IMPORT_C void Start(const TDesC &aDes, const TCellRef &aCurrentCell);

Description

Initialises the lexer with a specified formula string.

Parameters

const TDesC &aDes Formula string to lex const TCellRef &aCurrentCell Position to use to resolve relative cell references

IMPORT_C TBool GetNextTokenL();

Description

Advances to the next token.

Return value

TBool True if the lexer has found a legal token. False if no legal token was found or the end of the string was reached

IMPORT_C const SLexToken &Token() const;

Description

Gets the current token.

Return value

const SLexToken & Current token

IMPORT_C void UnGetToken(const SLexToken &aToken);

Description

Sets the current token type to ETokDmEOL.

Parameters

const SLexToken &aToken Specifies the type to replace the current token type

IMPORT_C TInt Offset() const;

Description

Gets the offset of the next character position from the start of the string.

Return value

TInt Offset

IMPORT_C TBool LexCellOrRange();

Description

Tests if a cell or range was lexed.

Return value

TBool True if a range was lexed, false otherwise