epoc32/include/app/calprogresscallback.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/calprogresscallback.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,54 @@
     1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __CALPROGRESSCALLBACK_H__
    1.20 +#define __CALPROGRESSCALLBACK_H__
    1.21 +
    1.22 +class MCalProgressCallBack
    1.23 +/** A call back class to show the progress of long-running operations. 
    1.24 +
    1.25 +When a long-running operation is carried out on the instance view or the entry 
    1.26 +view, this class is used to signal its progress, and when the function is complete.
    1.27 +
    1.28 +@publishedAll
    1.29 +@released
    1.30 +*/
    1.31 +	{
    1.32 +public:
    1.33 +
    1.34 +	/** Progress callback.
    1.35 +	
    1.36 +	This calls the observing class with the percentage complete of the current operation.
    1.37 +	
    1.38 +	@param aPercentageCompleted The percentage complete. */
    1.39 +	virtual void Progress(TInt aPercentageCompleted) = 0;
    1.40 +	
    1.41 +	/** Progress callback.
    1.42 +	
    1.43 +	This calls the observing class when the current operation is finished.
    1.44 +	
    1.45 +	@param aError The error if the operation failed, or KErrNone if successful. */
    1.46 +	virtual void Completed(TInt aError) = 0;
    1.47 +	
    1.48 +	/** 
    1.49 +    Asks the observing class whether progress callbacks are required. This
    1.50 +    is called once only to check if callbacks are enabled.
    1.51 +	
    1.52 +	@return If the observing class returns EFalse, then the Progress() function will not be called. 
    1.53 +    */
    1.54 +	virtual TBool NotifyProgress() = 0;
    1.55 +	};
    1.56 +	
    1.57 +#endif // __CALPROGRESSCALLBACK_H__