1 /*

     2 * Copyright (c) 2008 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:  Implementation of DM UI test component

    15 * 	This is part of omadmappui test application.

    16 *

    17 */

    18 

    19 

    20 

    21 

    22 #ifndef UI_DMUI_H

    23 #define UI_DMUI_H

    24 

    25 //  INCLUDES

    26 #include <StifLogger.h>

    27 #include <TestScripterInternal.h>

    28 #include <StifTestModule.h>

    29 #include <TestclassAssert.h>

    30 

    31 // CONSTANTS

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

    33 

    34 // MACROS

    35 //#define ?macro ?macro_def

    36 #define TEST_CLASS_VERSION_MAJOR 0

    37 #define TEST_CLASS_VERSION_MINOR 0

    38 #define TEST_CLASS_VERSION_BUILD 0

    39 

    40 // Logging path

    41 _LIT( Kui_dmuiLogPath, "\\logs\\testframework\\ui_dmui\\" ); 

    42 // Log file

    43 _LIT( Kui_dmuiLogFile, "ui_dmui.txt" ); 

    44 _LIT( Kui_dmuiLogFileWithTitle, "ui_dmui_[%S].txt" );

    45 

    46 // FUNCTION PROTOTYPES

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

    48 

    49 // FORWARD DECLARATIONS

    50 //class ?FORWARD_CLASSNAME;

    51 class Cui_dmui;

    52 

    53 // DATA TYPES

    54 //enum ?declaration

    55 //typedef ?declaration

    56 //extern ?data_type;

    57 

    58 // CLASS DECLARATION

    59 

    60 /**

    61 *  Cui_dmui test class for STIF Test Framework TestScripter.

    62 *  ?other_description_lines

    63 *

    64 *  @lib ?library

    65 *  @since ?Series60_version

    66 */

    67 NONSHARABLE_CLASS(Cui_dmui) : public CScriptBase

    68     {

    69     public:  // Constructors and destructor

    70 

    71         /**

    72         * Two-phased constructor.

    73         */

    74         static Cui_dmui* NewL( CTestModuleIf& aTestModuleIf );

    75 

    76         /**

    77         * Destructor.

    78         */

    79         virtual ~Cui_dmui();

    80 

    81     public: // New functions

    82 

    83         /**

    84         * ?member_description.

    85         * @since ?Series60_version

    86         * @param ?arg1 ?description

    87         * @return ?description

    88         */

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

    90 

    91     public: // Functions from base classes

    92 

    93         /**

    94         * From CScriptBase Runs a script line.

    95         * @since ?Series60_version

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

    97         * @return Symbian OS error code

    98         */

    99         virtual TInt RunMethodL( CStifItemParser& aItem );

   100 

   101     protected:  // New functions

   102 

   103         /**

   104         * ?member_description.

   105         * @since ?Series60_version

   106         * @param ?arg1 ?description

   107         * @return ?description

   108         */

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

   110 

   111     protected:  // Functions from base classes

   112 

   113         /**

   114         * From ?base_class ?member_description

   115         */

   116         //?type ?member_function();

   117 

   118     private:

   119 

   120         /**

   121         * C++ default constructor.

   122         */

   123         Cui_dmui( CTestModuleIf& aTestModuleIf );

   124 

   125         /**

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

   127         */

   128         void ConstructL();

   129 

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

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

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

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

   134 

   135         /**

   136         * Frees all resources allocated from test methods.

   137         * @since ?Series60_version

   138         */

   139         void Delete();

   140 

   141         /**

   142         * Test methods are listed below. 

   143         */

   144 

   145         /**

   146         * Example test method.

   147         * @since ?Series60_version

   148         * @param aItem Script line containing parameters.

   149         * @return Symbian OS error code.

   150         */

   151         virtual TInt ExampleL( CStifItemParser& aItem );

   152          virtual TInt LaunchserverviewL( CStifItemParser& aItem );

   153         /**

   154          * Method used to log version of test class

   155          */

   156         void SendTestClassVersion();

   157 

   158         //ADD NEW METHOD DEC HERE

   159         //[TestMethods] - Do not remove

   160 

   161     public:     // Data

   162         // ?one_line_short_description_of_data

   163         //?data_declaration;

   164 

   165     protected:  // Data

   166         // ?one_line_short_description_of_data

   167         //?data_declaration;

   168 

   169     private:    // Data

   170         

   171         // ?one_line_short_description_of_data

   172         //?data_declaration;

   173 

   174         // Reserved pointer for future extension

   175         //TAny* iReserved;

   176 

   177     public:     // Friend classes

   178         //?friend_class_declaration;

   179     protected:  // Friend classes

   180         //?friend_class_declaration;

   181     private:    // Friend classes

   182         //?friend_class_declaration;

   183 

   184     };

   185 

   186 #endif      // UI_DMUI_H

   187 

   188 // End of File