epoc32/include/calprogresscallback.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
--- a/epoc32/include/calprogresscallback.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/calprogresscallback.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,54 @@
-calprogresscallback.h
+// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// 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
+// which accompanies this distribution, and is available
+// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+#ifndef __CALPROGRESSCALLBACK_H__
+#define __CALPROGRESSCALLBACK_H__
+
+class MCalProgressCallBack
+/** 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.
+
+@publishedAll
+@released
+*/
+	{
+public:
+
+	/** Progress callback.
+	
+	This calls the observing class with the percentage complete of the current operation.
+	
+	@param aPercentageCompleted The percentage complete. */
+	virtual void Progress(TInt aPercentageCompleted) = 0;
+	
+	/** Progress callback.
+	
+	This calls the observing class when the current operation is finished.
+	
+	@param aError The error if the operation failed, or KErrNone if successful. */
+	virtual void Completed(TInt aError) = 0;
+	
+	/** 
+    Asks the observing class whether progress callbacks are required. This
+    is called once only to check if callbacks are enabled.
+	
+	@return If the observing class returns EFalse, then the Progress() function will not be called. 
+    */
+	virtual TBool NotifyProgress() = 0;
+	};
+	
+#endif // __CALPROGRESSCALLBACK_H__