/*

* Copyright (c) 2002 - 2007 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  test ui framework utilities api

*

*/

#ifndef C_TESTSDKUIFWUTIL_H

#define C_TESTSDKUIFWUTIL_H

//  INCLUDES

#include <stiflogger.h>

#include <testscripterinternal.h>

#include <stiftestmodule.h>

#include <testclassassert.h>

#include <aknbiditextutils.h>

#include <aknenv.h>

#include <e32base.h>

#include <akniconarray.h>

#include <aknutils.h>

#include <coemain.h>

#include <aknindicatorcontainer.h>

#include <akneditstateindicator.h>

#include <barsread.h>

#include <coemain.h>

#include "testsdkuifwutilview.h"

#include "testsdkuifwutilcontainer.h"

// MACROS

#define TEST_CLASS_VERSION_MAJOR 0

#define TEST_CLASS_VERSION_MINOR 0

#define TEST_CLASS_VERSION_BUILD 0

// Logging path

_LIT( KtestsdkuifwutilLogPath, "\\logs\\testframework\\testsdkuifwutil\\" ); 

// Log file

_LIT( KtestsdkuifwutilLogFile, "testsdkuifwutil.txt" ); 

_LIT( KtestsdkuifwutilLogFileWithTitle, "testsdkuifwutil_[%S].txt" );

/**

*  CTestSDKUiFwUtil test class for STIF Test Framework TestScripter.

*  @since S60 5.0

*/

NONSHARABLE_CLASS( CTestSDKUiFwUtil ) : public CScriptBase

    {

public:  // Constructors and destructor

    /**

    * Two-phased constructor.

    */

    static CTestSDKUiFwUtil* NewL( CTestModuleIf& aTestModuleIf );

    /**

    * Destructor.

    */

    virtual ~CTestSDKUiFwUtil();

public: // Functions from base classes

    /**

    * From CScriptBase Runs a script line.

    * @since S60 5.0

    * @param aItem Script line containing method name and parameters

    * @return Symbian OS error code

    */

    virtual TInt RunMethodL( CStifItemParser& aItem );

private:

    /**

    * C++ default constructor.

    */

    CTestSDKUiFwUtil( CTestModuleIf& aTestModuleIf );

    /**

    * By default Symbian 2nd phase constructor is private.

    */

    void ConstructL();

    /**

     * Method used to log version of test class

     */

    void SendTestClassVersion();

        /**

     * Turn off ScreenSaver

     * @since S60 5.0

     * @return Symbian OS error code.

     */

    void TurnOffScreenSaver();

    /**

     * Restore ScreenSaver

     * @since S60 5.0

     * @return Symbian OS error code.

     */

    void RestoreScreenSaver();

private: // [TestMethods]

    /**

    * TestAknBidiTextUtilsConvertToVisualAndClipL test ConvertToVisualAndClipL

    * of AknBidiTextUtils in aknbiditextutils.h

    * @since S60 5.0

    * @param aItem is a number, 0 test ConvertToVisualAndClipL, 1 test ConvertToVisualAndClip.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknBidiTextUtilsConvertToVisualAndClipL( CStifItemParser& aItem );

    /**

    * TestAknBidiTextUtilsPrepareRunInfoArray test PrepareRunInfoArray

    * of AknBidiTextUtils in aknbiditextutils.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknBidiTextUtilsPrepareRunInfoArray( CStifItemParser& aItem );

    /**

    * TestAknBidiTextUtilsConvertToVisualAndWrapToArrayL test two ConvertToVisualAndWrapToArrayL

    * of AknBidiTextUtils in aknbiditextutils.h

    * @since S60 5.0

    * @param aItem is a number, 0 test function wiht line width array, 1 test the other.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknBidiTextUtilsConvertToVisualAndWrapToArrayL( CStifItemParser& aItem );

    /**

    * TestAknBidiTextUtilsConvertToVisualAndChopToArrayL test two ConvertToVisualAndChopToArrayL

    * of AknBidiTextUtils in aknbiditextutils.h

    * @since S60 5.0

    * @param aItem is a number, 0 test function wiht line width array, 1 test the other.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknBidiTextUtilsConvertToVisualAndChopToArrayL( CStifItemParser& aItem );

    /**

    * TestAknBidiTextUtilsConvertToVisualAndWrapToStringL test ConvertToVisualAndWrapToStringL

    * of AknBidiTextUtils in aknbiditextutils.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknBidiTextUtilsConvertToVisualAndWrapToStringL( CStifItemParser& aItem );

    /**

    * TestAknBidiTextUtilsConvertToVisualAndWrapToArrayWholeTextL test ConvertToVisualAndWrapToArrayWholeTextL

    * of AknBidiTextUtils in aknbiditextutils.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknBidiTextUtilsConvertToVisualAndWrapToArrayWholeTextL( CStifItemParser& aItem );

    /**

    * TestAknBidiTextUtilsMeasureTextBoundsWidth test MeasureTextBoundsWidth

    * of AknBidiTextUtils in aknbiditextutils.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknBidiTextUtilsMeasureTextBoundsWidth( CStifItemParser& aItem );

    /**

    * TestAknEnvStatic test Static

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvStatic( CStifItemParser& aItem );

    /**

    * TestAknEnvExecuteEmptyPopupListL test ExecuteEmptyPopupListL

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is a number, 0 test function with only on parameter, 1test the other.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvExecuteEmptyPopupListL( CStifItemParser& aItem );

    /**

    * TestAknEnvSetAndGetObserverL test SetFepMenuObserver and FepMenuObserver

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvSetAndGetObserverL( CStifItemParser& aItem );

    /**

    * TestAknEnvEditingStateIndicator test EditingStateIndicator

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvEditingStateIndicator( CStifItemParser& aItem );

    /**

    * TestAknEnvSwapEditingStateIndicatorL test SwapEditingStateIndicatorL

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvSwapEditingStateIndicatorL( CStifItemParser& aItem );

    /**

    * TestAknEnvExitForegroundAppL test ExitForegroundAppL 

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvExitForegroundAppL( CStifItemParser& aItem );

    /**

    * TestAknEnvRegisterIntermediateStateL test RegisterIntermediateStateL 

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvRegisterIntermediateStateL( CStifItemParser& aItem );

    /**

    * TestAknEnvUnRegisterIntermediateStateL test UnRegisterIntermediateState 

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvUnRegisterIntermediateStateL( CStifItemParser& aItem );

    /**

    * TestAknEnvCloseAllIntermediateStates test CloseAllIntermediateStates 

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvCloseAllIntermediateStates( CStifItemParser& aItem );

    /**

    * TestAknEnvRunAppShutterL test RunAppShutter 

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvRunAppShutterL( CStifItemParser& aItem );

    /**

    * TestAknEnvAppWithShutterRunningL test AppWithShutterRunning 

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvAppWithShutterRunningL( CStifItemParser& aItem );

    /**

    * TestAknEnvStopSchedulerWaitWithBusyMessage test StopSchedulerWaitWithBusyMessage 

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvStopSchedulerWaitWithBusyMessage( CStifItemParser& aItem );

    /**

    * TestAknEnvProcessObserverL test CreateCbaObserverL, RemoveCbaObserver and InformCbaDeletion

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvProcessObserverL( CStifItemParser& aItem );

    /**

    * TestAknEnvProcessCommandMediationL test RequestCommandMediationL and EndCommandMediation

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvProcessCommandMediationL( CStifItemParser& aItem );

    /**

    * TestAknEnvGetCurrentLayoutId test GetCurrentLayoutId

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvGetCurrentLayoutId( CStifItemParser& aItem );

    /**

    * TestAknEnvGetCurrentGlobalUiZoom test GetCurrentGlobalUiZoom

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvGetCurrentGlobalUiZoom( CStifItemParser& aItem );

    /**

    * TestAknEnvStatusPaneResIdForCurrentLayout test StatusPaneResIdForCurrentLayout

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvStatusPaneResIdForCurrentLayout( CStifItemParser& aItem );

    /**

    * TestAknEnvRequestWsBuffer test RequestWsBuffer and CancelWsBufferRequest

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvRequestWsBuffer( CStifItemParser& aItem );

    /**

    * TestAknEnvSettingCache test SettingCache

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvSettingCache( CStifItemParser& aItem );

    /**

    * TestAknEnvLoadAknLayoutL test two LoadAknLayoutL functions and AknLayout

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvLoadAknLayoutL( CStifItemParser& aItem );

    /**

    * TestAknEnvAvkonColor test AvkonColor

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvAvkonColor( CStifItemParser& aItem );

    /**

    * TestAknEnvSplitViewActive test SplitViewActive

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvSplitViewActive( CStifItemParser& aItem );

    /**

    * TestAknEnvTransparencyEnabled test TransparencyEnabled

    * of CAknEnv in aknenv.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknEnvTransparencyEnabled( CStifItemParser& aItem );

    /**

    * TestCAknIconArrayConstructor test CAknIconArray

    * of CAknEnv in akniconarray.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestCAknIconArrayConstructorL( CStifItemParser& aItem );

    /**

    * TestCAknIconArrayConstructFromResourceL test two ConstructFromResourceL

    * of CAknEnv in akniconarray.h

    * @since S60 5.0

    * @param aItem is a number, 0 test Construct From Resource, 

    * 1 test Construct From Reader.

    * @return Symbian OS error code.

    */

    virtual TInt TestCAknIconArrayConstructFromResourceL( CStifItemParser& aItem );

    /**

    * TestCAknIconArrayAppendFromResourceL test two AppendFromResourceL

    * of CAknEnv in akniconarray.h

    * @since S60 5.0

    * @param aItem is a number, 0 test append From Resource, 

    * 1 test append From Reader.

    * @return Symbian OS error code.

    */

    virtual TInt TestCAknIconArrayAppendFromResourceL( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsClipToFitL test three ClipToFit

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is a number, 

    * 0 test function with default parameter 

    * 1 test function with CEikColumnListBox parameter

    * 2 test function with CEikFormattedCellListBox parameter 

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsClipToFitL( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsWrapToArrayL test two WrapToArrayL

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is a number, 0 test function with CArrayFix<TInt> parameters, 

    * 1 test the other.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsWrapToArrayL( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsWrapToArrayAndClipL test WrapToArrayAndClipL

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is not used

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsWrapToArrayAndClipL( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsChopToArrayAndClipL test two ChopToArrayAndClipL

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is a number, 0 test function with CArrayFix<TInt> parameters, 

    * 1 test the other.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsChopToArrayAndClipL( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsWrapToStringL test WrapToStringL

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is not used

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsWrapToStringL( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsWrapToStringAndClipL test WrapToStringAndClipL

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is not used

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsWrapToStringAndClipL( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsProcessCharacters test three function

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is a number, 

    * 0 test function StripCharacters

    * 1 test function ReplaceCharacters

    * 2 test function PackWhiteSpaces

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsProcessCharacters( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsLanguageSpecificNumberConversion test LanguageSpecificNumberConversion

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is not used

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsLanguageSpecificNumberConversion( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsConvertDigitsTo test ConvertDigitsTo

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is not used

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsConvertDigitsTo( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsCurrentScriptDirectionality test CurrentScriptDirectionality

    * of AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is not used

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsCurrentScriptDirectionality( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsNumericEditorDigitType test NumericEditorDigitType of 

    * AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsNumericEditorDigitType( CStifItemParser& aItem );

    /**

    * TestCAknTextUtilsDisplayTextLanguageSpecificNumberConversion test 

    * DisplayTextLanguageSpecificNumberConversion of

    * AknTextUtils in aknutils.h

    * @since S60 5.0

    * @param aItem is not used.

    * @return Symbian OS error code.

    */

    virtual TInt TestAknTextUtilsDisplayTextLanguageSpecificNumberConversion( CStifItemParser& aItem );

    /**