uiacceltk/hitchcock/tsrc/alfperfapp/inc/alfperfappbasetestcasecontrol.h
author hgs
Wed, 03 Nov 2010 19:29:22 +0200
changeset 64 9f8c0686fb49
permissions -rw-r--r--
201044
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
64
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  CAlfPerfAppBaseTestCaseControl class definition.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef C_ALFPERFAPPBASETESTCASECONTROL_H
hgs
parents:
diff changeset
    20
#define C_ALFPERFAPPBASETESTCASECONTROL_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <e32base.h>
hgs
parents:
diff changeset
    23
#include <alf/alfcontrol.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
/**
hgs
parents:
diff changeset
    26
 *  CAlfPerfAppBaseTestCase class.
hgs
parents:
diff changeset
    27
 */
hgs
parents:
diff changeset
    28
/**
hgs
parents:
diff changeset
    29
 * Abstract image test case control.
hgs
parents:
diff changeset
    30
 */
hgs
parents:
diff changeset
    31
class CAlfPerfAppBaseTestCaseControl : public CAlfControl
hgs
parents:
diff changeset
    32
    {
hgs
parents:
diff changeset
    33
public:
hgs
parents:
diff changeset
    34
        
hgs
parents:
diff changeset
    35
    /**
hgs
parents:
diff changeset
    36
     * Constructor.
hgs
parents:
diff changeset
    37
     */
hgs
parents:
diff changeset
    38
    CAlfPerfAppBaseTestCaseControl();
hgs
parents:
diff changeset
    39
        
hgs
parents:
diff changeset
    40
    /**
hgs
parents:
diff changeset
    41
     * Destructor.
hgs
parents:
diff changeset
    42
     */
hgs
parents:
diff changeset
    43
    ~CAlfPerfAppBaseTestCaseControl();
hgs
parents:
diff changeset
    44
        
hgs
parents:
diff changeset
    45
    /**
hgs
parents:
diff changeset
    46
     * Base class constructor. Derived classes may
hgs
parents:
diff changeset
    47
     * override this, but base class needs to be called.
hgs
parents:
diff changeset
    48
     */
hgs
parents:
diff changeset
    49
    virtual void ConstructL( 
hgs
parents:
diff changeset
    50
        CAlfEnv& aEnv, TInt aCaseId, const TRect& aVisibleArea );
hgs
parents:
diff changeset
    51
        
hgs
parents:
diff changeset
    52
    /**
hgs
parents:
diff changeset
    53
     * Starts execution of the test case. By default,
hgs
parents:
diff changeset
    54
     * request status is stored to local variable.
hgs
parents:
diff changeset
    55
     */
hgs
parents:
diff changeset
    56
    void StartExecuteL( TRequestStatus& aStatus );    
hgs
parents:
diff changeset
    57
    
hgs
parents:
diff changeset
    58
    /**
hgs
parents:
diff changeset
    59
     * Cancels execution. This control and environment will be
hgs
parents:
diff changeset
    60
     * deleted soon after calling this method.
hgs
parents:
diff changeset
    61
     */
hgs
parents:
diff changeset
    62
    void CancelExecution();
hgs
parents:
diff changeset
    63
    
hgs
parents:
diff changeset
    64
    /**
hgs
parents:
diff changeset
    65
     * Starts execution.
hgs
parents:
diff changeset
    66
     * If this method leaves, then request must not be completed.
hgs
parents:
diff changeset
    67
     * By default, this method completes immediately.
hgs
parents:
diff changeset
    68
     */
hgs
parents:
diff changeset
    69
    virtual void DoStartExecuteL();
hgs
parents:
diff changeset
    70
    
hgs
parents:
diff changeset
    71
    /**
hgs
parents:
diff changeset
    72
     * Sets visible area.
hgs
parents:
diff changeset
    73
     * @param aVisibleArea visible area.
hgs
parents:
diff changeset
    74
     */
hgs
parents:
diff changeset
    75
    virtual void SetVisibleArea( const TRect& aVisibleArea );    
hgs
parents:
diff changeset
    76
    
hgs
parents:
diff changeset
    77
    // From base class CAlfControl:
hgs
parents:
diff changeset
    78
    
hgs
parents:
diff changeset
    79
    /**
hgs
parents:
diff changeset
    80
     * Handles events.
hgs
parents:
diff changeset
    81
     * Derived classes should forward to base class.
hgs
parents:
diff changeset
    82
     * @param aEvent event to be handled.
hgs
parents:
diff changeset
    83
     * @return ETrue if consumed, EFalse otherwise.
hgs
parents:
diff changeset
    84
     */
hgs
parents:
diff changeset
    85
    virtual TBool OfferEventL( const TAlfEvent& aEvent );
hgs
parents:
diff changeset
    86
    
hgs
parents:
diff changeset
    87
protected:
hgs
parents:
diff changeset
    88
        
hgs
parents:
diff changeset
    89
    /**
hgs
parents:
diff changeset
    90
     * Completes automatically after specified duration.
hgs
parents:
diff changeset
    91
     * @param aDuration duration in ms
hgs
parents:
diff changeset
    92
     */
hgs
parents:
diff changeset
    93
    void CompleteAfterL( TInt aDuration );
hgs
parents:
diff changeset
    94
        
hgs
parents:
diff changeset
    95
    /**
hgs
parents:
diff changeset
    96
     * Completes current request.
hgs
parents:
diff changeset
    97
     */
hgs
parents:
diff changeset
    98
    void CompleteNow( TInt aErrorCode );
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
    /**
hgs
parents:
diff changeset
   101
     * Returns test case id.
hgs
parents:
diff changeset
   102
     */
hgs
parents:
diff changeset
   103
    TInt CaseId() const
hgs
parents:
diff changeset
   104
    	{
hgs
parents:
diff changeset
   105
    	return iCaseId;
hgs
parents:
diff changeset
   106
    	}
hgs
parents:
diff changeset
   107
        
hgs
parents:
diff changeset
   108
    /**
hgs
parents:
diff changeset
   109
     * Returns ETrue if test case execution is still ongoing.
hgs
parents:
diff changeset
   110
     */
hgs
parents:
diff changeset
   111
    TBool IsExecutionOngoing() const
hgs
parents:
diff changeset
   112
    	{
hgs
parents:
diff changeset
   113
    	return ( iStatus != NULL );
hgs
parents:
diff changeset
   114
    	}
hgs
parents:
diff changeset
   115
    
hgs
parents:
diff changeset
   116
private:
hgs
parents:
diff changeset
   117
    
hgs
parents:
diff changeset
   118
    /**
hgs
parents:
diff changeset
   119
     * Test case id.
hgs
parents:
diff changeset
   120
     */
hgs
parents:
diff changeset
   121
    TInt iCaseId;
hgs
parents:
diff changeset
   122
    
hgs
parents:
diff changeset
   123
    /**
hgs
parents:
diff changeset
   124
     * Pointer to request status.
hgs
parents:
diff changeset
   125
     * Not owned.
hgs
parents:
diff changeset
   126
     */
hgs
parents:
diff changeset
   127
    TRequestStatus* iStatus;
hgs
parents:
diff changeset
   128
        
hgs
parents:
diff changeset
   129
    };
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
        
hgs
parents:
diff changeset
   132
#endif // C_ALFPERFAPPBASETESTCASECONTROL_H
hgs
parents:
diff changeset
   133