1 /*

     2 * Copyright (c) 2009 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: STIF testclass declaration

    15 *

    16 */

    17 

    18 #ifndef ACTIVEPALETTE2APITEST_H

    19 #define ACTIVEPALETTE2APITEST_H

    20 

    21 //  INCLUDES

    22 #include <StifLogger.h>

    23 #include <TestScripterInternal.h>

    24 #include <StifTestModule.h>

    25 #include <TestclassAssert.h>

    26 

    27 // CONSTANTS

    28 //const ?type ?constant_var = ?constant;

    29 

    30 // MACROS

    31 //#define ?macro ?macro_def

    32 #define TEST_CLASS_VERSION_MAJOR 0

    33 #define TEST_CLASS_VERSION_MINOR 0

    34 #define TEST_CLASS_VERSION_BUILD 0

    35 

    36 // Logging path

    37 _LIT( KActivePalette2ApiTestLogPath, "\\logs\\testframework\\ActivePalette2ApiTest\\" ); 

    38 // Log file

    39 _LIT( KActivePalette2ApiTestLogFile, "ActivePalette2ApiTest.txt" ); 

    40 _LIT( KActivePalette2ApiTestLogFileWithTitle, "ActivePalette2ApiTest_[%S].txt" );

    41 

    42 // FUNCTION PROTOTYPES

    43 //?type ?function_name(?arg_list);

    44 

    45 // FORWARD DECLARATIONS

    46 //class ?FORWARD_CLASSNAME;

    47 class CActivePalette2ApiTest;

    48 class CActivePaletteContainer;

    49 

    50 // DATA TYPES

    51 //enum ?declaration

    52 //typedef ?declaration

    53 //extern ?data_type;

    54 

    55 // CLASS DECLARATION

    56 

    57 /**

    58 *  CActivePalette2ApiTest test class for STIF Test Framework TestScripter.

    59 *  ?other_description_lines

    60 *

    61 *  @lib ?library

    62 *  @since ?Series60_version

    63 */

    64 NONSHARABLE_CLASS(CActivePalette2ApiTest) : public CScriptBase

    65     {

    66     public:  // Constructors and destructor

    67 

    68         /**

    69         * Two-phased constructor.

    70         */

    71         static CActivePalette2ApiTest* NewL( CTestModuleIf& aTestModuleIf );

    72 

    73         /**

    74         * Destructor.

    75         */

    76         virtual ~CActivePalette2ApiTest();

    77 

    78     public: // New functions

    79 

    80         /**

    81         * ?member_description.

    82         * @since ?Series60_version

    83         * @param ?arg1 ?description

    84         * @return ?description

    85         */

    86         //?type ?member_function( ?type ?arg1 );

    87         CStifLogger* Log() const;

    88 

    89     public: // Functions from base classes

    90 

    91         /**

    92         * From CScriptBase Runs a script line.

    93         * @since ?Series60_version

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

    95         * @return Symbian OS error code

    96         */

    97         virtual TInt RunMethodL( CStifItemParser& aItem );

    98 

    99     protected:  // New functions

   100 

   101         /**

   102         * ?member_description.

   103         * @since ?Series60_version

   104         * @param ?arg1 ?description

   105         * @return ?description

   106         */

   107         //?type ?member_function( ?type ?arg1 );

   108 

   109     protected:  // Functions from base classes

   110 

   111         /**

   112         * From ?base_class ?member_description

   113         */

   114         //?type ?member_function();

   115 

   116     private:

   117 

   118         /**

   119         * C++ default constructor.

   120         */

   121         CActivePalette2ApiTest( CTestModuleIf& aTestModuleIf );

   122 

   123         /**

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

   125         */

   126         void ConstructL();

   127 

   128         // Prohibit copy constructor if not deriving from CBase.

   129         // ?classname( const ?classname& );

   130         // Prohibit assigment operator if not deriving from CBase.

   131         // ?classname& operator=( const ?classname& );

   132 

   133         /**

   134         * Frees all resources allocated from test methods.

   135         * @since ?Series60_version

   136         */

   137         void Delete();

   138 

   139         /**

   140         * Test methods are listed below. 

   141         */

   142         virtual TInt CreateUiL( CStifItemParser& aItem );

   143         virtual TInt DisposeUiL( CStifItemParser& aItem );

   144         virtual TInt SetNavigationKeysL( CStifItemParser& aItem );

   145         virtual TInt ListPluginsL( CStifItemParser& aItem );

   146         

   147         virtual TInt SetPaletteVisibilityL( CStifItemParser& aItem );

   148         virtual TInt MovePaletteL( CStifItemParser& aItem );

   149         

   150         virtual TInt AddItemsL( CStifItemParser& aItem );

   151         virtual TInt RemoveItemsL( CStifItemParser& aItem );

   152         virtual TInt ShowItemsL( CStifItemParser& aItem );

   153         virtual TInt HideItemsL( CStifItemParser& aItem );

   154         virtual TInt SetCurrentItemL( CStifItemParser& aItem );

   155         virtual TInt CheckCurrentItemL( CStifItemParser& aItem );

   156         virtual TInt CheckItemListL( CStifItemParser& aItem );

   157         virtual TInt CheckItemVisibilitiesL( CStifItemParser& aItem );

   158         

   159         virtual TInt TestOffscreenDrawingL( CStifItemParser& aItem );

   160         

   161         virtual TInt TestKeyPreviousL( CStifItemParser& aItem );

   162         virtual TInt TestKeyNextL( CStifItemParser& aItem );

   163         virtual TInt TestKeySelectL( CStifItemParser& aItem );

   164         

   165         TBool GetNextBooleanFromString( CStifItemParser& aItem, TBool& aValue );         

   166 

   167         /**

   168          * Method used to log version of test class

   169          */

   170         void SendTestClassVersion();

   171 

   172         //ADD NEW METHOD DEC HERE

   173         //[TestMethods] - Do not remove

   174 

   175     public:     // Data

   176         // ?one_line_short_description_of_data

   177         //?data_declaration;

   178 

   179     protected:  // Data

   180         // ?one_line_short_description_of_data

   181         //?data_declaration;

   182 

   183     private:    // Data

   184         

   185         // ?one_line_short_description_of_data

   186         //?data_declaration;

   187         CActivePaletteContainer* iContainer;

   188 

   189         // Reserved pointer for future extension

   190         //TAny* iReserved;

   191         

   192     public:     // Friend classes

   193         //?friend_class_declaration;

   194     protected:  // Friend classes

   195         //?friend_class_declaration;

   196     private:    // Friend classes

   197         //?friend_class_declaration;

   198     };

   199 

   200 #endif      // ACTIVEPALETTE2APITEST_H

   201 

   202 // End of File