/*

* Copyright (c) 2006-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:  ?Description

*

*/

/* ---------------------------------------------------------------------------

*  Version history:

*  Template version:

*  <ccm_history>

*

*  Version: 25, Tue Mar 19 18:00:00 2008 by Rohit

*  Ref:

*  Implemented change request to display Byte Counter in KB till 0.1 MB, and in MB threrafter

*

*  Version: 24, Tue Feb 28 18:00:00 2008 by Rohit/Kranthi

*  Ref:

*  MIRCtrlCmdObserver::MCtrlCommand() function signature changed (Merged IRv1.0 Engine code changes)

*

*  </ccm_history>

* ============================================================================

*/

#ifndef IRUI_H

#define IRUI_H

#include <aknsitemdef.h>

#include <aknviewappui.h>

#include <remconcoreapitargetobserver.h>

#include <aknindicatorcontainer.h>

#include "internetradioconfigurationflags.hrh"

#include <MProEngProfileActivationObserver.h>

//For IAD

#ifdef FF_IAUPDATE

#include <iaupdateobserver.h>

#endif

//starting adding of ui code

#include "irbat.h"

#include "irctrlcommand.h"

#include "irnetworkcontrollerobserver.h"

#include "irpropertyobserver.h"

#include "irsessionparams.h"

#include "irstreamsourceobserver.h"

#include "misdsresponseobserver.h"

#include "IRdatatransferobserver.h"

#include "irfirsttimeview.h"

#include "irsettingsview.h"

#include "irsystemeventobserver.h" //For system events

#include "irpubsubkeys.h"

#include "IRControlEventObserver.h"

class CIRSettingsView;

class CIRBaseView;

class CIRCtrlCmdObserver;

class CIRDiscoverStationsView;

class CIRFavoritesDb;

class CIRMediaClient;

class CIRNetworkController;

class CIRNowPlayingView;

class CIRNwInfoObserver;

class CIROTAUpdate;

class CIRPubSub;

class CIRReportGenerator;

class CIRSettings;

class CIRStreamSource;

class CAlfEnv;

class CIRAlarmObserver;

class CIRMessageObserver;

class CIRBrowseChannelItems;

class CIRBrowseCatagoryItems;

class CIRLastPlayedStationInfo;

class CIconFileProvider;

class CIRFirstTimeView;

class CIRAddManuallyStationView;

class CIRStationDirectoryView;

class CIRCategoryView;

class CIRSearchResultsView;

class CIRStationsView;

class CIRTopStationsView;

class CIRPlsView;

class CIRCostWarningView;

class CIRMainView;

class CIRDialogLauncher;

class CAknWaitDialog;

class CIRIsdsWrapper;

class CIRNowPlayingWrapper;

class CIRViewStack;

class CIRSystemEventCollector; //For system events

class CIRStationInfoView;

class CIRHistoryListView;

class CRemConInterfaceSelector;

class CRemConCoreApiTarget;

class MProEngNotifyHandler;

//For IAD

class CIAUpdate;

class CIAUpdateParameters;

class CIRControlEventObserver;

#ifdef __IRA_FEATURE_BACKSTEPPING_SERVICE

class CIRBackSteppingServiceWrapper;

#endif // __IRA_FEATURE_BACKSTEPPING_SERVICE

//Network Indicator

_LIT(KGprs,"Gprs");

_LIT(K3G,"3G");

_LIT(KWiFi,"WiFi");

_LIT(KEdge,"Edge");

//CONSTANTS DECLARATION

//Resolution

const TInt KIRLowResolution = 176;

const TInt KIRQVGAResolution = 240;

const TInt KIRPotraitResolution = 320;

//Ulr Validation

const TInt KMaxBufSize = 256;

const TInt KSmallBufSize = 32;

const TInt KSearchStringChar = 100;

const TInt KLoop = 3;

const TInt KScrollAmount =20;

const TInt KScrollDelay = 1000000;

const TInt KInterval = 200000;

//charging Animation time

const TInt KChargingAnimTimer = 500000;

//For help context

#define KUIDIRAPP 0x2000B499

const TUid KIRMCVUid = {KUIDIRAPP};

//add for now can change later

enum TIROverLayText

    {

    KIROverLayTextNotDefined = 0,

    KIROverLayTextBuffering,

    KIROverLayTextLoading,

    KIROverLayTextSearching,

    KIROverLayTextConnecting

    };

 enum TIRKeyboardKeys

{

   EIRKeyboardKey0 = 0x30,

   EIRKeyboardKey1 = 0x31,

   EIRKeyboardKey2 = 0x32,

   EIRKeyboardKey3 = 0x33,

   EIRKeyboardKey4 = 0x34,

   EIRKeyboardKey5 = 0x35,

   EIRKeyboardKey6 = 0x36,

   EIRKeyboardKey7 = 0x37,

   EIRKeyboardKey8 = 0x38,

   EIRKeyboardKey9 = 0x39

};

const TInt KSearchBoxTextLength = 100;

const TInt KFindStringLength = 10;

//========================================class declaration CIRUi============================================

/**

 * This class Creates CIRUi.

 * Controls the  entire Ui.

 * It creates the instance's of all the views.

 * Instantiates NetworkController,IsdsClient,IsdsPreset,MediaClient,FavouritesDb,IRPubSub

 *

 * @code

 * Controls the user commands

 * HandleCommandL()

 *

 * Handle window server events

 * HandleWsEventL()

 *

 * Display the battery value

 * DisplayBatteryValueL()

 *

 * Redraw the currently activated view

 * ActivateCurrentView()

 *

 * Update the current network status

 * UpdateCurrentNetwork()

 *

 * Connect to server

 * iNetwork->ConnectToServerL(iUrl)

 *

 * Call back called when category data recieved

 * IsdsCatogoryDataReceivedL()

 *

 * Call play

 * iPlayer->Play()

 *

 * @endcode

 *

 */

class MAknEditingStateIndicator

	{

public:

	enum TAknEditingState

		{

		EStateNone,

		ET9Upper,

		ET9Lower,

		ET9Shifted,

		ENumeric,

		EMultitapUpper,

		EMultitapLower,

		EMultitapShifted,

		};

public:

	virtual void SetState(TAknEditingState aState) = 0;

	virtual CAknIndicatorContainer *IndicatorContainer() = 0;

	};

class CIRUi :public CAknViewAppUi, public MIRNetworkController,

			 public MCoeForegroundObserver,public MIRPropertyChangeObserver,

			 public MIRDataTransferObserver,

#ifdef FF_IAUPDATE

 			 public MIAUpdateObserver,

#endif

 			 public MRemConCoreApiTargetObserver,public MProEngProfileActivationObserver,

 			 public MIRSystemEventObserver,

 			 public MCoeViewActivationObserver

	{

public:

	/**

	* ConstructL

	* 2nd phase constructor.

	* Perform the second phase construction of a

	* CIRUi object.

	*/

	void ConstructL();

	/**

	* CIRCategoryView.

	* C++ default constructor.

	*/

	CIRUi();

	/**

	* ~CIRCategoryView

	* Destructor.

	*/

	~CIRUi();

	/**

	* GetWrapperInstance()

	* Returns the instance of the IsdsWrapper object

	*/

	CIRIsdsWrapper* GetWrapperInstance();

	/**

	* HandleCommandL()

	* Handles the user input commands.

	* @param input command

	*/

	/**

	* GetNowPlayingWrapperInstance()

	* Returns the instance of the CIRNowPlayingWrapper object

	*/

	CIRNowPlayingWrapper* GetNowPlayingWrapperInstance();

	/**

	 * From CAknView

	 *

	 * @see CAknView::HandleCommandL( TInt aCommand )

	 */

	void HandleCommandL(TInt aCommand);

	/**

	* IRHandleCommandL()

	* Saves the index of the selected item from the listbox.

	* @param currently selected item index.

	* @param user command

	*/

	void IRHandleCommandL(TInt aIndex,TInt aCommand);

	/**

	* SavePrevIDL()

	* Saves the previousID of the view.

	* @param previousID of the view.

	* @param user command.

	*/

	void SavePrevIDL(const TUid& aPrevID,TInt aCommand);

	/**

	* HandleStatusPaneSizeChange()

	* Called by framework whenever the resource is changed.

	*/

	void HandleStatusPaneSizeChange();

	/**

	* HandleWsEventL()

	* Called by framework on an window server event.

	* @param window server event

	*/

	void HandleWsEventL( const TWsEvent& aEvent,CCoeControl* aDestination );

	/**

	* HandleKeyEventL()

	* Called by framework on an window server event.

	* @param window server event

	*/

	TKeyResponse HandleKeyEventL(const TKeyEvent& aKeyEvent,TEventCode aType);

	/**

	* IconProvider()

	* @return the instance of icon provider..

	*/

	CIconFileProvider* IconProvider();

	/**

	* GetMifFilePath().

	* @return the full path of mif file.

	*/

	TFileName GetMifFilePath() const;

	/**

	* GetPrivatePath().

	* Returns the full path of the file.

	* @return filepath

	*/

	TFileName GetPrivatePath()const;

	/**

	* ActivateCurrentView().

	* Redraws the currently active view.

	* @param Uid of the currently active view.

	*/

	void ActivateCurrentView(const TUid& aUid) const;

	/**

	* VerifyNetworkConnectivityL()

	* verify whether the network is connected or not

	* This function can leave if displaying of info note leaves hence

	* this leave can be ignored

	* @param    aObserver     The delayed action observer to receive the event when network connection is established.

	* @return the bool that informs the network connectivity status.

	*/

	TBool VerifyNetworkConnectivityL();

	/**

	* HandleGainingForeground()

	* This is call back function which observes application focus gaining

	* foreground

	*/

	void HandleGainingForeground();

	/**

	* HandleLosingForeground()

	* Function handles when application looses foreground focus

	*/

	void HandleLosingForeground();

	/**

	 * LosingForeground

	 * Function handles when application looses foreground focus

	 */

	void LosingForeground();

	/**

	* ViewStack()

	* Returns pointer to the view stack.

	* @return   Pointer to view stack.

	*/

	CIRViewStack& ViewStack();

	/**

	* ForwardBackCommandToBsWrapperL()

	* Forwards back command to Back Stepping Service wrapper.

	* @return Returns ETrue if Back Stepping Service consumes the back command, otherwise returns EFalse.

	*/

	TBool ForwardBackCommandToBsWrapperL();

	/**

	* ActiveView()

	* Function returns the UID of the Current Active view

	**/

	TUid ActiveView() const;

	/**

	* FocusWhenSelectGot()

	* Funtion is called to get the flag when an listbox item is selected

	* so that the next view gets activated

	**/

	TBool FocusWhenSelectGot() const;

	/**

	* FocusWhenSelectSet()

	* Funtion is called to set flag when an listbox item is selected

	* so that the next view gets activated

	**/

	void FocusWhenSelectSet(TBool aFocus);

	/**

	* OpenFileL()

	* Open the file using Document's instance

	* @param filename to be opened

	*/

	void OpenFileL( const TDesC& aFileName );

	/**

	* GainingForeGroundL()

	* Function handles when application gains foreground focus

	*/

	void GainingForeGroundL();

	/**

	* MrccatoCommand()

	* This is called to decrease the volume

	* @param aOperationId Operation Id

	* @param aButtonAct Button Action

	*/

	void MrccatoCommand(TRemConCoreApiOperationId aOperationId,

	TRemConCoreApiButtonAction aButtonAct);

	/**

     * From MRemConCoreApiTargetObserver.

     */

    void MrccatoPlay(TRemConCoreApiPlaybackSpeed aSpeed,

        TRemConCoreApiButtonAction aButtonAct);

	/**

	* SetVolume()

	* Call CPeriodic after the period is over

	* @param volume level.

	*/

	void SetVolume(TInt aValue);

	 /**

     * Returns a reference to System event collector

     */

    CIRSystemEventCollector& SystemEventCollector();

	/**

	* IRNetworkEventL()

	*

	*/

	virtual void IRNetworkEventL(TIRNetworkEvent aEvent);

	/**

	* UpdateCurrentNetwork()

	* Updates the CurrentNetwork

	* @param MCC

	* @param MNC

	*/

	void UpdateCurrentNetwork(const TDesC& aCurrentNetworkMCC,

	const TDesC& aCurrentNetworkMNC);

	/**

	* UpdateHomeNetwork()

	* Updates the home

	* @param MCC

	* @param MNC

	*/

	void UpdateHomeNetwork(const TDesC& aCurrentNetworkMCC,

	const TDesC& aCurrentNetworkMNC);

	/**

	* ParseAndPrepareUrl()

	* Checks for the URL whether its valid or not

	* @param URL

	*/

	TBool ParseAndPrepareUrl(const TDesC& aUrl);

	/**

	* SetCurrentNetworkType()

	* Sets Current Network Being Used

	*/

	void SetCurrentNetworkType();

	/**

	* GetCurrentNetworkType()

	* Returns Current Network Being Used

	*/

	TDesC& GetCurrentNetworkType();

	/**

	* SetPlayStateWhileCall()

	* Sets This Value When Stoping the Player

	* While Call is Active

	*/

	void  SetPlayStateWhileCall(TBool aPlayTerminated);

	/**

	* GetPlayStateWhileCall()()

	* Returns the Value of Play state

	* While Call is Active

	*/

	TBool  GetPlayStateWhileCall();

	/**

	* IsEmbedded()

	*/

	TBool IsEmbedded() const;

	/**

	* IsCallActive()

	* @return the state of call

	**/

	TBool IsCallActive();

	/**

	* HandlePropertyChangeL

	* Derived from MIRPropertyChangeObserver

	*/

	virtual	void HandlePropertyChangeL(const TUid& aCategory,