Class CSheetEngine

class CSheetEngine : public CBase;

Description

Spreadsheet application engine.

Derivation

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

• CSheetEngine - Spreadsheet application engine.

Members

Defined in CSheetEngine:

• CSheetEngine()Default constructor.
• Compress()Attempts to compress all data storage.
• ConstructL()Second-phase constructor.
• ConstructL(CShgCellAdditionalData *)Second-phase constructor, specifying a resource file.
• ConstructL(CShgCellAdditionalData *,const TDesC &)Second-phase constructor, specifying additional cell formatting data and a resou...
• ConstructL(const TDesC &)Second-phase constructor, specifying a resource file.
• CreateCellFromTextL(TShgCell &,const TDesC &,const CShgWorkSheet *)Initialises a cell with content specified in a descriptor.
• CurrentWorkSheet()constGets the engine's current worksheet.
• DisableUndoAndRedo()Sets the engine to not provide support for undoing and redoing operations.
• EForceText
• ERedoDataAvailable
• EUndoDataAvailable
• EndEditOperationL(TShgError)Marks the end of an edit operation.
• ExistsCircularDependency()constTests if circular dependency exists between cells.
• FormulaViewer()constGets the engine's formula viewer.
• GetAnyCircularDependency(TBool &,TInt &,TCellRef &)constFinds a cell causing a circular dependency.
• HasChanged()constTests if the engine has performed updates that the client (e.g. UI) may need to ...
• IsRedoAvailable()constTests if the engine supports redo.
• IsUndoAvailable()constTests if the engine supports undo.
• LocaleHasChanged()Informs the engine that the system locale has changed.
• MarkUnchanged()Reset the engine's changed flag.
• NameSet()constGets the engine's name set.
• NewEmptyL(const CSheetEngine *)Allocates and constructs a new spreadsheet engine object, specifying an existing...
• NewL()Allocates and constructs a new spreadsheet engine object.
• NewL(CShgCellAdditionalData *)Allocates and constructs a new spreadsheet engine object, specifying additional ...
• NewL(CShgCellAdditionalData *,const TDesC &)Allocates and constructs a new spreadsheet engine object, specifying additional ...
• NewL(const TDesC &)Allocates and constructs a new spreadsheet engine object, specifying a resource ...
• NewLC()Allocates and constructs a new spreadsheet engine object, leaving the object on ...
• RecalculateL()Recalculates the spreadsheet.
• RecalculationInProgress()constTests if a background recalculation is in progress.
• RecalculationNeeded()constTests if the spreadsheet needs recalculating.
• RecalculationToBeDoneAutomatically()constTests if the engine automatically recalculates the spreadsheet when required.
• RecalculationToBeDoneInBackground()constTests if the engine recalculates the spreadsheet in the background, as a low pri...
• RedoOperationL()Redoes the last edit operation.
• Reset()Resets the engine to default values.
• RestoreL(const CStreamStore &,TStreamId)Restores the engine.
• SetCallBackAPI(MShgCallBackAPI *)Sets a callback object, so that the engine can inform the client of events.
• SetCurrentWorkSheet(const TDesC &)Sets the engine's current worksheet.
• SetRecalculationToBeDoneAutomatically(TBool)Sets whether the engine should automatically recalculate the spreadsheet when re...
• SetRecalculationToBeDoneInBackgroundL(TBool)Sets whether the engine should recalculate the spreadsheet in the background, as...
• SetTemplateAdditionalDataL(CShgCellAdditionalData *)Sets default additional cell formatting data.
• ShgCellAsText(TDes &,const TShgCell &)constGets the cell contents as a descriptor.
• ShgCellAsText(TDes &,const TShgCell &,TInt)constGets the cell contents as a descriptor, specifying the cell's work sheet.
• StartEditOperation()Marks the start of an edit operation.
• StoreL(CStreamStore &)constStores the engine.
• SyntaxErrorPos()constGets the position where a formula syntax error has been detected.
• TCleanupStackableRollBack
• TemplateAdditionalData()constGets default additional cell formatting data.
• UndoOperationL()Undoes the last edit operation.
• WorkBook()constGets the engine's workbook.
• anonymous
• anonymous
• ~CSheetEngine()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...

IMPORT_C virtual ~CSheetEngine();

Description

Destructor.

IMPORT_C static CSheetEngine* NewL();

Description

Allocates and constructs a new spreadsheet engine object.

Return value

IMPORT_C static CSheetEngine* NewLC();

Description

Allocates and constructs a new spreadsheet engine object, leaving the object on the cleanup stack.

Return value

IMPORT_C static CSheetEngine* NewL(CShgCellAdditionalData *aAdditionalData);

Description

Allocates and constructs a new spreadsheet engine object, specifying additional cell formatting data.

Parameters

Return value

IMPORT_C static CSheetEngine* NewL(CShgCellAdditionalData *aAdditionalData, const TDesC &aResourceFileName);

Description

Allocates and constructs a new spreadsheet engine object, specifying additional cell formatting data and a resource file.

The engine's resource file specifies text for formulae and errors.

Parameters

Return value

IMPORT_C static CSheetEngine* NewL(const TDesC &aResourceFileName);

Description

Allocates and constructs a new spreadsheet engine object, specifying a resource file.

The engine's resource file specifies text for formulae and errors.

Parameters

Return value

protected: IMPORT_C CSheetEngine();

Description

Default constructor.

protected: IMPORT_C void ConstructL();

Description

Second-phase constructor.

protected: IMPORT_C void ConstructL(CShgCellAdditionalData *aAdditionalData);

Description

Second-phase constructor, specifying a resource file.

Parameters

protected: IMPORT_C void ConstructL(CShgCellAdditionalData *aAdditionalData, const TDesC &aResourceFileName);

Description

Second-phase constructor, specifying additional cell formatting data and a resource file.

Parameters

protected: IMPORT_C void ConstructL(const TDesC &aResourceFileName);

Description

Second-phase constructor, specifying a resource file.

Parameters

IMPORT_C static CSheetEngine* NewEmptyL(const CSheetEngine *aSheetEngine);

Description

Allocates and constructs a new spreadsheet engine object, specifying an existing spreadsheet engine as a template.

Parameters

Return value

IMPORT_C void SetCallBackAPI(MShgCallBackAPI *aCallBackAPI);

Description

Sets a callback object, so that the engine can inform the client of events.

Parameters

IMPORT_C void Reset();

Description

Resets the engine to default values.

IMPORT_C void LocaleHasChanged();

Description

Informs the engine that the system locale has changed.

IMPORT_C void Compress();

Description

Attempts to compress all data storage.

IMPORT_C TBool HasChanged() const;

Description

Tests if the engine has performed updates that the client (e.g. UI) may need to get.

Once all updates have been processed, use CSheetEngine::MarkUnchanged() to reset the changed flag.

Return value

IMPORT_C void MarkUnchanged();

Description

Reset the engine's changed flag.

IMPORT_C TStreamId StoreL(CStreamStore &aStore) const;

Description

Stores the engine.

Parameters

Return value

IMPORT_C void RestoreL(const CStreamStore &aStore, TStreamId aId);

Description

Restores the engine.

Parameters

IMPORT_C TShgError CreateCellFromTextL(TShgCell &aCell, const TDesC &aText, const CShgWorkSheet *aWorkSheet);

Description

Initialises a cell with content specified in a descriptor.

The function attempts to parse the descriptor content to set the cell type and content.

Parameters

Return value

IMPORT_C void ShgCellAsText(TDes &aDes, const TShgCell &aShgCell) const;

Description

Gets the cell contents as a descriptor.

Parameters

IMPORT_C void ShgCellAsText(TDes &aDes, const TShgCell &aShgCell, TInt aWorkSheetNo) const;

Description

Gets the cell contents as a descriptor, specifying the cell's work sheet.

Parameters

IMPORT_C void SetRecalculationToBeDoneAutomatically(TBool aRecalculationToBeDoneAutomatically);

Description

Sets whether the engine should automatically recalculate the spreadsheet when required.

Parameters

IMPORT_C TBool RecalculationToBeDoneAutomatically() const;

Description

Tests if the engine automatically recalculates the spreadsheet when required.

Return value

IMPORT_C void SetRecalculationToBeDoneInBackgroundL(TBool aRecalculationToBeDoneInBackground);

Description

Sets whether the engine should recalculate the spreadsheet in the background, as a low priority active object, or synchronously.

Parameters

IMPORT_C TBool RecalculationToBeDoneInBackground() const;

Description

Tests if the engine recalculates the spreadsheet in the background, as a low priority active object, or synchronously.

Return value

IMPORT_C void RecalculateL();

Description

Recalculates the spreadsheet.

This can be a synchronous or asynchronous operation, depending on the value of CSheetEngine::RecalculationToBeDoneInBackground()const.

IMPORT_C TBool RecalculationNeeded() const;

Description

Tests if the spreadsheet needs recalculating.

Return value

IMPORT_C TBool RecalculationInProgress() const;

Description

Tests if a background recalculation is in progress.

Return value

IMPORT_C TBool ExistsCircularDependency() const;

Description

Tests if circular dependency exists between cells.

Return value

IMPORT_C void GetAnyCircularDependency(TBool &aKnown, TInt &aWorkSheetNo, TCellRef &aCoord) const;

Description

Finds a cell causing a circular dependency.

Parameters

IMPORT_C void DisableUndoAndRedo();

Description

Sets the engine to not provide support for undoing and redoing operations.

IMPORT_C TBool IsUndoAvailable() const;

Description

Tests if the engine supports undo.

Return value

IMPORT_C TBool IsRedoAvailable() const;

Description

Tests if the engine supports redo.

Return value

IMPORT_C CShgNameSet* NameSet() const;

Description

Gets the engine's name set.

Return value

IMPORT_C void SetCurrentWorkSheet(const TDesC &aName);

Description

Sets the engine's current worksheet.

Parameters

IMPORT_C CShgWorkSheet* CurrentWorkSheet() const;

Description

Gets the engine's current worksheet.

Return value

IMPORT_C CShgWorkBook* WorkBook() const;

Description

Gets the engine's workbook.

Return value

IMPORT_C TInt SyntaxErrorPos() const;

Description

Gets the position where a formula syntax error has been detected.

Return value

IMPORT_C CShgFormulaViewer* FormulaViewer() const;

Description

Gets the engine's formula viewer.

Return value

IMPORT_C void SetTemplateAdditionalDataL(CShgCellAdditionalData *aData);

Description

Sets default additional cell formatting data.

Parameters

IMPORT_C const CShgCellAdditionalData* TemplateAdditionalData() const;

Description

Gets default additional cell formatting data.

Return value

IMPORT_C void UndoOperationL();

Description

Undoes the last edit operation.

IMPORT_C void RedoOperationL();

Description

Redoes the last edit operation.

IMPORT_C void StartEditOperation();

Description

Marks the start of an edit operation.

IMPORT_C TShgError EndEditOperationL(TShgError aShgError);

Description

Marks the end of an edit operation.

Parameters

Return value

class TCleanupStackableRollBack : public TCleanupItem;

Description

Derivation

• TCleanupItem - ...

• CSheetEngine::TCleanupStackableRollBack - (No abstract)

Inherited from TCleanupItem:

• TCleanupItem(TCleanupOperation)Constructs the object with a cleanup operation.
• TCleanupItem(TCleanupOperation,TAny *)Constructs the object with a cleanup operation and a pointer to the object to be...

n/a

Description

n/a

Description