Class CShgFormulaTextLexer

Interface status:

deprecated

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()Advances to the next token.
• LexCellOrRange()Tests if a cell or range was lexed.
• NewL(const CShgNameSet *,const CShgWorkBook *,const CShgFormulaViewer *)Allocates and constructs a formula lexer.
• Offset()constGets the offset of the next character position from the start of the string.
• Start(const TDesC &,const TCellRef &)Initialises the lexer with a specified formula string.
• Token()constGets the current token.
• UnGetToken(const SLexToken &)Sets the current token type to ETokDmEOL.
• ~CShgFormulaTextLexer()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Interface status:

deprecated

Inherited from: CShgFormulaTextLexer

IMPORT_C virtual ~CShgFormulaTextLexer();

Description

Destructor.

Interface status:

deprecated

Inherited from: CShgFormulaTextLexer

IMPORT_C static 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

Interface status:

deprecated

Inherited from: CShgFormulaTextLexer

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

Description

Initialises the lexer with a specified formula string.

Parameters

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

Interface status:

deprecated

Inherited from: CShgFormulaTextLexer

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

Interface status:

deprecated

Inherited from: CShgFormulaTextLexer

IMPORT_C const SLexToken& Token() const;

Description

Gets the current token.

Return value

const SLexToken & Current token

Interface status:

deprecated

Inherited from: CShgFormulaTextLexer

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

Interface status:

deprecated

Inherited from: CShgFormulaTextLexer

IMPORT_C TInt Offset() const;

Description

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

Return value

TInt Offset

Interface status:

deprecated

Inherited from: CShgFormulaTextLexer

IMPORT_C TBool LexCellOrRange();

Description

Tests if a cell or range was lexed.

Return value

TBool True if a range was lexed, false otherwise