Class CShgFormulaViewer

class CShgFormulaViewer : public CBase;

Description

Handles conversion of formula tokens (TFormulaToken) into localised strings suitable for display to users.

Derivation

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

• CShgFormulaViewer - Handles conversion of formula tokens (TFormulaToken) into localised strings suitable for display to users

Members

Defined in CShgFormulaViewer:
EFnDatabase, EFnDateAndTime, EFnError, EFnFinancial, EFnInformation, EFnLogical, EFnLookUp, EFnMathematical, EFnStatistical, EFnText, EFormulaEqualsSign, FirstFunctionNo(), FormulaEvaluator(), FunctionName(), FunctionType(), GetTextFormulaL(), GetTokenFormulaL(), InitWithTextFormula(), InitWithTokenFormula(), LastFunctionNo(), NewL(), NoArguments(), TFunctionType, anonymous, sFunction, sSkipToken, ~CShgFormulaViewer()

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

virtual ~CShgFormulaViewer();

Description

Destructor.

static IMPORT_C CShgFormulaViewer *NewL(const CShgNameSet *aNameSet, const CShgWorkBook *aWorkBook, CSheetEngine *aSheetEngine, const TDesC &aResourceFile);

Description

Allocates and constructs a new formula viewer.

Parameters

const CShgNameSet *aNameSet Name set to use const CShgWorkBook *aWorkBook Workbook to use CSheetEngine *aSheetEngine Spreadsheet engine to use const TDesC &aResourceFile Resource file from which to read localised strings for formula tokens

Return value

CShgFormulaViewer * New formula viewer object

IMPORT_C void InitWithTokenFormula(const TCellRef &aCell, const TDesC8 *aFormula);

Description

Initialises the viewer with formula data.

!! this is very inefficient

!! unfortunately size of this is being used as a flag!!!

Parameters

const TCellRef &aCell Position to use to resolve relative cell references const TDesC8 *aFormula Formula data

IMPORT_C void InitWithTextFormula(const TCellRef &aCell, const TDesC &aText);

Description

Initialises the viewer with text data.

Parameters

const TCellRef &aCell Position to use to resolve relative cell references const TDesC &aText Formula text

IMPORT_C const TPtrC GetTextFormulaL();

Description

Gets a text representation of a formula.

The function converts formula data to text if necessary.

Return value

const TPtrC Text representation of a formula

IMPORT_C const TPtrC8 GetTokenFormulaL(TShgError &aError);

Description

Gets a token representation of a formula.

The function converts formula data to tokens if necessary.

Parameters

TShgError &aError On return, EShgNoError if function succeeds

Return value

const TPtrC8 Token representation of a formula

inline CShgFormulaEvaluator *FormulaEvaluator() const;

Description

Gets a formula evaluator object.

Return value

CShgFormulaEvaluator * Formula evaluator object

IMPORT_C TInt FirstFunctionNo() const;

Description

Gets the first token (as ordered in TFormulaToken) that represents a function.

Return value

TInt First function token

IMPORT_C TInt LastFunctionNo() const;

Description

Gets the last token (as ordered in TFormulaToken) that represents a function.

Return value

TInt Last function token

IMPORT_C const TPtrC FunctionName(TFormulaToken aToken) const;

Description

Gets a localised string for a specified formula token.

Parameters

TFormulaToken aToken Formula token

Return value

const TPtrC String name for aToken

IMPORT_C TFunctionType FunctionType(TFormulaToken aToken) const;

Description

Gets the type (financial, statistical, etc.) of a specified function.

Parameters

TFormulaToken aToken Function formula token

Return value

TFunctionType Type of aToken

IMPORT_C TInt NoArguments(TFormulaToken aToken) const;

Description

Gets the number of arguments required for a specified function.

Parameters

TFormulaToken aToken Function formula token

Return value

TInt Number of arguments required for aFunction

n/a

Description

Character definition.

EFormulaEqualsSign Character for the formula equals sign.

TFunctionType

Description

Types of function.

EFnError Error. EFnFinancial Financial. EFnDateAndTime Date/time. EFnMathematical Mathematical. EFnStatistical Statistical. EFnLookUp Look-up. EFnText Text. EFnLogical Logical. EFnInformation Information. EFnDatabase Database.

const TUint8 sSkipToken;

Description

const CShgFormulaEvaluator::TFunction sFunction;

Description