MCalProgressCallBack Class Reference

#include <app/calprogresscallback.h>

class MCalProgressCallBack
Public Member Functions
pure virtual voidCompleted(TInt)
pure virtual TBool NotifyProgress()
pure virtual voidProgress(TInt)

Detailed Description

A call back class to show the progress of long-running operations.

When a long-running operation is carried out on the instance view or the entry view, this class is used to signal its progress, and when the function is complete.

Member Function Documentation

Completed ( TInt )

voidCompleted(TIntaError)[pure virtual]

Progress callback.

This calls the observing class when the current operation is finished.

ParameterDescription
aErrorThe error if the operation failed, or KErrNone if successful.

NotifyProgress ( )

TBool NotifyProgress()[pure virtual]

Asks the observing class whether progress callbacks are required. This is called once only to check if callbacks are enabled.

Returns: If the observing class returns EFalse, then the Progress() function will not be called.

Progress ( TInt )

voidProgress(TIntaPercentageCompleted)[pure virtual]

Progress callback.

This calls the observing class with the percentage complete of the current operation.

ParameterDescription
aPercentageCompletedThe percentage complete.