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.
williamr@2
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __CALPROGRESSCALLBACK_H__
williamr@2
    17
#define __CALPROGRESSCALLBACK_H__
williamr@2
    18
williamr@4
    19
#include <e32def.h>
williamr@4
    20
williamr@2
    21
class MCalProgressCallBack
williamr@2
    22
/** A call back class to show the progress of long-running operations. 
williamr@2
    23
williamr@2
    24
When a long-running operation is carried out on the instance view or the entry 
williamr@2
    25
view, this class is used to signal its progress, and when the function is complete.
williamr@2
    26
williamr@2
    27
@publishedAll
williamr@2
    28
@released
williamr@2
    29
*/
williamr@2
    30
	{
williamr@2
    31
public:
williamr@2
    32
williamr@2
    33
	/** Progress callback.
williamr@2
    34
	
williamr@2
    35
	This calls the observing class with the percentage complete of the current operation.
williamr@2
    36
	
williamr@2
    37
	@param aPercentageCompleted The percentage complete. */
williamr@2
    38
	virtual void Progress(TInt aPercentageCompleted) = 0;
williamr@2
    39
	
williamr@2
    40
	/** Progress callback.
williamr@2
    41
	
williamr@2
    42
	This calls the observing class when the current operation is finished.
williamr@2
    43
	
williamr@2
    44
	@param aError The error if the operation failed, or KErrNone if successful. */
williamr@2
    45
	virtual void Completed(TInt aError) = 0;
williamr@2
    46
	
williamr@2
    47
	/** 
williamr@2
    48
    Asks the observing class whether progress callbacks are required. This
williamr@2
    49
    is called once only to check if callbacks are enabled.
williamr@2
    50
	
williamr@2
    51
	@return If the observing class returns EFalse, then the Progress() function will not be called. 
williamr@2
    52
    */
williamr@2
    53
	virtual TBool NotifyProgress() = 0;
williamr@2
    54
	};
williamr@2
    55
	
williamr@2
    56
#endif // __CALPROGRESSCALLBACK_H__