classicui_plat/findutil_api/tsrc/inc/testdomfindutil.h
author hgs
Wed, 23 Jun 2010 05:40:10 +0800
changeset 33 b3425bf29f82
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 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 the License "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:    test findutil.h
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
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#ifndef C_TESTDOMFINDUTIL_H
hgs
parents:
diff changeset
    23
#define C_TESTDOMFINDUTIL_H
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
//  INCLUDES
hgs
parents:
diff changeset
    26
#include <stiflogger.h>
hgs
parents:
diff changeset
    27
#include <testscripterinternal.h>
hgs
parents:
diff changeset
    28
#include <stiftestmodule.h>
hgs
parents:
diff changeset
    29
#include <testclassassert.h>
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
// MACROS
hgs
parents:
diff changeset
    32
#define TEST_CLASS_VERSION_MAJOR 0
hgs
parents:
diff changeset
    33
#define TEST_CLASS_VERSION_MINOR 0
hgs
parents:
diff changeset
    34
#define TEST_CLASS_VERSION_BUILD 0
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
// Logging path
hgs
parents:
diff changeset
    37
_LIT( KtestdomfindutilLogPath, "\\logs\\testframework\\testdomfindutil\\" ); 
hgs
parents:
diff changeset
    38
// Log file
hgs
parents:
diff changeset
    39
_LIT( KtestdomfindutilLogFile, "testdomfindutil.txt" ); 
hgs
parents:
diff changeset
    40
_LIT( KtestdomfindutilLogFileWithTitle, "testdomfindutil_[%S].txt" );
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
/**
hgs
parents:
diff changeset
    43
*  CTestDOMFindUtil test class for STIF Test Framework TestScripter.
hgs
parents:
diff changeset
    44
*  @since S60 5.0
hgs
parents:
diff changeset
    45
*/
hgs
parents:
diff changeset
    46
NONSHARABLE_CLASS( CTestDOMFindUtil ) : public CScriptBase
hgs
parents:
diff changeset
    47
    {
hgs
parents:
diff changeset
    48
public:  // Constructors and destructor
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
    /**
hgs
parents:
diff changeset
    51
    * Two-phased constructor.
hgs
parents:
diff changeset
    52
    */
hgs
parents:
diff changeset
    53
    static CTestDOMFindUtil* NewL( CTestModuleIf& aTestModuleIf );
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
    /**
hgs
parents:
diff changeset
    56
    * Destructor.
hgs
parents:
diff changeset
    57
    */
hgs
parents:
diff changeset
    58
    virtual ~CTestDOMFindUtil();
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
public: // Functions from base classes
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
    /**
hgs
parents:
diff changeset
    63
    * From CScriptBase Runs a script line.
hgs
parents:
diff changeset
    64
    * @since S60 5.0
hgs
parents:
diff changeset
    65
    * @param aItem Script line containing method name and parameters
hgs
parents:
diff changeset
    66
    * @return Symbian OS error code
hgs
parents:
diff changeset
    67
    */
hgs
parents:
diff changeset
    68
    virtual TInt RunMethodL( CStifItemParser& aItem );
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
private:
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
    /**
hgs
parents:
diff changeset
    73
    * C++ default constructor.
hgs
parents:
diff changeset
    74
    */
hgs
parents:
diff changeset
    75
    CTestDOMFindUtil( CTestModuleIf& aTestModuleIf );
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
    /**
hgs
parents:
diff changeset
    78
    * By default Symbian 2nd phase constructor is private.
hgs
parents:
diff changeset
    79
    */
hgs
parents:
diff changeset
    80
    void ConstructL();
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
    /**
hgs
parents:
diff changeset
    83
     * Method used to log version of test class
hgs
parents:
diff changeset
    84
     */
hgs
parents:
diff changeset
    85
    void SendTestClassVersion();
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
        /**
hgs
parents:
diff changeset
    88
     * Turn off ScreenSaver
hgs
parents:
diff changeset
    89
     * @since S60 5.0
hgs
parents:
diff changeset
    90
     * @return Symbian OS error code.
hgs
parents:
diff changeset
    91
     */
hgs
parents:
diff changeset
    92
    void TurnOffScreenSaver();
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
    /**
hgs
parents:
diff changeset
    95
     * Restore ScreenSaver
hgs
parents:
diff changeset
    96
     * @since S60 5.0
hgs
parents:
diff changeset
    97
     * @return Symbian OS error code.
hgs
parents:
diff changeset
    98
     */
hgs
parents:
diff changeset
    99
    void RestoreScreenSaver();
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
private: // test functions of MFindUtil class
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
    /**
hgs
parents:
diff changeset
   104
    * test MatchRefineL method.
hgs
parents:
diff changeset
   105
    * @since S60 5.0
hgs
parents:
diff changeset
   106
    * @param aItem Script line containing parameters.
hgs
parents:
diff changeset
   107
    * @return Symbian OS error code.
hgs
parents:
diff changeset
   108
    */
hgs
parents:
diff changeset
   109
    virtual TInt TestMatchRefineL( CStifItemParser& aItem );
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
    /**
hgs
parents:
diff changeset
   112
    * test Match method.
hgs
parents:
diff changeset
   113
    * @since S60 5.0
hgs
parents:
diff changeset
   114
    * @param aItem Script line containing parameters.
hgs
parents:
diff changeset
   115
    * @return Symbian OS error code.
hgs
parents:
diff changeset
   116
    */
hgs
parents:
diff changeset
   117
    virtual TInt TestMatchL( CStifItemParser& aItem );
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
    /**
hgs
parents:
diff changeset
   120
    * test IsWordValidForMatching method.
hgs
parents:
diff changeset
   121
    * @since S60 5.0
hgs
parents:
diff changeset
   122
    * @param aItem Script line containing parameters.
hgs
parents:
diff changeset
   123
    * @return Symbian OS error code.
hgs
parents:
diff changeset
   124
    */
hgs
parents:
diff changeset
   125
    virtual TInt TestIsWordValidForMatchingL( CStifItemParser& aItem );
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
    /**
hgs
parents:
diff changeset
   128
    * test MatchAdaptiveRefineL method.
hgs
parents:
diff changeset
   129
    * @since S60 5.0
hgs
parents:
diff changeset
   130
    * @param aItem Script line containing parameters.
hgs
parents:
diff changeset
   131
    * @return Symbian OS error code.
hgs
parents:
diff changeset
   132
    */
hgs
parents:
diff changeset
   133
    virtual TInt TestMatchAdaptiveRefineL( CStifItemParser& aItem );
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
private: // test functions of CFindUtil class
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
    /**
hgs
parents:
diff changeset
   138
    * test NewL method.
hgs
parents:
diff changeset
   139
    * @since S60 5.0
hgs
parents:
diff changeset
   140
    * @param aItem never used.
hgs
parents:
diff changeset
   141
    * @return Symbian OS error code.
hgs
parents:
diff changeset
   142
    */
hgs
parents:
diff changeset
   143
    virtual TInt TestNewL( CStifItemParser& aItem );
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
private:    // Data
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
    /**
hgs
parents:
diff changeset
   148
     * ScreenSaver Property
hgs
parents:
diff changeset
   149
     */
hgs
parents:
diff changeset
   150
    TInt iOldScreenSaverProperty;
hgs
parents:
diff changeset
   151
hgs
parents:
diff changeset
   152
    };
hgs
parents:
diff changeset
   153
hgs
parents:
diff changeset
   154
#endif      // C_TESTDOMFINDUTIL_H
hgs
parents:
diff changeset
   155
hgs
parents:
diff changeset
   156
// End of File