mmappfw_plat/mpx_view_utility_api/tsrc/ui_mpxViewUtilityTest/inc/ui_mpxViewUtilityTest.h
changeset 0 a2952bb97e68
equal deleted inserted replaced
-1:000000000000 0:a2952bb97e68
       
     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:  ui_mpxViewUtilityTest header for STIF Test Framework TestScripter
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef ui_mpxViewUtilityTest_H
       
    21 #define ui_mpxViewUtilityTest_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <StifLogger.h>
       
    25 #include <TestScripterInternal.h>
       
    26 #include <StifTestModule.h>
       
    27 #include <TestclassAssert.h>
       
    28 #include <mpxviewutility.h>
       
    29 
       
    30 // CONSTANTS
       
    31 //const ?type ?constant_var = ?constant;
       
    32 
       
    33 // MACROS
       
    34 //#define ?macro ?macro_def
       
    35 #define TEST_CLASS_VERSION_MAJOR 0
       
    36 #define TEST_CLASS_VERSION_MINOR 0
       
    37 #define TEST_CLASS_VERSION_BUILD 0
       
    38 
       
    39 // Logging path
       
    40 _LIT( Kui_mpxViewUtilityTestLogPath, "\\logs\\testframework\\ui_mpxViewUtilityTest\\" ); 
       
    41 // Log file
       
    42 _LIT( Kui_mpxViewUtilityTestLogFile, "ui_mpxViewUtilityTest.txt" ); 
       
    43 _LIT( Kui_mpxViewUtilityTestLogFileWithTitle, "ui_mpxViewUtilityTest_[%S].txt" );
       
    44 
       
    45 // FUNCTION PROTOTYPES
       
    46 //?type ?function_name(?arg_list);
       
    47 
       
    48 // FORWARD DECLARATIONS
       
    49 //class ?FORWARD_CLASSNAME;
       
    50 class Cui_mpxViewUtilityTest;
       
    51 class MMPXViewUtility;
       
    52 
       
    53 // CLASS DECLARATION
       
    54 
       
    55 /**
       
    56 *  Cui_mpxViewUtilityTest test class for STIF Test Framework TestScripter.
       
    57 *  ?other_description_lines
       
    58 *
       
    59 *  @lib ?library
       
    60 *  @since ?Series60_version
       
    61 */
       
    62 NONSHARABLE_CLASS(Cui_mpxViewUtilityTest) : public CScriptBase
       
    63     {
       
    64     public:  // Constructors and destructor
       
    65 
       
    66         /**
       
    67         * Two-phased constructor.
       
    68         */
       
    69         static Cui_mpxViewUtilityTest* NewL( CTestModuleIf& aTestModuleIf );
       
    70 
       
    71         /**
       
    72         * Destructor.
       
    73         */
       
    74         virtual ~Cui_mpxViewUtilityTest();
       
    75 
       
    76     
       
    77 
       
    78     public: // Functions from base classes
       
    79 
       
    80         /**
       
    81         * From CScriptBase Runs a script line.
       
    82         * @since ?Series60_version
       
    83         * @param aItem Script line containing method name and parameters
       
    84         * @return Symbian OS error code
       
    85         */
       
    86         virtual TInt RunMethodL( CStifItemParser& aItem );
       
    87 
       
    88    
       
    89 
       
    90     protected:  // Functions from base classes
       
    91 
       
    92         /**
       
    93         * From ?base_class ?member_description
       
    94         */
       
    95         //?type ?member_function();
       
    96 
       
    97     private:
       
    98 
       
    99         /**
       
   100         * C++ default constructor.
       
   101         */
       
   102         Cui_mpxViewUtilityTest( CTestModuleIf& aTestModuleIf );
       
   103 
       
   104         /**
       
   105         * By default Symbian 2nd phase constructor is private.
       
   106         */
       
   107         void ConstructL();
       
   108 
       
   109         // Prohibit copy constructor if not deriving from CBase.
       
   110         // ?classname( const ?classname& );
       
   111         // Prohibit assigment operator if not deriving from CBase.
       
   112         // ?classname& operator=( const ?classname& );
       
   113 
       
   114         /**
       
   115         * Frees all resources allocated from test methods.
       
   116         * @since ?Series60_version
       
   117         */
       
   118         void Delete();
       
   119 
       
   120         /**
       
   121         * Test methods are listed below. 
       
   122         */
       
   123 
       
   124         /**
       
   125         * Example test method.
       
   126         * @since ?Series60_version
       
   127         * @param aItem Script line containing parameters.
       
   128         * @return Symbian OS error code.
       
   129         */
       
   130         TInt TestMPXViewUtility( CStifItemParser& aItem );
       
   131                 
       
   132         /**
       
   133          * Method used to log version of test class
       
   134          */
       
   135         void SendTestClassVersion();
       
   136 
       
   137       
       
   138 
       
   139   
       
   140     private:    // Friend classes
       
   141         //From mpxviewutility.h
       
   142     	MMPXViewUtility* iMPXViewUtility;
       
   143     };
       
   144 
       
   145 #endif      // ui_mpxViewUtilityTest_H
       
   146 
       
   147 // End of File