classicui_pub/toolbar_api/tsrc/inc/testsdktoolbar.h
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     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:  test AknToolbar.h,akntoolbarextension.h and AknToolbarObserver.h
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef C_TESTSDKTOOLBAR_H
       
    21 #define C_TESTSDKTOOLBAR_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <stiflogger.h>
       
    25 #include <testscripterinternal.h>
       
    26 #include <stiftestmodule.h>
       
    27 #include <testclassassert.h>
       
    28 
       
    29 // MACROS
       
    30 #define TEST_CLASS_VERSION_MAJOR 0
       
    31 #define TEST_CLASS_VERSION_MINOR 0
       
    32 #define TEST_CLASS_VERSION_BUILD 0
       
    33 
       
    34 // Logging path
       
    35 _LIT( KTestSDKToolbarLogPath, "\\logs\\testframework\\testsdktoolbar\\" ); 
       
    36 // Log file
       
    37 _LIT( KTestSDKToolbarLogFile, "testsdktoolbar.txt" ); 
       
    38 _LIT( KTestSDKToolbarLogFileWithTitle, "testsdktoolbar_[%S].txt" );
       
    39 
       
    40 /**
       
    41 *  CTestSDKToolbar test class for STIF Test Framework TestScripter.
       
    42 *  @since S60 5.0
       
    43 */
       
    44 NONSHARABLE_CLASS( CTestSDKToolbar ) : public CScriptBase
       
    45     {
       
    46 public:  // Constructors and destructor
       
    47 
       
    48     /**
       
    49     * Two-phased constructor.
       
    50     */
       
    51     static CTestSDKToolbar* NewL( CTestModuleIf& aTestModuleIf );
       
    52 
       
    53     /**
       
    54     * Destructor.
       
    55     */
       
    56     virtual ~CTestSDKToolbar();
       
    57 
       
    58 public: // Functions from base classes
       
    59 
       
    60     /**
       
    61     * From CScriptBase Runs a script line.
       
    62     * @since S60 5.0
       
    63     * @param aItem Script line containing method name and parameters
       
    64     * @return Symbian OS error code
       
    65     */
       
    66     virtual TInt RunMethodL( CStifItemParser& aItem );
       
    67 
       
    68 private:
       
    69 
       
    70     /**
       
    71     * C++ default constructor.
       
    72     */
       
    73     CTestSDKToolbar( CTestModuleIf& aTestModuleIf );
       
    74 
       
    75     /**
       
    76     * By default Symbian 2nd phase constructor is private.
       
    77     */
       
    78     void ConstructL();
       
    79 
       
    80     /**
       
    81      * Method used to log version of test class
       
    82      */
       
    83     void SendTestClassVersion();
       
    84     
       
    85         /**
       
    86      * Turn off ScreenSaver
       
    87      * @since S60 5.0
       
    88      * @return Symbian OS error code.
       
    89      */
       
    90     void TurnOffScreenSaver();
       
    91 
       
    92     /**
       
    93      * Restore ScreenSaver
       
    94      * @since S60 5.0
       
    95      * @return Symbian OS error code.
       
    96      */
       
    97     void RestoreScreenSaver();
       
    98 
       
    99 private: // Test Methods in akntoolbar.h
       
   100 
       
   101     /**
       
   102     * test NewL function of AknToolbar
       
   103     * @since S60 5.0
       
   104     * @param aItem never used.
       
   105     * @return Symbian OS error code.
       
   106     */
       
   107     virtual TInt TestToolbarNewL( CStifItemParser& aItem );
       
   108 
       
   109     /**
       
   110     * test NewLC function of AknToolbar
       
   111     * @since S60 5.0
       
   112     * @param aItem never used.
       
   113     * @return Symbian OS error code.
       
   114     */
       
   115     virtual TInt TestToolbarNewLCL( CStifItemParser& aItem );
       
   116 
       
   117     /**
       
   118     * test CountComponentControls function of AknToolbar
       
   119     * @since S60 5.0
       
   120     * @param aItem never used.
       
   121     * @return Symbian OS error code.
       
   122     */
       
   123     virtual TInt TestToolbarCountComponentControlsL( CStifItemParser& aItem );
       
   124 
       
   125     /**
       
   126     * test ComponentControl function of AknToolbar
       
   127     * @since S60 5.0
       
   128     * @param aItem never used.
       
   129     * @return Symbian OS error code.
       
   130     */
       
   131     virtual TInt TestToolbarComponentControlL( CStifItemParser& aItem );
       
   132 
       
   133     /**
       
   134     * test HandlePointerEventL function of AknToolbar
       
   135     * @since S60 5.0
       
   136     * @param aItem never used.
       
   137     * @return Symbian OS error code.
       
   138     */
       
   139     virtual TInt TestToolbarHandlePointerEventL( CStifItemParser& aItem );
       
   140 
       
   141     /**
       
   142     * test HandleResourceChange function of AknToolbar
       
   143     * @since S60 5.0
       
   144     * @param aItem never used.
       
   145     * @return Symbian OS error code.
       
   146     */
       
   147     virtual TInt TestToolbarHandleResourceChangeL( CStifItemParser& aItem );
       
   148 
       
   149     /**
       
   150     * test HandleControlEventL function of AknToolbar
       
   151     * @since S60 5.0
       
   152     * @param aItem never used.
       
   153     * @return Symbian OS error code.
       
   154     */
       
   155     virtual TInt TestToolbarHandleControlEventL( CStifItemParser& aItem );
       
   156 
       
   157     /**
       
   158     * test PositionChanged function of AknToolbar
       
   159     * @since S60 5.0
       
   160     * @param aItem never used.
       
   161     * @return Symbian OS error code.
       
   162     */
       
   163     virtual TInt TestToolbarPositionChangedL( CStifItemParser& aItem );
       
   164 
       
   165     /**
       
   166     * test ProcessCommandL function of AknToolbar
       
   167     * @since S60 5.0
       
   168     * @param aItem never used.
       
   169     * @return Symbian OS error code.
       
   170     */
       
   171     virtual TInt TestToolbarProcessCommandL( CStifItemParser& aItem );
       
   172 
       
   173     /**
       
   174     * test SetDimmed function of AknToolbar
       
   175     * @since S60 5.0
       
   176     * @param aItem never used.
       
   177     * @return Symbian OS error code.
       
   178     */
       
   179     virtual TInt TestToolbarSetDimmedL( CStifItemParser& aItem );
       
   180 
       
   181     /**
       
   182     * test OfferKeyEventL function of AknToolbar
       
   183     * @since S60 5.0
       
   184     * @param aItem never used.
       
   185     * @return Symbian OS error code.
       
   186     */
       
   187     virtual TInt TestToolbarOfferKeyEventL( CStifItemParser& aItem );
       
   188 
       
   189     /**
       
   190     * test InputCapabilities function of AknToolbar
       
   191     * @since S60 5.0
       
   192     * @param aItem never used.
       
   193     * @return Symbian OS error code.
       
   194     */
       
   195     virtual TInt TestToolbarInputCapabilitiesL( CStifItemParser& aItem );
       
   196 
       
   197     /**
       
   198     * test Draw function of AknToolbar
       
   199     * @since S60 5.0
       
   200     * @param aItem never used.
       
   201     * @return Symbian OS error code.
       
   202     */
       
   203     virtual TInt TestToolbarDrawL( CStifItemParser& aItem );
       
   204 
       
   205     /**
       
   206     * test ControlOrNull function of AknToolbar
       
   207     * @since S60 5.0
       
   208     * @param aItem never used.
       
   209     * @return Symbian OS error code.
       
   210     */
       
   211     virtual TInt TestToolbarControlOrNullL( CStifItemParser& aItem );
       
   212 
       
   213     /**
       
   214     * test SetToolbarVisibility function of AknToolbar
       
   215     * @since S60 5.0
       
   216     * @param aItem never used.
       
   217     * @return Symbian OS error code.
       
   218     */
       
   219     virtual TInt TestToolbarSetToolbarVisibilityL( CStifItemParser& aItem );
       
   220 
       
   221     /**
       
   222     * test SetItemDimmed function of AknToolbar
       
   223     * @since S60 5.0
       
   224     * @param aItem never used.
       
   225     * @return Symbian OS error code.
       
   226     */
       
   227     virtual TInt TestToolbarSetItemDimmedL( CStifItemParser& aItem );
       
   228 
       
   229     /**
       
   230     * test HideItem function of AknToolbar
       
   231     * @since S60 5.0
       
   232     * @param aItem never used.
       
   233     * @return Symbian OS error code.
       
   234     */
       
   235     virtual TInt TestToolbarHideItemL( CStifItemParser& aItem );
       
   236 
       
   237     /**
       
   238     * test SetToolbarObserver function of AknToolbar
       
   239     * @since S60 5.0
       
   240     * @param aItem never used.
       
   241     * @return Symbian OS error code.
       
   242     */
       
   243     virtual TInt TestToolbarSetToolbarObserverL( CStifItemParser& aItem );
       
   244 
       
   245     /**
       
   246     * test ToolbarObserver function of AknToolbar
       
   247     * @since S60 5.0
       
   248     * @param aItem never used.
       
   249     * @return Symbian OS error code.
       
   250     */
       
   251     virtual TInt TestToolbarToolbarObserverL( CStifItemParser& aItem );
       
   252 
       
   253     /**
       
   254     * test AddItemL function of AknToolbar
       
   255     * @since S60 5.0
       
   256     * @param aItem never used.
       
   257     * @return Symbian OS error code.
       
   258     */
       
   259     virtual TInt TestToolbarAddItemL( CStifItemParser& aItem );
       
   260 
       
   261     /**
       
   262     * test RemoveItem function of AknToolbar
       
   263     * @since S60 5.0
       
   264     * @param aItem never used.
       
   265     * @return Symbian OS error code.
       
   266     */
       
   267     virtual TInt TestToolbarRemoveItemL( CStifItemParser& aItem );
       
   268 
       
   269     /**
       
   270     * test IsSupportedItemType function of AknToolbar
       
   271     * @since S60 5.0
       
   272     * @param aItem never used.
       
   273     * @return Symbian OS error code.
       
   274     */
       
   275     virtual TInt TestToolbarIsSupportedItemTypeL( CStifItemParser& aItem );
       
   276 
       
   277     /**
       
   278     * test SetInitialFocusedItem function of AknToolbar
       
   279     * @since S60 5.0
       
   280     * @param aItem never used.
       
   281     * @return Symbian OS error code.
       
   282     */
       
   283     virtual TInt TestToolbarSetInitialFocusedItemL( CStifItemParser& aItem );
       
   284 
       
   285     /**
       
   286     * test SetEmphasis function of AknToolbar
       
   287     * @since S60 5.0
       
   288     * @param aItem never used.
       
   289     * @return Symbian OS error code.
       
   290     */
       
   291     virtual TInt TestToolbarSetEmphasisL( CStifItemParser& aItem );
       
   292 
       
   293     /**
       
   294     * test IsShown function of AknToolbar
       
   295     * @since S60 5.0
       
   296     * @param aItem never used.
       
   297     * @return Symbian OS error code.
       
   298     */
       
   299     virtual TInt TestToolbarIsShownL( CStifItemParser& aItem );
       
   300 
       
   301     /**
       
   302     * test SetWithSliding function of AknToolbar
       
   303     * @since S60 5.0
       
   304     * @param aItem never used.
       
   305     * @return Symbian OS error code.
       
   306     */
       
   307     virtual TInt TestToolbarSetWithSlidingL( CStifItemParser& aItem );
       
   308 
       
   309     /**
       
   310     * test SetCloseOnCommand function of AknToolbar
       
   311     * @since S60 5.0
       
   312     * @param aItem never used.
       
   313     * @return Symbian OS error code.
       
   314     */
       
   315     virtual TInt TestToolbarSetCloseOnCommandL( CStifItemParser& aItem );
       
   316 
       
   317     /**
       
   318     * test SetCloseOnAllCommands function of AknToolbar
       
   319     * @since S60 5.0
       
   320     * @param aItem never used.
       
   321     * @return Symbian OS error code.
       
   322     */
       
   323     virtual TInt TestToolbarSetCloseOnAllCommandsL( CStifItemParser& aItem );
       
   324 
       
   325     /**
       
   326     * test SetOrientation function of AknToolbar
       
   327     * @since S60 5.0
       
   328     * @param aItem never used.
       
   329     * @return Symbian OS error code.
       
   330     */
       
   331     virtual TInt TestToolbarSetOrientationL( CStifItemParser& aItem );
       
   332 
       
   333     /**
       
   334     * test UpdateBackground function of AknToolbar
       
   335     * @since S60 5.0
       
   336     * @param aItem never used.
       
   337     * @return Symbian OS error code.
       
   338     */
       
   339     virtual TInt TestToolbarUpdateBackgroundL( CStifItemParser& aItem );
       
   340 
       
   341     /**
       
   342     * test DisableToolbarL function of AknToolbar
       
   343     * @since S60 5.0
       
   344     * @param aItem never used.
       
   345     * @return Symbian OS error code.
       
   346     */
       
   347     virtual TInt TestToolbarDisableToolbarL( CStifItemParser& aItem );
       
   348 
       
   349     /**
       
   350     * test IsToolbarDisabled function of AknToolbar
       
   351     * @since S60 5.0
       
   352     * @param aItem never used.
       
   353     * @return Symbian OS error code.
       
   354     */
       
   355     virtual TInt TestToolbarIsToolbarDisabledL( CStifItemParser& aItem );
       
   356 
       
   357     /**
       
   358     * test SetFocusedItemL function of AknToolbar
       
   359     * @since S60 5.0
       
   360     * @param aItem never used.
       
   361     * @return Symbian OS error code.
       
   362     */
       
   363     virtual TInt TestToolbarSetFocusedItemL( CStifItemParser& aItem );
       
   364 
       
   365     /**
       
   366     * test FocusedItem function of AknToolbar
       
   367     * @since S60 5.0
       
   368     * @param aItem never used.
       
   369     * @return Symbian OS error code.
       
   370     */
       
   371     virtual TInt TestToolbarFocusedItemL( CStifItemParser& aItem );
       
   372 
       
   373     /**
       
   374     * test EventModifiers function of AknToolbar
       
   375     * @since S60 5.0
       
   376     * @param aItem never used.
       
   377     * @return Symbian OS error code.
       
   378     */
       
   379     virtual TInt TestToolbarEventModifiersL( CStifItemParser& aItem );
       
   380 
       
   381     /**
       
   382     * test ToolbarFlags function of AknToolbar
       
   383     * @since S60 5.0
       
   384     * @param aItem never used.
       
   385     * @return Symbian OS error code.
       
   386     */
       
   387     virtual TInt TestToolbarToolbarFlagsL( CStifItemParser& aItem );
       
   388 
       
   389     /**
       
   390     * test SetSoftkeyResourceIdL function of AknToolbar
       
   391     * @since S60 5.0
       
   392     * @param aItem never used.
       
   393     * @return Symbian OS error code.
       
   394     */
       
   395     virtual TInt TestToolbarSetSoftkeyResourceIdL( CStifItemParser& aItem );
       
   396 
       
   397     /**
       
   398     * test ToolbarExtension function of AknToolbar
       
   399     * @since S60 5.0
       
   400     * @param aItem never used.
       
   401     * @return Symbian OS error code.
       
   402     */
       
   403     virtual TInt TestToolbarToolbarExtensionL( CStifItemParser& aItem );
       
   404 
       
   405     /**
       
   406     * test HideItemsAndDrawOnlyBackground function of AknToolbar
       
   407     * @since S60 5.0
       
   408     * @param aItem never used.
       
   409     * @return Symbian OS error code.
       
   410     */
       
   411     virtual TInt TestToolbarHideItemsAndDrawOnlyBackgroundL( CStifItemParser& aItem );
       
   412 
       
   413     /**
       
   414     * test SizeChanged function of AknToolbar
       
   415     * @since S60 5.0
       
   416     * @param aItem never used.
       
   417     * @return Symbian OS error code.
       
   418     */
       
   419     virtual TInt TestToolbarSizeChangedL( CStifItemParser& aItem );
       
   420 
       
   421     /**
       
   422     * test FocusChanged function of AknToolbar
       
   423     * @since S60 5.0
       
   424     * @param aItem never used.
       
   425     * @return Symbian OS error code.
       
   426     */
       
   427     virtual TInt TestToolbarFocusChangedL( CStifItemParser& aItem );
       
   428 
       
   429     /**
       
   430     * test ExtensionInterface function of AknToolbar
       
   431     * @since S60 5.0
       
   432     * @param aItem never used.
       
   433     * @return Symbian OS error code.
       
   434     */
       
   435     virtual TInt TestToolbarExtensionInterfaceL( CStifItemParser& aItem );
       
   436 
       
   437     /**
       
   438     * test MopSupplyObject function of AknToolbar
       
   439     * @since S60 5.0
       
   440     * @param aItem never used.
       
   441     * @return Symbian OS error code.
       
   442     */
       
   443     virtual TInt TestToolbarMopSupplyObjectL( CStifItemParser& aItem );
       
   444 
       
   445 private: // Test Methods in akntoolbarextension.h
       
   446 
       
   447     /**
       
   448     * test NewL function of AknToolbarExtension
       
   449     * @since S60 5.0
       
   450     * @param aItem never used.
       
   451     * @return Symbian OS error code.
       
   452     */
       
   453     virtual TInt TestToolbarExtNewL( CStifItemParser& aItem );
       
   454 
       
   455     /**
       
   456     * test NewLC function of AknToolbarExtension
       
   457     * @since S60 5.0
       
   458     * @param aItem never used.
       
   459     * @return Symbian OS error code.
       
   460     */
       
   461     virtual TInt TestToolbarExtNewLCL( CStifItemParser& aItem );
       
   462 
       
   463     /**
       
   464     * test AddItemL function of AknToolbarExtension
       
   465     * @since S60 5.0
       
   466     * @param aItem never used.
       
   467     * @return Symbian OS error code.
       
   468     */
       
   469     virtual TInt TestToolbarExtAddItemL( CStifItemParser& aItem );
       
   470 
       
   471     /**
       
   472     * test ControlOrNull function of AknToolbarExtension
       
   473     * @since S60 5.0
       
   474     * @param aItem never used.
       
   475     * @return Symbian OS error code.
       
   476     */
       
   477     virtual TInt TestToolbarExtControlOrNullL( CStifItemParser& aItem );
       
   478 
       
   479     /**
       
   480     * test RemoveItemL function of AknToolbarExtension
       
   481     * @since S60 5.0
       
   482     * @param aItem never used.
       
   483     * @return Symbian OS error code.
       
   484     */
       
   485     virtual TInt TestToolbarExtRemoveItemL( CStifItemParser& aItem );
       
   486 
       
   487     /**
       
   488     * test SetShown function of AknToolbarExtension
       
   489     * @since S60 5.0
       
   490     * @param aItem never used.
       
   491     * @return Symbian OS error code.
       
   492     */
       
   493     virtual TInt TestToolbarExtSetShownL( CStifItemParser& aItem );
       
   494 
       
   495     /**
       
   496     * test IsShown function of AknToolbarExtension
       
   497     * @since S60 5.0
       
   498     * @param aItem never used.
       
   499     * @return Symbian OS error code.
       
   500     */
       
   501     virtual TInt TestToolbarExtIsShownL( CStifItemParser& aItem );
       
   502 
       
   503     /**
       
   504     * test SetItemDimmed function of AknToolbarExtension
       
   505     * @since S60 5.0
       
   506     * @param aItem never used.
       
   507     * @return Symbian OS error code.
       
   508     */
       
   509     virtual TInt TestToolbarExtSetItemDimmedL( CStifItemParser& aItem );
       
   510 
       
   511     /**
       
   512     * test HideItemL function of AknToolbarExtension
       
   513     * @since S60 5.0
       
   514     * @param aItem never used.
       
   515     * @return Symbian OS error code.
       
   516     */
       
   517     virtual TInt TestToolbarExtHideItemL( CStifItemParser& aItem );
       
   518 
       
   519 private: // Test Methods in akntoolbarobserver.h
       
   520 
       
   521     /**
       
   522     * test DynInitToolbarL function of AknToolbarObserver
       
   523     * @since S60 5.0
       
   524     * @param aItem never used.
       
   525     * @return Symbian OS error code.
       
   526     */
       
   527     virtual TInt TestToolbarObserverDynInitToolbarL( CStifItemParser& aItem );
       
   528 
       
   529     /**
       
   530     * test DynInitToolbarL function of AknToolbarObserver
       
   531     * @since S60 5.0
       
   532     * @param aItem never used.
       
   533     * @return Symbian OS error code.
       
   534     */
       
   535     virtual TInt TestToolbarObserverReservedL( CStifItemParser& aItem );
       
   536 
       
   537     /**
       
   538     * test DynInitToolbarL function of AknToolbarObserver
       
   539     * @since S60 5.0
       
   540     * @param aItem never used.
       
   541     * @return Symbian OS error code.
       
   542     */
       
   543     virtual TInt TestToolbarObserverReservedTwoL( CStifItemParser& aItem );
       
   544 
       
   545 private:    // Data
       
   546 
       
   547     /**
       
   548      * ScreenSaver Property
       
   549      */
       
   550     TInt iOldScreenSaverProperty;
       
   551 
       
   552     // Resource file offset
       
   553     TInt iOffset;
       
   554     };
       
   555 
       
   556 #endif      // C_TESTSDKTOOLBAR_H
       
   557 
       
   558 // End of File