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(const TDesC &)constDisplays a brief message.
• GetCurrentCell(TInt &,TCellRef &)constGets the client's current cell (e.g. the one with current UI focus).
• MShgCallBackAPI_Reserved1()
• NeedToReportCellChanged(TInt,const TCellRef &)constQueries if the engine should notify the interface of changes to the specified ce...
• ReportCellChanged(TInt,const TCellRef &)!! only needed for CELLPOINTER function
• ReportCircularDependencyExists(TBool)Reports that the engine has discovered a circular dependency while performing a ...
• ReportRecalculationInProgress(TBool)Reports that the engine is recalculating, or has finished recalculating, the spr...
• ReportRecalculationNeeded(TBool)Reports that the engine needs/does not need to recalculate the spreadsheet.

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

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 MShgCallBackAPI::NeedToReportCellChanged(TInt,const TCellRef &)const is enabled.

Parameters

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 MShgCallBackAPI::ReportCellChanged(TInt,const TCellRef &).

Parameters

Return value

virtual void ReportRecalculationNeeded(TBool aNeeded)=0;

Description

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

Parameters

virtual void ReportRecalculationInProgress(TBool aInProgress)=0;

Description

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

Parameters

virtual void ReportCircularDependencyExists(TBool aExists)=0;

Description

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

Parameters

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

Description

Displays a brief message.

This is only used for debug purposes.

Parameters

private: IMPORT_C virtual void MShgCallBackAPI_Reserved1();

Description