epoc32/include/app/calprogresscallback.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h) This is the epoc32/include tree with the "platform" subtrees removed, and all but a selected few mbg and rsg files removed.

// 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 "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#ifndef __CALPROGRESSCALLBACK_H__
#define __CALPROGRESSCALLBACK_H__

#include <e32def.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__