Class MShgCallBackAPI

class MShgCallBackAPI;

Description

Spreadsheet engine client callback interface.

The client implements this interface to receive notifications from the engine of various events.

Members

Defined in MShgCallBackAPI:
DisplayInfoMessage(), GetCurrentCell(), MShgCallBackAPI_Reserved1(), NeedToReportCellChanged(), ReportCellChanged(), ReportCircularDependencyExists(), ReportRecalculationInProgress(), ReportRecalculationNeeded()

virtual void GetCurrentCell(TInt &aWorkSheetNo, TCellRef &aCellRef) const=0;

Description

Gets the client's current cell (e.g. the one with current UI focus).

Parameters

TInt &aWorkSheetNo On return, index of the current worksheet TCellRef &aCellRef On return, current cell

virtual void ReportCellChanged(TInt aWorkSheetNo, const TCellRef &aCellRef)=0;

Description

!! only needed for CELLPOINTER function

Reports that a specified cell has been changed.

This is only called if NeedToReportCellChanged() is enabled.

Parameters

TInt aWorkSheetNo Index of the worksheet changed const TCellRef &aCellRef Cell changed

virtual TBool NeedToReportCellChanged(TInt aWorkSheetNo, const TCellRef &aCellRef) const=0;

Description

Queries if the engine should notify the interface of changes to the specified cell.

Changes are reported through ReportCellChanged().

Parameters

TInt aWorkSheetNo Index of the worksheet changed const TCellRef &aCellRef Cell to report changes on

Return value

TBool True if changes should be reported, else false

virtual void ReportRecalculationNeeded(TBool aNeeded)=0;

Description

Reports that the engine needs/does not need to recalculate the spreadsheet.

Parameters

TBool aNeeded True if the engine needs to recalculate the spreadsheet

virtual void ReportRecalculationInProgress(TBool aInProgress)=0;

Description

Reports that the engine is recalculating, or has finished recalculating, the spreadsheet.

Parameters

TBool aInProgress True if the engine is recalculating the spreadsheet, false if recalculating is finished

virtual void ReportCircularDependencyExists(TBool aExists)=0;

Description

Reports that the engine has discovered a circular dependency while performing a recalculation.

Parameters

TBool aExists True if the engine has discovered a circular dependency, false if a previous circular dependency no longer exists

virtual void DisplayInfoMessage(const TDesC &aMessage) const=0;

Description

Displays a brief message.

This is only used for debug purposes.

Parameters

const TDesC &aMessage Message to display

private: virtual IMPORT_C void MShgCallBackAPI_Reserved1();

Description