mmappfw_plat/mpx_base_view_plugins_api/tsrc/ui_mpxbaseviewpluginstest/inc/mpxbaseviewpluginstest.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:  Cmpxbaseviewpluginstest header for STIF Test Framework TestScripter
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MPXBASEVIEWPLUGINSTEST_H
       
    21 #define MPXBASEVIEWPLUGINSTEST_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <StifLogger.h>
       
    25 #include <TestScripterInternal.h>
       
    26 #include <StifTestModule.h>
       
    27 #include <TestclassAssert.h>
       
    28 #include <mpxviewplugin.h>
       
    29 #include <mpxcustomcommandobserver.h>
       
    30 #include <e32def.h>
       
    31 #include "dummyMPXViewPlugin.h"
       
    32 // CONSTANTS
       
    33 //const ?type ?constant_var = ?constant;
       
    34 const TUid KMPXMetadataEditorDialogImplementationId  = { 0x101FFC83 };
       
    35 const TUid KMPXAudioEffectsViewImplementationId = { 0x101FFC74 };
       
    36 
       
    37 // Logging path
       
    38 _LIT( KmpxbaseviewpluginstestLogPath, "\\logs\\testframework\\mpxbaseviewpluginstest\\" ); 
       
    39 // Log file
       
    40 _LIT( KmpxbaseviewpluginstestLogFile, "mpxbaseviewpluginstest.txt" ); 
       
    41 _LIT( KmpxbaseviewpluginstestLogFileWithTitle, "mpxbaseviewpluginstest_[%S].txt" );
       
    42 
       
    43 // FUNCTION PROTOTYPES
       
    44 //?type ?function_name(?arg_list);
       
    45 
       
    46 // FORWARD DECLARATIONS
       
    47 //class ?FORWARD_CLASSNAME;
       
    48 
       
    49 
       
    50 class CMPXViewPlugin;
       
    51 class Cmpxbaseviewpluginstest;
       
    52 class Cmpxcustomcommandobservertestimp;
       
    53 // DATA TYPES
       
    54 //enum ?declaration
       
    55 //typedef ?declaration
       
    56 //extern ?data_type;
       
    57 
       
    58 // CLASS DECLARATION
       
    59 
       
    60 /**
       
    61 *  Cmpxbaseviewpluginstest test class for STIF Test Framework TestScripter.
       
    62 *  ?other_description_lines
       
    63 *
       
    64 *  @lib ?library
       
    65 *  @since ?Series60_version
       
    66 */
       
    67 NONSHARABLE_CLASS(Cmpxbaseviewpluginstest) : public CScriptBase,
       
    68 											 public MMPXCustomCommandObserver 
       
    69 											 
       
    70     {
       
    71     public:  // Constructors and destructor
       
    72 
       
    73         /**
       
    74         * Two-phased constructor.
       
    75         */
       
    76         static Cmpxbaseviewpluginstest* NewL( CTestModuleIf& aTestModuleIf );
       
    77 
       
    78         /**
       
    79         * Destructor.
       
    80         */
       
    81         virtual ~Cmpxbaseviewpluginstest();
       
    82 
       
    83     public: // New functions
       
    84 
       
    85         /**
       
    86         * ?member_description.
       
    87         * @since ?Series60_version
       
    88         * @param ?arg1 ?description
       
    89         * @return ?description
       
    90         */
       
    91         //?type ?member_function( ?type ?arg1 );
       
    92     	virtual void HandleCustomCommand( 
       
    93     	                const TUid& aUid,
       
    94     	                const TInt aCommand, 
       
    95     	                const TDesC8& aData );
       
    96     public: // Functions from base classes
       
    97 
       
    98         /**
       
    99         * From CScriptBase Runs a script line.
       
   100         * @since ?Series60_version
       
   101         * @param aItem Script line containing method name and parameters
       
   102         * @return Symbian OS error code
       
   103         */
       
   104         virtual TInt RunMethodL( CStifItemParser& aItem );
       
   105 
       
   106     protected:  // New functions
       
   107 
       
   108         /**
       
   109         * ?member_description.
       
   110         * @since ?Series60_version
       
   111         * @param ?arg1 ?description
       
   112         * @return ?description
       
   113         */
       
   114         //?type ?member_function( ?type ?arg1 );
       
   115 
       
   116     protected:  // Functions from base classes
       
   117 
       
   118         /**
       
   119         * From ?base_class ?member_description
       
   120         */
       
   121         //?type ?member_function();
       
   122 
       
   123     private:
       
   124 
       
   125         /**
       
   126         * C++ default constructor.
       
   127         */
       
   128         Cmpxbaseviewpluginstest( CTestModuleIf& aTestModuleIf );
       
   129 
       
   130         /**
       
   131         * By default Symbian 2nd phase constructor is private.
       
   132         */
       
   133         void ConstructL();
       
   134 
       
   135         // Prohibit copy constructor if not deriving from CBase.
       
   136         // ?classname( const ?classname& );
       
   137         // Prohibit assigment operator if not deriving from CBase.
       
   138         // ?classname& operator=( const ?classname& );
       
   139 
       
   140         /**
       
   141         * Frees all resources allocated from test methods.
       
   142         * @since ?Series60_version
       
   143         */
       
   144         void Delete();
       
   145 
       
   146         /**
       
   147         * Test methods are listed below. 
       
   148         */
       
   149 
       
   150         /**
       
   151         * Example test method.
       
   152         * @since ?Series60_version
       
   153         * @param aItem Script line containing parameters.
       
   154         * @return Symbian OS error code.
       
   155         */
       
   156         virtual TInt ExampleL( CStifItemParser& aItem );
       
   157        
       
   158         TInt CMPXViewPluginNewL( CStifItemParser& /*aItem*/ );
       
   159         TInt CMPXViewPluginDestruct( CStifItemParser& /*aItem*/ );
       
   160 
       
   161         TInt CMPXAknViewPluginDestruct( CStifItemParser& /*aItem*/);
       
   162         TInt CMPXAknViewPluginCreateViewL( CStifItemParser& /*aItem*/);
       
   163         TInt CMPXAknViewPluginDestroyView( CStifItemParser& /*aItem*/);
       
   164         TInt CMPXAknViewPluginActivateViewL( CStifItemParser& /*aItem*/);
       
   165         TInt CMPXAknViewPluginSetAsDefaultViewL( CStifItemParser& /*aItem*/);
       
   166         TInt CMPXAknViewPluginDeactivateView( CStifItemParser& /*aItem*/);                     
       
   167         
       
   168         TInt CMPXAknDialogPluginDestruct( CStifItemParser& aItem);
       
   169         TInt CMPXAknDialogPluginCreateViewL( CStifItemParser& /*aItem*/);
       
   170         TInt CMPXAknDialogPluginDestroyView( CStifItemParser& /*aItem*/);
       
   171         TInt CMPXAknDialogPluginActivateViewL( CStifItemParser& /*aItem*/);
       
   172         TInt CMPXAknDialogPluginSetAsDefaultViewL( CStifItemParser& /*aItem*/);
       
   173         TInt CMPXAknDialogPluginDeactivateView( CStifItemParser& /*aItem*/);                     
       
   174         TInt CDummyMPXAknViewPluginConstruct( CStifItemParser& /*aItem*/);
       
   175         TInt CDummyMPXAknDialogPluginConstruct( CStifItemParser& /*aItem*/);
       
   176         TInt CDummyMPXViewPluginDesConstruct( CStifItemParser& /*aItem*/);
       
   177         /**
       
   178          * Method used to log version of test class
       
   179          */
       
   180         //ADD NEW METHOD DEC HERE
       
   181         //[TestMethods] - Do not remove
       
   182 
       
   183         private:    // Friend classes
       
   184         //?friend_class_declaration;s
       
   185     	CMPXViewPlugin* iViewPlugin;
       
   186     	CMPXViewPlugin* idummyMPXViewPlugin;
       
   187     };
       
   188 
       
   189 #endif      // MPXBASEVIEWPLUGINSTEST_H
       
   190 
       
   191 // End of File