1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 

    16 #ifndef __CALPROGRESSCALLBACK_H__

    17 #define __CALPROGRESSCALLBACK_H__

    18 

    19 #include <e32def.h>

    20 

    21 class MCalProgressCallBack

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

    23 

    24 When a long-running operation is carried out on the instance view or the entry 

    25 view, this class is used to signal its progress, and when the function is complete.

    26 

    27 @publishedAll

    28 @released

    29 */

    30 	{

    31 public:

    32 

    33 	/** Progress callback.

    34 	

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

    36 	

    37 	@param aPercentageCompleted The percentage complete. */

    38 	virtual void Progress(TInt aPercentageCompleted) = 0;

    39 	

    40 	/** Progress callback.

    41 	

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

    43 	

    44 	@param aError The error if the operation failed, or KErrNone if successful. */

    45 	virtual void Completed(TInt aError) = 0;

    46 	

    47 	/** 

    48     Asks the observing class whether progress callbacks are required. This

    49     is called once only to check if callbacks are enabled.

    50 	

    51 	@return If the observing class returns EFalse, then the Progress() function will not be called. 

    52     */

    53 	virtual TBool NotifyProgress() = 0;

    54 	};

    55 	

    56 #endif // __CALPROGRESSCALLBACK_H__