locsrv_plat/map_image_api/tsrc/inc/testmapimage.h
branchRCL_3
changeset 44 2b4ea9893b66
parent 42 02ba3f1733c6
child 45 6b6920c56e2f
equal deleted inserted replaced
42:02ba3f1733c6 44:2b4ea9893b66
     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: Declaration of test class for map image api
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef TESTMAPIMAGE_H
       
    21 #define TESTMAPIMAGE_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <StifLogger.h>
       
    25 #include <TestScripterInternal.h>
       
    26 #include <StifTestModule.h>
       
    27 
       
    28 
       
    29 // CONSTANTS
       
    30 //const ?type ?constant_var = ?constant;
       
    31 
       
    32 // MACROS
       
    33 //#define ?macro ?macro_def
       
    34 // Logging path
       
    35 _LIT( KtestmapimageLogPath, "\\logs\\testframework\\testmapimage\\" ); 
       
    36 // Log file
       
    37 _LIT( KtestmapimageLogFile, "testmapimage.txt" ); 
       
    38 _LIT( KtestmapimageLogFileWithTitle, "testmapimage_[%S].txt" );
       
    39 
       
    40 // FUNCTION PROTOTYPES
       
    41 //?type ?function_name(?arg_list);
       
    42 
       
    43 // FORWARD DECLARATIONS
       
    44 //class ?FORWARD_CLASSNAME;
       
    45 class Ctestmapimage;
       
    46 
       
    47 // DATA TYPES
       
    48 //enum ?declaration
       
    49 //typedef ?declaration
       
    50 //extern ?data_type;
       
    51 
       
    52 // CLASS DECLARATION
       
    53 
       
    54 /**
       
    55 *  Ctestmapimage test class for STIF Test Framework TestScripter.
       
    56 *  ?other_description_lines
       
    57 *
       
    58 *  @lib ?library
       
    59 *  @since ?Series60_version
       
    60 */
       
    61 NONSHARABLE_CLASS(Ctestmapimage) : public CScriptBase
       
    62     {
       
    63     public:  // Constructors and destructor
       
    64 
       
    65         /**
       
    66         * Two-phased constructor.
       
    67         */
       
    68         static Ctestmapimage* NewL( CTestModuleIf& aTestModuleIf );
       
    69 
       
    70         /**
       
    71         * Destructor.
       
    72         */
       
    73         virtual ~Ctestmapimage();
       
    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         Ctestmapimage( 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         * This method will install the provider application
       
   140         */
       
   141         TInt InstallProvider( CStifItemParser& /*aItem*/  );
       
   142         /**
       
   143         * Test case for CMnMapImage::NewL
       
   144         * @since ?Series60_version
       
   145         * @param aItem Script line containing parameters.
       
   146         * @return Symbian OS error code.
       
   147         */
       
   148         virtual TInt TestMapImageNewLL( CStifItemParser& aItem );
       
   149         /**
       
   150         * Test case for CMnMapImage::SetMapImageParams & CMnMapImage::MapImageParams
       
   151         * @since ?Series60_version
       
   152         * @param aItem Script line containing parameters.
       
   153         * @return Symbian OS error code.
       
   154         */
       
   155         virtual TInt TestSetMapImageParams( CStifItemParser& aItem );
       
   156          /**
       
   157         * Test case for CMnMapImage::SetShowOptions & CMnMapImage::ShowOptions
       
   158         * @since ?Series60_version
       
   159         * @param aItem Script line containing parameters.
       
   160         * @return Symbian OS error code.
       
   161         */
       
   162         virtual TInt TestSetShowOptions( CStifItemParser& aItem );
       
   163         /**
       
   164         * Test case for CMnMapImage::SetTargetOrigin & CMnMapImage::TargetOrigin
       
   165         * @since ?Series60_version
       
   166         * @param aItem Script line containing parameters.
       
   167         * @return Symbian OS error code.
       
   168         */
       
   169         virtual TInt TestSetTargetOrigin( CStifItemParser& aItem );
       
   170         /**
       
   171         * Test case for CMnMapImage::GetImageCoordinate
       
   172         * @since ?Series60_version
       
   173         * @param aItem Script line containing parameters.
       
   174         * @return Symbian OS error code.
       
   175         */
       
   176         virtual TInt TestGetImageCoordinate( CStifItemParser& aItem );
       
   177         /**
       
   178         * Test case for CMnMapImage::SupportedImageTypes
       
   179         * @since ?Series60_version
       
   180         * @param aItem Script line containing parameters.
       
   181         * @return Symbian OS error code.
       
   182         */
       
   183         virtual TInt TestSupportedImageTypes( CStifItemParser& aItem );
       
   184         /**
       
   185         * Test case for CMnMapImage::GetWorldCoordinate
       
   186         * @since ?Series60_version
       
   187         * @param aItem Script line containing parameters.
       
   188         * @return Symbian OS error code.
       
   189         */
       
   190         virtual TInt TestGetWorldCoordinate( CStifItemParser& aItem );
       
   191         /**
       
   192         * Test case for CMnMapImage::SetExitObserverL & CMnMapImage::RemoveExitObserver
       
   193         * @since ?Series60_version
       
   194         * @param aItem Script line containing parameters.
       
   195         * @return Symbian OS error code.
       
   196         */
       
   197         virtual TInt TestSetExitObserverL( CStifItemParser& aItem );
       
   198          /**
       
   199         * Test case for CMnMapImage::RenderL whose completion is informed via aStatus parameter.
       
   200         * @since ?Series60_version
       
   201         * @param aItem Script line containing parameters.
       
   202         * @return Symbian OS error code.
       
   203         */
       
   204         virtual TInt TestRender1L( CStifItemParser& aItem );
       
   205         /**
       
   206         * Test case for CMnMapImage::RenderL whose completion is informed via aCallback
       
   207         * @since ?Series60_version
       
   208         * @param aItem Script line containing parameters.
       
   209         * @return Symbian OS error code.
       
   210         */
       
   211         virtual TInt TestRender2L( CStifItemParser& aItem );
       
   212         /**
       
   213         * Test case for CMnMapImage::CancelRendering 
       
   214         * @since ?Series60_version
       
   215         * @param aItem Script line containing parameters.
       
   216         * @return Symbian OS error code.
       
   217         */
       
   218         virtual TInt TestCancelRendering( CStifItemParser& aItem );
       
   219         /**
       
   220         * Test case for constructor of TMnMapImageParams 
       
   221         * @since ?Series60_version
       
   222         * @param aItem Script line containing parameters.
       
   223         * @return Symbian OS error code.
       
   224         */
       
   225         virtual TInt TestTMnMapImageParams( CStifItemParser& aItem );
       
   226         /**
       
   227         * Test case for TMnMapImageParams::SetCenterPoint &
       
   228         * TMnMapImageParams::GetCenterPoint
       
   229         * @since ?Series60_version
       
   230         * @param aItem Script line containing parameters.
       
   231         * @return Symbian OS error code.
       
   232         */
       
   233         virtual TInt TestSetGetCenterPoint( CStifItemParser& aItem );
       
   234         /**
       
   235         * Test case for TMnMapImageParams::SetVisibleArea &
       
   236         * TMnMapImageParams::GetVisibleArea
       
   237         * @since ?Series60_version
       
   238         * @param aItem Script line containing parameters.
       
   239         * @return Symbian OS error code.
       
   240         */
       
   241         virtual TInt TestSetGetVisibleArea( CStifItemParser& aItem );
       
   242         /**
       
   243         * Test case for TMnMapImageParams::SetSize &
       
   244         * TMnMapImageParams::Size
       
   245         * @since ?Series60_version
       
   246         * @param aItem Script line containing parameters.
       
   247         * @return Symbian OS error code.
       
   248         */
       
   249         virtual TInt TestSetGetSize( CStifItemParser& aItem );
       
   250         /**
       
   251         * Test case for TMnMapImageParams::SetDirection &
       
   252         * TMnMapImageParams::Direction
       
   253         * @since ?Series60_version
       
   254         * @param aItem Script line containing parameters.
       
   255         * @return Symbian OS error code.
       
   256         */
       
   257         virtual TInt TestSetGetDirection( CStifItemParser& aItem );
       
   258         /**
       
   259         * Test case for TMnMapImageParams::SetImageType &
       
   260         * TMnMapImageParams::ImageType
       
   261         * @since ?Series60_version
       
   262         * @param aItem Script line containing parameters.
       
   263         * @return Symbian OS error code.
       
   264         */
       
   265         virtual TInt TestSetGetImageType( CStifItemParser& aItem );
       
   266         /**
       
   267         * Test case for TMnMapImageParams::SetProjectionId &
       
   268         * TMnMapImageParams::ProjectionId
       
   269         * @since ?Series60_version
       
   270         * @param aItem Script line containing parameters.
       
   271         * @return Symbian OS error code.
       
   272         */
       
   273         virtual TInt TestSetGetProjectionId( CStifItemParser& aItem );
       
   274         
       
   275         
       
   276         
       
   277         
       
   278         
       
   279         //ADD NEW METHOD DEC HERE
       
   280         //[TestMethods] - Do not remove
       
   281 
       
   282     public:     // Data
       
   283         // ?one_line_short_description_of_data
       
   284         //?data_declaration;
       
   285 
       
   286     protected:  // Data
       
   287         // ?one_line_short_description_of_data
       
   288         //?data_declaration;
       
   289 
       
   290     private:    // Data
       
   291         
       
   292     //    CTestMapImage * iMapImage;
       
   293 
       
   294     public:     // Friend classes
       
   295         //?friend_class_declaration;
       
   296     protected:  // Friend classes
       
   297         //?friend_class_declaration;
       
   298     private:    // Friend classes
       
   299         //?friend_class_declaration;
       
   300 
       
   301     };
       
   302 
       
   303 #endif      // TESTMAPIMAGE_H
       
   304 
       
   305 // End of File