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:  ?Description

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef C_TESTDOMPSLNFRAMEWORK_H

    21 #define C_TESTDOMPSLNFRAMEWORK_H

    22 

    23 //  INCLUDES

    24 #include <stiflogger.h>

    25 #include <testscripterinternal.h>

    26 #include <stiftestmodule.h>

    27 #include <testclassassert.h>

    28 #include <eikenv.h>

    29 

    30 // CONSTANTS

    31 

    32 // MACROS

    33 //#define ?macro ?macro_def

    34 #define TEST_CLASS_VERSION_MAJOR 0

    35 #define TEST_CLASS_VERSION_MINOR 0

    36 #define TEST_CLASS_VERSION_BUILD 0

    37 

    38 // Logging path

    39 _LIT( KtestdompslnframeworkLogPath, "\\logs\\testframework\\testdompslnframework\\" ); 

    40 // Log file

    41 _LIT( KtestdompslnframeworkLogFile, "testdompslnframework.txt" ); 

    42 _LIT( KtestdompslnframeworkLogFileWithTitle, "testdompslnframework_[%S].txt" );

    43 //resource

    44 _LIT( KFilePath, "C:\\resource\\testdompslnframework.rsc" );

    45 _LIT( KFileDir, "C:\\resource\\" );

    46 

    47 // CLASS DECLARATION

    48 class CTestDOMPSLNFramework;

    49 class CPslnFWAppThemeHandler;

    50 class CPslnFWBaseContainer;

    51 class CTestPslnFWBaseView;

    52 class CPslnFWIconHelper;

    53 class CPslnFWPluginHandler;

    54 

    55 /**

    56 *  Ctestdompslnframework test class for STIF Test Framework TestScripter.

    57 */

    58 NONSHARABLE_CLASS(CTestDOMPSLNFramework) : public CScriptBase

    59     {

    60     public:  // Constructors and destructor

    61 

    62         /**

    63         * Two-phased constructor.

    64         */

    65         static CTestDOMPSLNFramework* NewL( CTestModuleIf& aTestModuleIf );

    66 

    67         /**

    68         * Destructor.

    69         */

    70         virtual ~CTestDOMPSLNFramework();

    71 

    72     public: // Functions from base classes

    73 

    74         /**

    75         * From CScriptBase Runs a script line.

    76         * @since S60 5.0

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

    78         * @return Symbian OS error code

    79         */

    80         virtual TInt RunMethodL( CStifItemParser& aItem );

    81 

    82     private:

    83 

    84         /**

    85         * C++ default constructor.

    86         */

    87         CTestDOMPSLNFramework( CTestModuleIf& aTestModuleIf );

    88 

    89         /**

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

    91         */

    92         void ConstructL();

    93 

    94         /**

    95         * Frees all resources allocated from test methods.

    96         * @since S60 5.0

    97         */

    98         void Delete();

    99 

   100         /**

   101         * Test methods are listed below. 

   102         */

   103 

   104 private:// PslnFWBaseContainer.h

   105         /**

   106          * TestPlsnFWBCConstructL test function for 

   107          * testing the ConstructL function

   108          * @since S60 5.0

   109          * @param aItem never used

   110          * @return Symbian OS error code.

   111          */

   112         virtual TInt TestPlsnFWBCConstructL( CStifItemParser& aItem );

   113 

   114         /**

   115          * TestPlsnFWBCBaseConstructL test function for 

   116          * testing the BaseConstructL function

   117          * @since S60 5.0

   118          * @param aItem never used

   119          * @return Symbian OS error code.

   120          */

   121         virtual TInt TestPlsnFWBCBaseConstructL( CStifItemParser& aItem );

   122 

   123         /**

   124          * TestPlsnFWBCCPslnFWBaseContainer test function for 

   125          * testing the CPslnFWBaseContainer function

   126          * @since S60 5.0

   127          * @param aItem never used

   128          * @return Symbian OS error code.

   129          */

   130         virtual TInt TestPlsnFWBCCPslnFWBaseContainerL( CStifItemParser& aItem );

   131 

   132         /**

   133          * TestPlsnFWBCCPslnFWBaseContainer test function for 

   134          * testing the CPslnFWBaseContainer function

   135          * @since S60 5.0

   136          * @param aItem never used

   137          * @return Symbian OS error code.

   138          */

   139         virtual TInt TestPlsnFWBCDelete( CStifItemParser& aItem );

   140 

   141         /**

   142          * TestPlsnFWBCSetMiddleSoftkeyObserver test function for 

   143          * testing the SetMiddleSoftkeyObserver function

   144          * @since S60 5.0

   145          * @param aItem never used

   146          * @return Symbian OS error code.

   147          */

   148         virtual TInt TestPlsnFWBCSetMiddleSoftkeyObserverL( CStifItemParser& aItem );

   149         

   150 private://PslnFWBaseView.h

   151         /**

   152          * TestPlsnFWBVCPslnFWBaseView test function for 

   153          * testing the PslnFWBaseView function

   154          * @since S60 5.0

   155          * @param aItem never used

   156          * @return Symbian OS error code.

   157          */

   158         virtual TInt TestPlsnFWBVCPslnFWBaseViewL( CStifItemParser& aItem );

   159          

   160         /**

   161          * TestPlsnFWBVConstructL test function for 

   162          * testing the ConstructL function

   163          * @since S60 5.0

   164          * @param aItem never used

   165          * @return Symbian OS error code.

   166          */

   167         virtual TInt TestPlsnFWBVConstructL( CStifItemParser& aItem );

   168 

   169         /**

   170          * TestPlsnFWBVDelete test function for 

   171          * testing the Deconstruct function

   172          * @since S60 5.0

   173          * @param aItem never used

   174          * @return Symbian OS error code.

   175          */

   176         virtual TInt TestPlsnFWBVDelete( CStifItemParser& aItem );

   177 

   178         /**

   179          * TestPlsnFWBVSetCurrentItem test function for 

   180          * testing the CurrentItem function

   181          * @since S60 5.0

   182          * @param aItem never used

   183          * @return Symbian OS error code.

   184          */

   185         virtual TInt TestPlsnFWBVSetCurrentItem( CStifItemParser& aItem );

   186 

   187         /**

   188          * TestPlsnFWBVContainer test function for 

   189          * testing the Container function

   190          * @since S60 5.0

   191          * @param aItem never used

   192          * @return Symbian OS error code.

   193          */

   194         virtual TInt TestPlsnFWBVContainer( CStifItemParser& aItem );

   195 

   196         /**

   197          * TestPlsnFWBVOpenLocalizedResourceFileL test function for 

   198          * testing the OpenLocalizedResourceFileL function

   199          * @since S60 5.0

   200          * @param aItem never used

   201          * @return Symbian OS error code.

   202          */

   203         virtual TInt TestPlsnFWBVOpenLocalizedResourceFileL( CStifItemParser& aItem );

   204 

   205         /**

   206          * TestPlsnFWBVOpenLocalizedResourceFileLWithPathL test function for 

   207          * testing the OpenLocalizedResourceFileL function with path param

   208          * @since S60 5.0

   209          * @param aItem never used

   210          * @return Symbian OS error code.

   211          */

   212         virtual TInt TestPlsnFWBVOpenLocalizedResourceFileLWithPathL( CStifItemParser& aItem );

   213         

   214         /**

   215          * TestPlsnFWBVSetNaviPaneDecorator test function for 

   216          * testing the SetNaviPaneDecorator function

   217          * @since S60 5.0

   218          * @param aItem never used

   219          * @return Symbian OS error code.

   220          */

   221         virtual TInt TestPlsnFWBVSetNaviPaneDecoratorL( CStifItemParser& aItem );

   222 

   223         /**

   224          * TestPlsnFWBVDoActivateL test function for 

   225          * testing the DoActivateL function

   226          * @since S60 5.0

   227          * @param aItem never used

   228          * @return Symbian OS error code.

   229          */

   230         virtual TInt TestPlsnFWBVDoActivateL( CStifItemParser& aItem );

   231 

   232         /**

   233          * TestPlsnFWBVDoDeactivate test function for 

   234          * testing the DoDeactivate function

   235          * @since S60 5.0

   236          * @param aItem never used

   237          * @return Symbian OS error code.

   238          */

   239         virtual TInt TestPlsnFWBVDoDeactivateL( CStifItemParser& aItem );

   240 

   241         /**

   242          * TestPlsnFWBVSetTabIndex test function for 

   243          * testing the SetTabIndex function

   244          * @since S60 5.0

   245          * @param aItem never used

   246          * @return Symbian OS error code.

   247          */

   248         virtual TInt TestPlsnFWBVSetTabIndex( CStifItemParser& aItem );

   249 

   250         /**

   251          * TestPlsnFWBVGetTabIndex test function for 

   252          * testing the GetTabIndex function

   253          * @since S60 5.0

   254          * @param aItem never used

   255          * @return Symbian OS error code.

   256          */

   257         virtual TInt TestPlsnFWBVGetTabIndex( CStifItemParser& aItem );

   258 

   259         /**

   260          * TestPlsnFWBVSetNaviPaneL test function for testing the SetNaviPaneL function

   261          * @since S60 5.0

   262          * @param aItem never used

   263          * @return Symbian OS error code.

   264          */

   265         virtual TInt TestPlsnFWBVSetNaviPaneL( CStifItemParser& aItem );

   266 

   267         /**

   268          * TestPlsnFWBVCreateNaviPaneContextL test function for 

   269          * testing the CreateNaviPaneContextL function

   270          * @since S60 5.0

   271          * @param aItem never used

   272          * @return Symbian OS error code.

   273          */

   274         virtual TInt TestPlsnFWBVCreateNaviPaneContextL( CStifItemParser& aItem );

   275 

   276         /**

   277          * TestPlsnFWBVCreateContainerL test function for testing the CreateContainerL function

   278          * @since S60 5.0

   279          * @param aItem never used

   280          * @return Symbian OS error code.

   281          */

   282         virtual TInt TestPlsnFWBVCreateContainerL( CStifItemParser& aItem );

   283 

   284         /**

   285          * TestPlsnFWBVNewContainerL test function for testing the NewContainerL function

   286          * @since S60 5.0

   287          * @param aItem never used

   288          * @return Symbian OS error code.

   289          */

   290         virtual TInt TestPlsnFWBVNewContainerL( CStifItemParser& aItem );

   291 

   292         /**

   293          * TestPlsnFWBVSetNaviPaneLWithTIntL test function for testing the SetNaviPaneL function

   294          * @since S60 5.0

   295          * @param aItem never used

   296          * @return Symbian OS error code.

   297          */

   298         virtual TInt TestPlsnFWBVSetNaviPaneLWithTIntL( CStifItemParser& aItem );

   299 

   300         /**

   301          * TestPlsnFWBVSetMiddleSoftKeyLabelL test function for

   302          * testing the SetMiddleSoftKeyLabelL function

   303          * @since S60 5.0

   304          * @param aItem never used

   305          * @return Symbian OS error code.

   306          */

   307         virtual TInt TestPlsnFWBVSetMiddleSoftKeyLabelL( CStifItemParser& aItem );

   308 

   309         /**

   310          * TestPlsnFWBVHandleCommandL test function for testing the HandleCommandL function

   311          * @since S60 5.0

   312          * @param aItem never used

   313          * @return Symbian OS error code.

   314          */

   315         virtual TInt TestPlsnFWBVHandleCommandL( CStifItemParser& aItem );

   316 

   317         /**

   318          * TestPlsnFWBVSetTitlePaneL test function for testing the SetTitlePaneL function

   319          * @since S60 5.0

   320          * @param aItem never used

   321          * @return Symbian OS error code.

   322          */

   323         virtual TInt TestPlsnFWBVSetTitlePaneL( CStifItemParser& aItem );

   324 

   325 private:

   326         //PslnFWIconHelper.h

   327         /**

   328          * TestPlsnFWIHNewL test function for 

   329          * testing the NewL function

   330          * @since S60 5.0

   331          * @param aItem never used

   332          * @return Symbian OS error code.

   333          */

   334         virtual TInt TestPlsnFWIHNewL( CStifItemParser& aItem );

   335 

   336         /**

   337          * TestPlsnFWIHNewL test function for 

   338          * testing the NewL function

   339          * @since S60 5.0

   340          * @param aItem never used

   341          * @return Symbian OS error code.

   342          */

   343         virtual TInt TestPlsnFWIHDelete( CStifItemParser& aItem );

   344 

   345         /**

   346          * TestPlsnFWIHAddIconsToSettingItemsL test function for 

   347          * testing the AddIconsToSettingItemsL function 

   348          * @since S60 5.0

   349          * @param aItem never used

   350          * @return Symbian OS error code.

   351          */

   352         virtual TInt TestPlsnFWIHAddIconsToSettingItemsL( CStifItemParser& aItem );

   353 

   354         /**

   355          * TestPlsnFWIHGetLocalizedStringLC test function for 

   356          * testing the GetLocalizedStringLC function

   357          * @since S60 5.0

   358          * @param aItem never used

   359          * @return Symbian OS error code.

   360          */

   361         virtual TInt TestPlsnFWIHGetLocalizedStringLC( CStifItemParser& aItem );

   362 

   363 private:

   364         //PslnFWPluginHandler.h

   365         /**

   366          * TestPlsnFWPHNewL test function for 

   367          * testing the NewL function

   368          * @since S60 5.0

   369          * @param aItem never used

   370          * @return Symbian OS error code.

   371          */

   372         virtual TInt TestPlsnFWPHNewL( CStifItemParser& aItem );

   373 

   374         /**

   375          * TestPlsnFWPHNewL test function for 

   376          * testing the NewL function with CArrayPtrFlat param

   377          * @since S60 5.0

   378          * @param aItem never used

   379          * @return Symbian OS error code.

   380          */

   381         virtual TInt TestPlsnFWPHNewLWithArrayL( CStifItemParser& aItem );

   382         

   383         /**

   384          * TestPlsnFWPHDelete test function for 

   385          * testing the Deconstruct function

   386          * @since S60 5.0

   387          * @param aItem never used

   388          * @return Symbian OS error code.

   389          */

   390         virtual TInt TestPlsnFWPHDelete( CStifItemParser& aItem );

   391 

   392         /**

   393          * TestPlsnFWPHLoadPluginsLWithArray test function for 

   394          * testing the LoadPluginsL function with CArrayPtrFlat param

   395          * @since S60 5.0

   396          * @param aItem never used

   397          * @return Symbian OS error code.

   398          */

   399         virtual TInt TestPlsnFWPHLoadPluginsLWithArrayL( CStifItemParser& aItem );

   400         

   401         /**

   402          * TestPlsnFWPHLoadPluginsLWithId test function for 

   403          * testing the LoadPluginsL function with TUid param

   404          * @since S60 5.0

   405          * @param aItem never used

   406          * @return Symbian OS error code.

   407          */

   408         virtual TInt TestPlsnFWPHLoadPluginsLWithId( CStifItemParser& aItem );

   409         

   410         //ADD NEW METHOD DEC HERE

   411         //[TestMethods] - Do not remove

   412 private:

   413         /**

   414          * Method used to log version of test class

   415          */

   416         void SendTestClassVersion();

   417 

   418 private://data

   419     /**

   420      * for test CPslnFWAppThemeHandler

   421      */

   422     CPslnFWAppThemeHandler* iHandle;

   423     

   424     /**

   425      * for test CPslnFWBaseContainer

   426      */

   427     CPslnFWBaseContainer* iFWBContainer;

   428     

   429     /**

   430      * for test CPslnFWBaseView

   431      */

   432     CTestPslnFWBaseView* iFWBView;

   433     

   434     /**

   435      * for test CPslnFWIconHelper

   436      */

   437     CPslnFWIconHelper* iHelper;

   438     

   439     /**

   440      * for test CPslnFWPluginHandler

   441      */

   442     CPslnFWPluginHandler* iFWPHandler;

   443     

   444     /**

   445      * Own, for CEikonEnv::Static()

   446      */

   447     CEikonEnv* iEikonEnvPointer;

   448 

   449     // ScreenSaver Property

   450     TInt iOldScreenSaverProperty;

   451     

   452     // Resource file offset

   453     TInt iOffset;

   454     };

   455 

   456 #endif      // C_TESTDOMPSLNFRAMEWORK_H

   457 

   458 // End of File