|
sl@0
|
1 |
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
// This file contains the definition of the class MTransitionObserver
|
|
sl@0
|
15 |
//
|
|
sl@0
|
16 |
//
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
/**
|
|
sl@0
|
19 |
@test
|
|
sl@0
|
20 |
*/
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#ifndef __TRANSITIONOBSERVER_H__
|
|
sl@0
|
23 |
#define __TRANSITIONOBSERVER_H__
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
class CTransition;
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
/**
|
|
sl@0
|
28 |
@internalAll
|
|
sl@0
|
29 |
Comments : Provides a callback method to the CUnitTest to indicate that the
|
|
sl@0
|
30 |
specified transition has completed an asynchronous function.
|
|
sl@0
|
31 |
*/
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
class MTransitionObserver
|
|
sl@0
|
34 |
{
|
|
sl@0
|
35 |
public:
|
|
sl@0
|
36 |
/**
|
|
sl@0
|
37 |
@fn virtual void SetCurrentTransition(CTransition& aTransition) = 0
|
|
sl@0
|
38 |
Intended Usage : Passes the transition which is about to run.
|
|
sl@0
|
39 |
This allows transition information can be retrieved and
|
|
sl@0
|
40 |
Repeat() can then be called on the transition.
|
|
sl@0
|
41 |
@since 7.0
|
|
sl@0
|
42 |
@param aTransition The transition to set as current
|
|
sl@0
|
43 |
@return void
|
|
sl@0
|
44 |
@pre None
|
|
sl@0
|
45 |
@post aTransition will be stored as a pointer to the currently executing transition
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
|
|
sl@0
|
48 |
virtual void SetCurrentTransition(CTransition& aTransition) = 0;
|
|
sl@0
|
49 |
|
|
sl@0
|
50 |
/**
|
|
sl@0
|
51 |
@fn virtual void Complete(CTransition& aTransition, TInt aAsyncPostCheckError) = 0
|
|
sl@0
|
52 |
Intended Usage : Called to indicate that an asynchronous function on the specified
|
|
sl@0
|
53 |
transition has completed.
|
|
sl@0
|
54 |
@since 7.0
|
|
sl@0
|
55 |
@param aTransition The transition which has completed
|
|
sl@0
|
56 |
@param aAsyncPostCheckError An error code from the second phase of post-condition
|
|
sl@0
|
57 |
validation done after the transition's asynchronous request had completed.
|
|
sl@0
|
58 |
Used for asynchronous transitions only - for synchronous transitions, 2-phase
|
|
sl@0
|
59 |
post-condition checking does not apply, and a value of KErrNone is supplied.
|
|
sl@0
|
60 |
@pre None
|
|
sl@0
|
61 |
@post Depends on observer implementation. For example, aTransition has completed,
|
|
sl@0
|
62 |
therefore if all transitions have completed the unit test is complete.
|
|
sl@0
|
63 |
*/
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
virtual void Complete(CTransition& aTransition, TInt aAsyncPostCheckError) = 0;
|
|
sl@0
|
66 |
};
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
#endif
|