1 /*

     2 * Copyright (c) 2002 - 2007 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  item_finder_api

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef C_TESTDOMITEMFINDER_H

    21 #define C_TESTDOMITEMFINDER_H

    22 

    23 //  INCLUDES

    24 #include <stiflogger.h>

    25 #include <testscripterinternal.h>

    26 #include <stiftestmodule.h>

    27 #include <testclassassert.h>

    28 #include <itemfinder.h>

    29 

    30 // MACROS

    31 #define TEST_CLASS_VERSION_MAJOR 0

    32 #define TEST_CLASS_VERSION_MINOR 0

    33 #define TEST_CLASS_VERSION_BUILD 0

    34 

    35 // Logging path

    36 _LIT( KtestdomitemfinderLogPath, "\\logs\\testframework\\testdomitemfinder\\" ); 

    37 // Log file

    38 _LIT( KtestdomitemfinderLogFile, "testdomitemfinder.txt" ); 

    39 _LIT( KtestdomitemfinderLogFileWithTitle, "testdomitemfinder_[%S].txt" );

    40 /**

    41 *  CItemFinderObserverExt test class for MItemFinderObserver.

    42 *  @since S60 5.0

    43 */

    44 class CItemFinderObserverExt : public CBase,public MItemFinderObserver

    45     {

    46     void HandleParsingComplete()

    47         {

    48         

    49         }

    50     };

    51 /**

    52 *  CTestDOMItemFinder test class for STIF Test Framework TestScripter.

    53 *  @since S60 5.0

    54 */

    55 class CItemFinder;

    56 

    57 NONSHARABLE_CLASS( CTestDOMItemFinder ) : public CScriptBase

    58     {

    59 public:  // Constructors and destructor

    60 

    61     /**

    62     * Two-phased constructor.

    63     */

    64     static CTestDOMItemFinder* NewL( CTestModuleIf& aTestModuleIf );

    65 

    66     /**

    67     * Destructor.

    68     */

    69     virtual ~CTestDOMItemFinder();

    70 

    71 public: // Functions from base classes

    72 

    73     /**

    74     * From CScriptBase Runs a script line.

    75     * @since S60 5.0

    76     * @param aItem Script line containing method name and parameters

    77     * @return Symbian OS error code

    78     */

    79     virtual TInt RunMethodL( CStifItemParser& aItem );

    80 

    81 private:

    82 

    83     /**

    84     * C++ default constructor.

    85     */

    86     CTestDOMItemFinder( CTestModuleIf& aTestModuleIf );

    87 

    88     /**

    89     * By default Symbian 2nd phase constructor is private.

    90     */

    91     void ConstructL();

    92     

    93     /**

    94      * Method used to log version of test class

    95      */

    96     void SendTestClassVersion();

    97     

    98         /**

    99      * Turn off ScreenSaver

   100      * @since S60 5.0

   101      * @return Symbian OS error code.

   102      */

   103     void TurnOffScreenSaver();

   104 

   105     /**

   106      * Restore ScreenSaver

   107      * @since S60 5.0

   108      * @return Symbian OS error code.

   109      */

   110     void RestoreScreenSaver();

   111 

   112 private: // [TestMethods]

   113 

   114     /**

   115     * TestIFNewL test method.

   116     * @since S60 5.0

   117     * @param aItem Script line containing parameters.

   118     * @return Symbian OS error code.

   119     */

   120     virtual TInt TestIFNewL( CStifItemParser& aItem );

   121     /**

   122     * TestIFNextItemOrScrollL test method.

   123     * @since S60 5.0

   124     * @param aItem Script line containing parameters.

   125     * @return Symbian OS error code.

   126     */

   127     virtual TInt TestIFNextItemOrScrollL( CStifItemParser& aItem );

   128     /**

   129     * TestIFSetFindModeL test method.

   130     * @since S60 5.0

   131     * @param aItem Script line containing parameters.

   132     * @return Symbian OS error code.

   133     */

   134     virtual TInt TestIFSetFindModeL( CStifItemParser& aItem );

   135     /**

   136     * TestIFSetEditor test method.

   137     * @since S60 5.0

   138     * @param aItem Script line containing parameters.

   139     * @return Symbian OS error code.

   140     */

   141     virtual TInt TestIFSetEditorL( CStifItemParser& aItem );

   142     /**

   143     * TestIFParseThisText test method.

   144     * @since S60 5.0

   145     * @param aItem Script line containing parameters.

   146     * @return Symbian OS error code.

   147     */

   148     virtual TInt TestIFParseThisTextL( CStifItemParser& aItem );

   149     /**

   150     * TestIFCreateDoItTextL test method.

   151     * @since S60 5.0

   152     * @param aItem Script line containing parameters.

   153     * @return Symbian OS error code.

   154     */

   155     virtual TInt TestIFCreateDoItTextL( CStifItemParser& aItem );

   156     /**

   157     * TestIFActivateThisTextL test method.

   158     * @since S60 5.0

   159     * @param aItem Script line containing parameters.

   160     * @return Symbian OS error code.

   161     */

   162     virtual TInt TestIFActivateThisTextL( CStifItemParser& aItem );

   163     /**

   164     * TestIFReformatOnRecognise test method.

   165     * @since S60 5.0

   166     * @param aItem Script line containing parameters.

   167     * @return Symbian OS error code.

   168     */

   169     virtual TInt TestIFReformatOnRecognise( CStifItemParser& aItem );

   170     /**

   171     * TestIFReformatOnRollover test method.

   172     * @since S60 5.0

   173     * @param aItem Script line containing parameters.

   174     * @return Symbian OS error code.

   175     */

   176     virtual TInt TestIFReformatOnRollover( CStifItemParser& aItem );

   177     /**

   178     * TestIFGetRecogniseFormat test method.

   179     * @since S60 5.0

   180     * @param aItem Script line containing parameters.

   181     * @return Symbian OS error code.

   182     */

   183     virtual TInt TestIFGetRecogniseFormat( CStifItemParser& aItem );

   184     /**

   185     * TestIFGetRolloverFormat test method.

   186     * @since S60 5.0

   187     * @param aItem Script line containing parameters.

   188     * @return Symbian OS error code.

   189     */

   190     virtual TInt TestIFGetRolloverFormat( CStifItemParser& aItem );

   191     /**

   192     * TestIFConfirmCursorOverTagL test method.

   193     * @since S60 5.0

   194     * @param aItem Script line containing parameters.

   195     * @return Symbian OS error code.

   196     */

   197     virtual TInt TestIFConfirmCursorOverTagL( CStifItemParser& aItem );

   198     /**

   199     * TestIFRelease test method.

   200     * @since S60 5.0

   201     * @param aItem Script line containing parameters.

   202     * @return Symbian OS error code.

   203     */

   204     virtual TInt TestIFRelease( CStifItemParser& aItem );

   205     /**

   206     * TestIFMParser_Reserved_2 test method.

   207     * @since S60 5.0

   208     * @param aItem Script line containing parameters.

   209     * @return Symbian OS error code.

   210     */

   211     virtual TInt TestIFMParser_Reserved_2( CStifItemParser& aItem );

   212     /**

   213     * TestIFPositionOfNextItem test method.

   214     * @since S60 5.0

   215     * @param aItem Script line containing parameters.

   216     * @return Symbian OS error code.

   217     */

   218     virtual TInt TestIFPositionOfNextItem( CStifItemParser& aItem );

   219     /**

   220     * TestIFResetCurrentItem test method.

   221     * @since S60 5.0

   222     * @param aItem Script line containing parameters.

   223     * @return Symbian OS error code.

   224     */

   225     virtual TInt TestIFResetCurrentItem( CStifItemParser& aItem );

   226     /**

   227     * TestIFResolveAndSetItemTypeL test method.

   228     * @since S60 5.0

   229     * @param aItem Script line containing parameters.

   230     * @return Symbian OS error code.

   231     */

   232     virtual TInt TestIFResolveAndSetItemTypeL( CStifItemParser& aItem );

   233     /**

   234     * TestIFAddObserver test method.

   235     * @since S60 5.0

   236     * @param aItem Script line containing parameters.

   237     * @return Symbian OS error code.

   238     */

   239     virtual TInt TestIFAddObserverL( CStifItemParser& aItem );

   240     /**

   241     * TestIFItemWasTappedL test method.

   242     * @since S60 5.0

   243     * @param aItem Script line containing parameters.

   244     * @return Symbian OS error code.

   245     */

   246     virtual TInt TestIFItemWasTappedL( CStifItemParser& aItem );

   247     /**

   248     * TestIFSetExternalLinks test method.

   249     * @since S60 5.0

   250     * @param aItem Script line containing parameters.

   251     * @return Symbian OS error code.

   252     */

   253     virtual TInt TestIFSetExternalLinksL( CStifItemParser& aItem );

   254     /**

   255     * TestIFCurrentItemExt test method.

   256     * @since S60 5.0

   257     * @param aItem Script line containing parameters.

   258     * @return Symbian OS error code.

   259     */

   260     virtual TInt TestIFCurrentItemExt( CStifItemParser& aItem );

   261     /**

   262     * TestIFCurrentSelection test method.

   263     * @since S60 5.0

   264     * @param aItem Script line containing parameters.

   265     * @return Symbian OS error code.

   266     */

   267     virtual TInt TestIFCurrentSelection( CStifItemParser& aItem );

   268 

   269 private:    // Data

   270 

   271     /**

   272      * ScreenSaver Property

   273      */

   274     TInt iOldScreenSaverProperty;

   275     

   276     /**

   277      * for test

   278      * Not own.

   279      */

   280     CItemFinder* iItemFinder;

   281 

   282     };

   283 

   284 #endif      // C_TESTDOMITEMFINDER_H

   285 

   286 // End of File