1 calprogresscallback.h

     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 class MCalProgressCallBack

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

    21 

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

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

    24 

    25 @publishedAll

    26 @released

    27 */

    28 	{

    29 public:

    30 

    31 	/** Progress callback.

    32 	

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

    34 	

    35 	@param aPercentageCompleted The percentage complete. */

    36 	virtual void Progress(TInt aPercentageCompleted) = 0;

    37 	

    38 	/** Progress callback.

    39 	

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

    41 	

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

    43 	virtual void Completed(TInt aError) = 0;

    44 	

    45 	/** 

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

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

    48 	

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

    50     */

    51 	virtual TBool NotifyProgress() = 0;

    52 	};

    53 	

    54 #endif // __CALPROGRESSCALLBACK_H__