epoc32/include/calprogresscallback.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
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@2
     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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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@2
    19
class MCalProgressCallBack
williamr@2
    20
/** A call back class to show the progress of long-running operations. 
williamr@2
    21
williamr@2
    22
When a long-running operation is carried out on the instance view or the entry 
williamr@2
    23
view, this class is used to signal its progress, and when the function is complete.
williamr@2
    24
williamr@2
    25
@publishedAll
williamr@2
    26
@released
williamr@2
    27
*/
williamr@2
    28
	{
williamr@2
    29
public:
williamr@2
    30
williamr@2
    31
	/** Progress callback.
williamr@2
    32
	
williamr@2
    33
	This calls the observing class with the percentage complete of the current operation.
williamr@2
    34
	
williamr@2
    35
	@param aPercentageCompleted The percentage complete. */
williamr@2
    36
	virtual void Progress(TInt aPercentageCompleted) = 0;
williamr@2
    37
	
williamr@2
    38
	/** Progress callback.
williamr@2
    39
	
williamr@2
    40
	This calls the observing class when the current operation is finished.
williamr@2
    41
	
williamr@2
    42
	@param aError The error if the operation failed, or KErrNone if successful. */
williamr@2
    43
	virtual void Completed(TInt aError) = 0;
williamr@2
    44
	
williamr@2
    45
	/** 
williamr@2
    46
    Asks the observing class whether progress callbacks are required. This
williamr@2
    47
    is called once only to check if callbacks are enabled.
williamr@2
    48
	
williamr@2
    49
	@return If the observing class returns EFalse, then the Progress() function will not be called. 
williamr@2
    50
    */
williamr@2
    51
	virtual TBool NotifyProgress() = 0;
williamr@2
    52
	};
williamr@2
    53
	
williamr@2
    54
#endif // __CALPROGRESSCALLBACK_H__