uiacceltk/hitchcock/tsrc/alfperfapp/inc/alfperfappsuitetestcasecontrol.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:  
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef ALFPERFAPPSUITETESTCASECONTROL_H_
hgs
parents:
diff changeset
    19
#define ALFPERFAPPSUITETESTCASECONTROL_H_
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
// INCLUDES
hgs
parents:
diff changeset
    22
#include <alf/alfcontrol.h>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// CONSTANTS
hgs
parents:
diff changeset
    25
const TInt KAlfPerfAppSuiteControlGroup = 1;
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
const TInt KAlfPerfAppSuiteCmdCompleteNow = 0x5000;
hgs
parents:
diff changeset
    28
const TInt KAlfPerfAppSuiteCmdNext = 0x5001;
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
// CLASS DECLARATION
hgs
parents:
diff changeset
    31
/**
hgs
parents:
diff changeset
    32
 * Abstract Suite test case control.
hgs
parents:
diff changeset
    33
 */
hgs
parents:
diff changeset
    34
class CAlfPerfAppSuiteTestCaseControl : public CAlfControl
hgs
parents:
diff changeset
    35
    {
hgs
parents:
diff changeset
    36
public:
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
    /**
hgs
parents:
diff changeset
    39
     * Constructor.
hgs
parents:
diff changeset
    40
     */
hgs
parents:
diff changeset
    41
    CAlfPerfAppSuiteTestCaseControl();
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
    /**
hgs
parents:
diff changeset
    44
     * Destructor.
hgs
parents:
diff changeset
    45
     */
hgs
parents:
diff changeset
    46
    ~CAlfPerfAppSuiteTestCaseControl();
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
    /**
hgs
parents:
diff changeset
    49
     * Base class constructor. Derived classes may
hgs
parents:
diff changeset
    50
     * override this, but base class needs to be called.
hgs
parents:
diff changeset
    51
     */
hgs
parents:
diff changeset
    52
    virtual void ConstructL( 
hgs
parents:
diff changeset
    53
            CAlfEnv& aEnv, TInt aCaseId, const TRect& aVisibleArea );
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
    /**
hgs
parents:
diff changeset
    56
     * Starts execution of the test case. By default,
hgs
parents:
diff changeset
    57
     * request status is stored to local variable.
hgs
parents:
diff changeset
    58
     */
hgs
parents:
diff changeset
    59
    void StartExecuteL( TRequestStatus& aStatus );    
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
    /**
hgs
parents:
diff changeset
    62
     * Cancels execution. This control and environment will be
hgs
parents:
diff changeset
    63
     * deleted soon after calling this method.
hgs
parents:
diff changeset
    64
     */
hgs
parents:
diff changeset
    65
    void CancelExecution();
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
    /**
hgs
parents:
diff changeset
    68
     * Starts execution.
hgs
parents:
diff changeset
    69
     * If this method leaves, then request must not be completed.
hgs
parents:
diff changeset
    70
     * By default, this method completes immediately.
hgs
parents:
diff changeset
    71
     */
hgs
parents:
diff changeset
    72
    virtual void DoStartExecuteL();
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
    /**
hgs
parents:
diff changeset
    75
     * Sets visible area.
hgs
parents:
diff changeset
    76
     * @param aVisibleArea visible area.
hgs
parents:
diff changeset
    77
     */
hgs
parents:
diff changeset
    78
    virtual void SetVisibleArea( const TRect& aVisibleArea );    
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
    // From base class CAlfControl:
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
    /**
hgs
parents:
diff changeset
    83
     * Handles events.
hgs
parents:
diff changeset
    84
     * Derived classes should forward to base class.
hgs
parents:
diff changeset
    85
     * @param aEvent event to be handled.
hgs
parents:
diff changeset
    86
     * @return ETrue if consumed, EFalse otherwise.
hgs
parents:
diff changeset
    87
     */
hgs
parents:
diff changeset
    88
    virtual TBool OfferEventL( const TAlfEvent& aEvent );
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
protected:
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
    /**
hgs
parents:
diff changeset
    93
     * Completes automatically after specified duration.
hgs
parents:
diff changeset
    94
     * @param aDuration duration in ms
hgs
parents:
diff changeset
    95
     */
hgs
parents:
diff changeset
    96
    void CompleteAfterL( TInt aDuration );
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
    /**
hgs
parents:
diff changeset
    99
     * Completes current request.
hgs
parents:
diff changeset
   100
     */
hgs
parents:
diff changeset
   101
    void CompleteNow( TInt aErrorCode );
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
    /**
hgs
parents:
diff changeset
   104
     * Returns test case id.
hgs
parents:
diff changeset
   105
     */
hgs
parents:
diff changeset
   106
    inline TInt CaseId() const;
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
    /**
hgs
parents:
diff changeset
   114
     * Test case id.
hgs
parents:
diff changeset
   115
     */
hgs
parents:
diff changeset
   116
    TInt iCaseId;
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
    /**
hgs
parents:
diff changeset
   119
     * Current visible screen area.
hgs
parents:
diff changeset
   120
     */
hgs
parents:
diff changeset
   121
    TRect iVisibleArea;
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
private:
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
    /**
hgs
parents:
diff changeset
   126
     * Pointer to request status.
hgs
parents:
diff changeset
   127
     * Not owned.
hgs
parents:
diff changeset
   128
     */
hgs
parents:
diff changeset
   129
    TRequestStatus* iStatus;
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
    };
hgs
parents:
diff changeset
   132
hgs
parents:
diff changeset
   133
#endif // ALFPERFAPPSUITETESTCASECONTROL_H_
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
// end of file
hgs
parents:
diff changeset
   136