imstutils/imconversationview/tsrc/imcvuiengine_test/inc/imcvuiengine_test.h
branchRCL_3
changeset 28 3104fc151679
parent 27 2b7283837edb
child 29 9a48e301e94b
equal deleted inserted replaced
27:2b7283837edb 28:3104fc151679
     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: imcvuiengine_test.h
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef IMCVUIENGINE_TEST_H
       
    21 #define IMCVUIENGINE_TEST_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <StifLogger.h>
       
    25 #include <TestScripterInternal.h>
       
    26 #include <StifTestModule.h>
       
    27 
       
    28 // CONSTANTS
       
    29 //const ?type ?constant_var = ?constant;
       
    30 
       
    31 // MACROS
       
    32 //#define ?macro ?macro_def
       
    33 // Logging path
       
    34 _LIT( Kimcvuiengine_testLogPath, "\\logs\\testframework\\imcvuiengine_test\\" ); 
       
    35 // Log file
       
    36 _LIT( Kimcvuiengine_testLogFile, "imcvuiengine_test.txt" ); 
       
    37 _LIT( Kimcvuiengine_testLogFileWithTitle, "imcvuiengine_test_[%S].txt" );
       
    38 
       
    39 // FUNCTION PROTOTYPES
       
    40 //?type ?function_name(?arg_list);
       
    41 
       
    42 // FORWARD DECLARATIONS
       
    43 //class ?FORWARD_CLASSNAME;
       
    44 class Cimcvuiengine_test;
       
    45 class CIMCVUiEngine_TestSendMessage;
       
    46 
       
    47 // DATA TYPES
       
    48 //enum ?declaration
       
    49 //typedef ?declaration
       
    50 //extern ?data_type;
       
    51 
       
    52 // CLASS DECLARATION
       
    53 
       
    54 /**
       
    55 *  Cimcvuiengine_test test class for STIF Test Framework TestScripter.
       
    56 *  ?other_description_lines
       
    57 *
       
    58 *  @lib ?library
       
    59 *  @since ?Series60_version
       
    60 */
       
    61 NONSHARABLE_CLASS(Cimcvuiengine_test) : public CScriptBase
       
    62     {
       
    63     public:  // Constructors and destructor
       
    64 
       
    65         /**
       
    66         * Two-phased constructor.
       
    67         */
       
    68         static Cimcvuiengine_test* NewL( CTestModuleIf& aTestModuleIf );
       
    69 
       
    70         /**
       
    71         * Destructor.
       
    72         */
       
    73         virtual ~Cimcvuiengine_test();
       
    74 
       
    75     public: // New functions
       
    76 
       
    77         /**
       
    78         * ?member_description.
       
    79         * @since ?Series60_version
       
    80         * @param ?arg1 ?description
       
    81         * @return ?description
       
    82         */
       
    83         //?type ?member_function( ?type ?arg1 );
       
    84 
       
    85     public: // Functions from base classes
       
    86 
       
    87         /**
       
    88         * From CScriptBase Runs a script line.
       
    89         * @since ?Series60_version
       
    90         * @param aItem Script line containing method name and parameters
       
    91         * @return Symbian OS error code
       
    92         */
       
    93         virtual TInt RunMethodL( CStifItemParser& aItem );
       
    94 
       
    95     protected:  // New functions
       
    96 
       
    97         /**
       
    98         * ?member_description.
       
    99         * @since ?Series60_version
       
   100         * @param ?arg1 ?description
       
   101         * @return ?description
       
   102         */
       
   103         //?type ?member_function( ?type ?arg1 );
       
   104 
       
   105     protected:  // Functions from base classes
       
   106 
       
   107         /**
       
   108         * From ?base_class ?member_description
       
   109         */
       
   110         //?type ?member_function();
       
   111 
       
   112     private:
       
   113 
       
   114         /**
       
   115         * C++ default constructor.
       
   116         */
       
   117         Cimcvuiengine_test( CTestModuleIf& aTestModuleIf );
       
   118 
       
   119         /**
       
   120         * By default Symbian 2nd phase constructor is private.
       
   121         */
       
   122         void ConstructL();
       
   123 
       
   124         // Prohibit copy constructor if not deriving from CBase.
       
   125         // ?classname( const ?classname& );
       
   126         // Prohibit assigment operator if not deriving from CBase.
       
   127         // ?classname& operator=( const ?classname& );
       
   128 
       
   129         /**
       
   130         * Frees all resources allocated from test methods.
       
   131         * @since ?Series60_version
       
   132         */
       
   133         void Delete();
       
   134 
       
   135         /**
       
   136         * Test methods are listed below. 
       
   137         */
       
   138 
       
   139 
       
   140         /**
       
   141         * StartNewConvesationL test method.
       
   142         * @since ?Series60_version
       
   143         * @param aItem Script line containing parameters.
       
   144         * @return Symbian OS error code.
       
   145         */
       
   146         virtual TInt StartNewConvesationL( CStifItemParser& aItem );
       
   147         
       
   148          /**
       
   149         * CloseConvesationL test method.
       
   150         * @since ?Series60_version
       
   151         * @param aItem Script line containing parameters.
       
   152         * @return Symbian OS error code.
       
   153         */
       
   154         virtual TInt CloseConvesationL( CStifItemParser& aItem );
       
   155         
       
   156         
       
   157         /**
       
   158         * SendNullMessageL test method.
       
   159         * @since ?Series60_version
       
   160         * @param aItem Script line containing parameters.
       
   161         * @return Symbian OS error code.
       
   162         */
       
   163         virtual TInt SendNullMessageL( CStifItemParser& aItem );
       
   164         
       
   165          /**
       
   166         * SendTextMessageL test method.
       
   167         * @since ?Series60_version
       
   168         * @param aItem Script line containing parameters.
       
   169         * @return Symbian OS error code.
       
   170         */
       
   171         virtual TInt SendTextMessageL( CStifItemParser& aItem );
       
   172 
       
   173         /**
       
   174         * SendSplCharMessageL test method.
       
   175         * @since ?Series60_version
       
   176         * @param aItem Script line containing parameters.
       
   177         * @return Symbian OS error code.
       
   178         */
       
   179         virtual TInt SendSplCharMessageL( CStifItemParser& aItem );
       
   180         
       
   181          /**
       
   182         * SendCosMessageL test method.
       
   183         * @since ?Series60_version
       
   184         * @param aItem Script line containing parameters.
       
   185         * @return Symbian OS error code.
       
   186         */
       
   187         virtual TInt SendCosMessageL( CStifItemParser& aItem );
       
   188         
       
   189         /**
       
   190         * DeactivateConvesationL test method.
       
   191         * @since ?Series60_version
       
   192         * @param aItem Script line containing parameters.
       
   193         * @return Symbian OS error code.
       
   194         */
       
   195         virtual TInt DeactivateConvesationL( CStifItemParser& aItem );
       
   196         
       
   197                
       
   198         /**
       
   199         * TestRecievedMessageL test method.
       
   200         * @since ?Series60_version
       
   201         * @param aItem Script line containing parameters.
       
   202         * @return Symbian OS error code.
       
   203         */
       
   204         virtual TInt TestMultipleSendMessageL( CStifItemParser& aItem );
       
   205         
       
   206          /**
       
   207         * TestSendRecieveMsgL test method.
       
   208         * @since ?Series60_version
       
   209         * @param aItem Script line containing parameters.
       
   210         * @return Symbian OS error code.
       
   211         */
       
   212         virtual TInt TestSendRecieveMsgL( CStifItemParser& aItem );
       
   213 
       
   214         /**
       
   215         * TestSendFetchSendMsgL test method.
       
   216         * @since ?Series60_version
       
   217         * @param aItem Script line containing parameters.
       
   218         * @return Symbian OS error code.
       
   219         */
       
   220         virtual TInt TestSendFetchSendMsgL( CStifItemParser& aItem );
       
   221         
       
   222         
       
   223           /**
       
   224         * TestFailedMsgL test method.
       
   225         * @since ?Series60_version
       
   226         * @param aItem Script line containing parameters.
       
   227         * @return Symbian OS error code.
       
   228         */
       
   229         virtual TInt TestFailedMsgL( CStifItemParser& aItem );
       
   230 
       
   231   
       
   232           /**
       
   233         * TestConnectionTerminationL test method.
       
   234         * @since ?Series60_version
       
   235         * @param aItem Script line containing parameters.
       
   236         * @return Symbian OS error code.
       
   237         */
       
   238         virtual TInt TestConnectionTerminationL( CStifItemParser& aItem );
       
   239         
       
   240          /**
       
   241         * TestLoginStateL test method.
       
   242         * @since ?Series60_version
       
   243         * @param aItem Script line containing parameters.
       
   244         * @return Symbian OS error code.
       
   245         */
       
   246         virtual TInt TestLoginStateL( CStifItemParser& aItem );
       
   247         
       
   248           /**
       
   249         * TestLoginUserIdL test method.
       
   250         * @since ?Series60_version
       
   251         * @param aItem Script line containing parameters.
       
   252         * @return Symbian OS error code.
       
   253         */
       
   254         virtual TInt TestLoginUserIdL( CStifItemParser& aItem );
       
   255         /**
       
   256          * TestLoginUserIdL test method.
       
   257          * @since ?Series60_version
       
   258          * @param aItem Script line containing parameters.
       
   259          * @return Symbian OS error code.
       
   260          */
       
   261          virtual TInt TestGetBrandIdL( CStifItemParser& aItem );
       
   262          /**
       
   263           * TestLoginUserIdL test method.
       
   264           * @since ?Series60_version
       
   265           * @param aItem Script line containing parameters.
       
   266           * @return Symbian OS error code.
       
   267           */
       
   268           virtual TInt TestGetLanguageIdL( CStifItemParser& aItem );
       
   269 
       
   270            /**
       
   271         * TestChatInterfaceL test method.
       
   272         * @since ?Series60_version
       
   273         * @param aItem Script line containing parameters.
       
   274         * @return Symbian OS error code.
       
   275         */
       
   276         virtual TInt TestChatInterfaceL( CStifItemParser& aItem );
       
   277         
       
   278         
       
   279            /**
       
   280         * TestMessageCoundL test method.
       
   281         * @since ?Series60_version
       
   282         * @param aItem Script line containing parameters.
       
   283         * @return Symbian OS error code.
       
   284         */
       
   285         virtual TInt TestMessageCoundL( CStifItemParser& aItem );
       
   286         
       
   287            /**
       
   288         * TestMessageUnreadCoundL test method.
       
   289         * @since ?Series60_version
       
   290         * @param aItem Script line containing parameters.
       
   291         * @return Symbian OS error code.
       
   292         */
       
   293         virtual TInt TestMessageUnreadCoundL( CStifItemParser& aItem );
       
   294         
       
   295        
       
   296            /**
       
   297         * TestDeleteContextL test method.
       
   298         * @since ?Series60_version
       
   299         * @param aItem Script line containing parameters.
       
   300         * @return Symbian OS error code.
       
   301         */
       
   302         virtual TInt TestDeleteContextL( CStifItemParser& aItem );
       
   303         
       
   304            /**
       
   305         * TestCreateContextL test method.
       
   306         * @since ?Series60_version
       
   307         * @param aItem Script line containing parameters.
       
   308         * @return Symbian OS error code.
       
   309         */
       
   310         virtual TInt TestCreateContextL( CStifItemParser& aItem );
       
   311         
       
   312          
       
   313         
       
   314         /**
       
   315         * TestSubscribePresenceL test method.
       
   316         * @since ?Series60_version
       
   317         * @param aItem Script line containing parameters.
       
   318         * @return Symbian OS error code.
       
   319         */
       
   320         virtual TInt TestSubscribePresenceL( CStifItemParser& aItem );
       
   321         
       
   322         
       
   323         /**
       
   324         * TestAppendInfoMessageL test method.
       
   325         * @since ?Series60_version
       
   326         * @param aItem Script line containing parameters.
       
   327         * @return Symbian OS error code.
       
   328         */
       
   329         virtual TInt TestAppendInfoMessageL( CStifItemParser& aItem );
       
   330         
       
   331         /**
       
   332         * TestGetPresenceStatusL test method.
       
   333         * @since ?Series60_version
       
   334         * @param aItem Script line containing parameters.
       
   335         * @return Symbian OS error code.
       
   336         */
       
   337         virtual TInt TestGetPresenceStatusL( CStifItemParser& aItem );
       
   338         
       
   339         
       
   340 		/**
       
   341 		* TestCCHHandlerL test method.
       
   342 		* @since ?Series60_version
       
   343 		* @param aItem Script line containing parameters.
       
   344 		* @return Symbian OS error code.
       
   345 		*/
       
   346 		virtual TInt TestCCHHandlerL( CStifItemParser& aItem );
       
   347 		
       
   348 		
       
   349 		/**
       
   350 		* TestCCHHandlerL test method.
       
   351 		* @since ?Series60_version
       
   352 		* @param aItem Script line containing parameters.
       
   353 		* @return Symbian OS error code.
       
   354 		*/
       
   355 		virtual TInt ReadyForShutdownTestL( CStifItemParser& aItem );
       
   356 		
       
   357 		
       
   358 		/**
       
   359 		* TestCCHHandlerL test method.
       
   360 		* @since ?Series60_version
       
   361 		* @param aItem Script line containing parameters.
       
   362 		* @return Symbian OS error code.
       
   363 		*/
       
   364 		virtual TInt ServiceNameTestL( CStifItemParser& aItem );
       
   365 		
       
   366 		
       
   367 		/**
       
   368 		* TestCCHHandlerL test method.
       
   369 		* @since ?Series60_version
       
   370 		* @param aItem Script line containing parameters.
       
   371 		* @return Symbian OS error code.
       
   372 		*/
       
   373 		virtual TInt OpenChatsTestL( CStifItemParser& aItem );
       
   374 		
       
   375 		
       
   376 		/**
       
   377 		* TestCCHHandlerL test method.
       
   378 		* @since ?Series60_version
       
   379 		* @param aItem Script line containing parameters.
       
   380 		* @return Symbian OS error code.
       
   381 		*/
       
   382 		virtual TInt GetServiceIdTestL( CStifItemParser& aItem );
       
   383 	
       
   384 		virtual TInt TestClosAllContainerL( CStifItemParser& aItem );
       
   385 		
       
   386 		virtual TInt TestDeleteChatL( CStifItemParser& aItem );
       
   387 		
       
   388 		virtual TInt TestEditorMessageL( CStifItemParser& aItem );
       
   389 		virtual TInt TestConvertPresCacheEnum( CStifItemParser& aItem );
       
   390                           
       
   391         //ADD NEW METHOD DEC HERE
       
   392         //[TestMethods] - Do not remove
       
   393 
       
   394     public:     // Data
       
   395         // ?one_line_short_description_of_data
       
   396         //?data_declaration;
       
   397 		CIMCVUiEngine_TestSendMessage* iSender;
       
   398     protected:  // Data
       
   399         // ?one_line_short_description_of_data
       
   400         //?data_declaration;
       
   401 
       
   402     private:    // Data
       
   403         
       
   404         
       
   405     public:     // Friend classes
       
   406         //?friend_class_declaration;
       
   407     protected:  // Friend classes
       
   408         //?friend_class_declaration;
       
   409     private:    // Friend classes
       
   410         //?friend_class_declaration;
       
   411 
       
   412     };
       
   413 
       
   414 #endif      // IMCVUIENGINE_TEST_H
       
   415 
       
   416 // End of File