loc_pub/landmarks_ui_selector_api/tsrc/bc/bcapplmkselector/inc/lmkselector.h
branchRCL_3
changeset 17 1fc85118c3ae
parent 16 8173571d354e
child 18 870918037e16
equal deleted inserted replaced
16:8173571d354e 17:1fc85118c3ae
     1 /*
       
     2 * Copyright (c) 2002 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:    LandmarkUi Content File
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 
       
    25 #ifndef LMKSELECTOR_H
       
    26 #define LMKSELECTOR_H
       
    27 
       
    28 //  INCLUDES
       
    29 #include <StifLogger.h>
       
    30 #include <TestScripterInternal.h>
       
    31 #include <StifTestModule.h>
       
    32 
       
    33 #include <clmklandmarkselectordlg.h>
       
    34 #include <clmkcategoryselectordlg.h>
       
    35 #include <tlmkitemiddbcombiinfo.h>
       
    36 
       
    37 #include "LmkEngine.h"
       
    38 
       
    39 // CONSTANTS
       
    40 //const ?type ?constant_var = ?constant;
       
    41 
       
    42 // MACROS
       
    43 //#define ?macro ?macro_def
       
    44 #define TEST_CLASS_VERSION_MAJOR 30
       
    45 #define TEST_CLASS_VERSION_MINOR 9
       
    46 #define TEST_CLASS_VERSION_BUILD 6
       
    47 
       
    48 // Logging path
       
    49 _LIT( KLmkSelectorLogPath, "\\logs\\testframework\\LmkSelector\\" );
       
    50 // Log file
       
    51 _LIT( KLmkSelectorLogFile, "LmkSelector.txt" );
       
    52 _LIT( KLmkSelectorLogFileWithTitle, "LmkSelector_[%S].txt" );
       
    53 
       
    54 // FUNCTION PROTOTYPES
       
    55 //?type ?function_name(?arg_list);
       
    56 
       
    57 // FORWARD DECLARATIONS
       
    58 //class ?FORWARD_CLASSNAME;
       
    59 class CLmkSelector;
       
    60 
       
    61 // DATA TYPES
       
    62 //enum ?declaration
       
    63 //typedef ?declaration
       
    64 //extern ?data_type;
       
    65 
       
    66 // CLASS DECLARATION
       
    67 
       
    68 /**
       
    69 *  CLmkSelector test class for STIF Test Framework TestScripter.
       
    70 *  ?other_description_lines
       
    71 *
       
    72 *  @lib ?library
       
    73 *  @since ?Series60_version
       
    74 */
       
    75 NONSHARABLE_CLASS(CLmkSelector) : public CScriptBase
       
    76     {
       
    77     public:  // Constructors and destructor
       
    78 
       
    79         /**
       
    80         * Two-phased constructor.
       
    81         */
       
    82         static CLmkSelector* NewL( CTestModuleIf& aTestModuleIf );
       
    83 
       
    84         /**
       
    85         * Destructor.
       
    86         */
       
    87         virtual ~CLmkSelector();
       
    88 
       
    89     public: // New functions
       
    90 
       
    91         /**
       
    92         * ?member_description.
       
    93         * @since ?Series60_version
       
    94         * @param ?arg1 ?description
       
    95         * @return ?description
       
    96         */
       
    97         //?type ?member_function( ?type ?arg1 );
       
    98 
       
    99     public: // Functions from base classes
       
   100 
       
   101         /**
       
   102         * From CScriptBase Runs a script line.
       
   103         * @since ?Series60_version
       
   104         * @param aItem Script line containing method name and parameters
       
   105         * @return Symbian OS error code
       
   106         */
       
   107         virtual TInt RunMethodL( CStifItemParser& aItem );
       
   108 
       
   109     protected:  // New functions
       
   110 
       
   111         /**
       
   112         * ?member_description.
       
   113         * @since ?Series60_version
       
   114         * @param ?arg1 ?description
       
   115         * @return ?description
       
   116         */
       
   117         //?type ?member_function( ?type ?arg1 );
       
   118 
       
   119     protected:  // Functions from base classes
       
   120 
       
   121         /**
       
   122         * From ?base_class ?member_description
       
   123         */
       
   124         //?type ?member_function();
       
   125 
       
   126     private:
       
   127 
       
   128         /**
       
   129         * C++ default constructor.
       
   130         */
       
   131         CLmkSelector( CTestModuleIf& aTestModuleIf );
       
   132 
       
   133         /**
       
   134         * By default Symbian 2nd phase constructor is private.
       
   135         */
       
   136         void ConstructL();
       
   137 
       
   138         // Prohibit copy constructor if not deriving from CBase.
       
   139         // ?classname( const ?classname& );
       
   140         // Prohibit assigment operator if not deriving from CBase.
       
   141         // ?classname& operator=( const ?classname& );
       
   142 
       
   143         /**
       
   144         * Frees all resources allocated from test methods.
       
   145         * @since ?Series60_version
       
   146         */
       
   147         void Delete();
       
   148 
       
   149         /**
       
   150         * Test methods are listed below.
       
   151         */
       
   152 
       
   153         /**
       
   154         * Example test method.
       
   155         * @since ?Series60_version
       
   156         * @param aItem Script line containing parameters.
       
   157         * @return Symbian OS error code.
       
   158         */
       
   159         virtual TInt ExampleL( CStifItemParser& aItem );
       
   160         virtual TInt TestLmkNewL( CStifItemParser& aItem );
       
   161         virtual TInt TestLmkSetMopParent( CStifItemParser& aItem );
       
   162         virtual TInt TestLmkExecuteLD( CStifItemParser& aItem );
       
   163         virtual TInt TestLmkExecuteLD2( CStifItemParser& aItem );
       
   164         virtual TInt TestCatNewL( CStifItemParser& aItem );
       
   165         virtual TInt TestCatSetMopParent( CStifItemParser& aItem );
       
   166         virtual TInt TestCatExecuteLD( CStifItemParser& aItem );
       
   167         virtual TInt TestCatExecuteLD2( CStifItemParser& aItem );
       
   168 
       
   169         void CreateNewLandmark();
       
   170 
       
   171         /**
       
   172          * Method used to log version of test class
       
   173          */
       
   174         void SendTestClassVersion();
       
   175 
       
   176         //ADD NEW METHOD DEC HERE
       
   177         //[TestMethods] - Do not remove
       
   178 
       
   179     public:     // Data
       
   180         // ?one_line_short_description_of_data
       
   181         //?data_declaration;
       
   182 
       
   183     protected:  // Data
       
   184         // ?one_line_short_description_of_data
       
   185         //?data_declaration;
       
   186 
       
   187     private:    // Data
       
   188     		CLmkEngine* engine;
       
   189 
       
   190         // ?one_line_short_description_of_data
       
   191         //?data_declaration;
       
   192 
       
   193         // Reserved pointer for future extension
       
   194         //TAny* iReserved;
       
   195 
       
   196     public:     // Friend classes
       
   197         //?friend_class_declaration;
       
   198     protected:  // Friend classes
       
   199         //?friend_class_declaration;
       
   200     private:    // Friend classes
       
   201         //?friend_class_declaration;
       
   202 
       
   203     };
       
   204 
       
   205 #endif      // LMKSELECTOR_H
       
   206 
       
   207 // End of File