/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "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:  Header file for CBrowserAppUi

*

*

*/

#ifndef __BROWSERAPPUI_H

#define __BROWSERAPPUI_H

// INCLUDE FILES 

#include <browser_platform_variant.hrh>

#include <aknviewappui.h>

#include <connectionobservers.h>	// CHG!

#include <apgcli.h>

#include "ApiProvider.h"

#include "BrowserBuild.h"

#include "WmlBrowserBuild.h"

#include <favouritesdb.h>

#include "WindowInfoProvider.h"

// FORWARD DECLARATIONS

class CBrowserViewBase;

class MCommsModel;

class CBrowserCommsModel;

class CBrowserPreferences;

class CWmlBrowserBmOTABinSender;

class CBrowserContentView;

class CBrowserSoftkeysObserver;

class CBrowserSpecialLoadObserver;

class CBrowserAsyncExit;

class CBrowserLauncherService;

// Multiple Windows Support

class CBrowserPopupEngine;

class CBrowserWindow;

class CBrowserWindowManager;

class CBrowserBookmarksView;

#ifdef __RSS_FEEDS

	class CFeedsClientUtilities;

#endif  // __RSS_FEEDS

// CONSTANTS

//

// BROWSER UI KNOWN mime types

//

_LIT(KOPMLMimeType,      "text/x-opml");

_LIT(KMimeTypeAppXML,    "application/xml");

_LIT(KMimeTypeTextXML,   "text/xml");

//++PK

_LIT(KMimeTypeCapsTextXML,   "Text/xml");

//++PK

_LIT(KMimeTypeRSS,       "application/rss+xml");

_LIT(KMimeTypeAtom,      "application/atom+xml");

_LIT(KMimeTypeRDF,       "application/rdf+xml");

class CBrowserPushMtmObserver;

// CLASS DECLARATION

/**

*  CBrowserAppUi.

* 

*  @lib Browser.app

*  @since Series 60 1.2 

*/

class CBrowserAppUi : public CAknViewAppUi,

                      public MApiProvider,

                      public MConnectionStageObserver,

                      public MDownloadedContentHandler,

                      public MWindowInfoProvider

    {

    public:     // Constructors and destructor

        /**

        * Default constructor.

        */

        CBrowserAppUi();

        /**

        * Destructor.

        */

        ~CBrowserAppUi();

    public:

#if defined(__S60_50__)

        /**

        * Handling the system Event.

        * @since Series 60 1.2

        * @param aEvent The System event passed.

        */

        void HandleSystemEventL(const TWsEvent& aEvent);

#endif          

        /**

        * Get the active view.

		* @since Series 60 1.2

        * @return The current view.

        */

        CBrowserViewBase* ActiveView();

        /**

        * Checking if user wants to disconnect.

		* @since Series 60 1.2

        * @param aUserInitiated it can be closed by user or the system.

        */

        void ExitBrowser( TBool aUserInitiated );

        /**

        * Calls views' method (ALWAYS changes the view's CBA).

		* @since Series 60 1.2

        */

        void UpdateCbaL();

        /**

        * Handles commandline parameters.

		* @since Series 60 1.2

        * @param aDocumentName Parameter string

        * @param aDoFetch Indicates that this function shoud fetch the given

        *                 URL. This parameter is required and used 

        *                 by new embedding architecture.

        */

        void ParseAndProcessParametersL( const TDesC8& aDocumentName, TBool aDoFetch = ETrue );

        /**

        * Wait a while, contentview initializing itself

		* @since Series 60 3.2

        */

        void WaitCVInit();

        /**

        * Set flag to ETrue if called from another application.

		* @since Series 60 1.2

        * @param aValue Is browser called from some another App.

        */

        void SetCalledFromAnotherApp( TBool aValue );

        /**

        * Get flag if called from another application.

		* @since Series 60 3.1

		* @return Etrue if browser is called from some another App.

        */

        TBool CalledFromAnotherApp();

        /**

        * Override CAknViewAppUi::ProcessCommandL.  Calls CAknAppUi::StopDisplayingMenuBar() before iView one.

		* @since Series 60 

        * @param aCommand GUI command

        */

        void ProcessCommandL(TInt aCommand);

        /** 

        * Get the instance of the browser UI.

		* @since Series 60 1.2

        * @return The browser UI.

        */

        static CBrowserAppUi* Static();

        /**

        * Contentview.

		* @since Series 60 1.2

        */

        CBrowserContentView* ContentView() const;

        /**

		* Check Operator Menu or Video Services status

		* @since Series 60 2.0

		* @return ETrue if browser is running in Operator Menu or Video Services app

		*/

		TBool IsEmbeddedInOperatorMenu() const;

		/**

		* Check if avkon appshutter is running

		* @since Series60 2.0

		* @return ETrue if avkon appshutter is running

		*/

		TBool IsAppShutterActive() const;

		/**

		* Returns value of iSomeItemsNotSecure member 

		* @since Series60 2.0

		* @return ETrue if some items is unsecure in page

		*/

        TBool SomeItemsNotSecure() const;

        /**

        * Fetch the home page

        */

        void FetchHomePageL();

        /**

        * Check if the application is in foreground

        * @return ETrue if application is in foreground

        */

        inline TBool IsForeGround() const

            { return iIsForeground; }

        /**

        * Sets a private status to indicate that Browser has to use

        * a special exiting method.

        */

        inline void SetExitFromEmbeddedMode( TBool aFlag )

            { iExitFromEmbeddedMode = aFlag; }

        /**

        * Sets a the uid of the embedding application if the

        * Browser is embedded.

        */

        inline void SetEmbeddingAppliacationUid( TUid aEmbeddingApplicationUid )

        	{ iEmbeddingApplicationUid = aEmbeddingApplicationUid; }

        inline void SetBrowserLauncherService( CBrowserLauncherService* aBrowserLauncherService )

            { iBrowserLauncherService = aBrowserLauncherService; }

        inline CBrowserLauncherService* BrowserLauncherService() const

            { return iBrowserLauncherService; }

        void CloseWindowL( TInt aWindowId = 0 );

        inline CBrowserBookmarksView* GetBookmarksView()

            { return iBookmarksView; }

        void OpenLinkInNewWindowL( const CFavouritesItem& aBookmarkItem );

        /**

        * Launching HomePage (AP home page, or user-defined home page).

        */

        void LaunchHomePageL();

        /**

        * Set home page found flag

        * @param aPgNotFoundFlag: indicate if home page is found or not.

        */

        void SetPgNotFound(TBool aPgNotFoundFlag) {iPgNotFound = aPgNotFoundFlag;};

        /**

        * Catch any key presses that are Application wide.  Called from OfferKeyEventL() in view containers

        * @param aKeyEvent: 

        * @param aType:

        */

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

        /**

        * Sets requested AP.

        * @param aAp the AP to use when connectionneeded is called.

        */

        void SetRequestedAP( TInt aAp );

 		/**

        * Gets the currently focused image, and saves it to Gallery.

        */

        void SaveFocusedImageToGalleryL();

        /**

        * Check if shutdown was requested.

        * @return ETrue if shutdown was requested.

        */

        TBool IsShutdownRequested() const;

        /**

        * Check if a progress bar is shown.

        * @return ETrue if progress bar is shown.

        */

        TBool IsProgressShown() const;

        /**

        * Sets prograss bar showing status.

        * @param ETrue to show, EFalse to hide the progress bar

        */

        void SetProgressShown( TBool aProgressShown );

		/** 

		* Check if RFile content should be handled

		* by BrowserUI rather than sent off to BrCtl

		* @return ETrue if it should be handled by BrowserUI

		* @param an RFile filehandle, and an allocated buffer to hold

		*   discovered mime type

		*/

		TBool CBrowserAppUi::RecognizeUiFileL( RFile& aFileHandle, TBuf<KMaxDataTypeLength>& aDataTypeDes );

		/** 

		* Confirm with the user that a file should be handled by

		* BrowserUI according to it's mime type with appropriate

		* dialogs, etc. The name is used for the dialogs

		* @return ETrue if yes, EFalse otherwise

		* @param a filename to be shown in dialog, and a mime type

		*   to switch on so we can show different dialogs in different situations 

		*/

		TBool ConfirmUiHandlingL( TFileName& aFilename, TBuf<KMaxDataTypeLength>& aDataTypeDes );

		/** 

		* Given a file handle (RFile) and a file path,

		* copy the contents of the RFile to the file path given

		* @return void

		* @param a filehandle RFile, and a path to copy the contents to

		*/ 

		void CopyUiRFileToFileL( RFile& aFile, const TDesC& aFilepath );

		/** 

		* Handle a file that BrowserUi can process (as opposed to

		* BrCtl)

		* This will also setup views accordingly (the setup may be different from the HandleUiDownload case)

		* @return void

		* @param the full path of the filename to be handled and the mime type

		*   so that handling can be different for different mime types

		*/

		void HandleUiFileL( TFileName& aFilepath, TBuf<KMaxDataTypeLength>& aDataTypeDes );

		/** 

		* Handle a file that BrowserUi can process that is downloaded from the content view

		* This will also setup views accordingly (the setup may be different from the HandleUiFile case)

		* @return void

		* @param the full path of the filename to be handled and the mime type

		*   so that handling can be different for different mime types

		*/

		void HandleUiDownloadL( TFileName& aFilepath, TBuf<KMaxDataTypeLength>& aDataTypeDes );

		/**

		* Launch the browser so that it starts directly into the feeds view

		* @return void

		* @param none

		*/

		void LaunchIntoFeedsL();

    public: // From CEikAppUi

        /**

        * Handles user commands.

        * @param aCommand Command to be handled.

        */

        void HandleCommandL( TInt aCommand );

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

    public: // Functions from MApiProvider

        /**

        * Returns reference to the implementation of MDisplay.

        * @return An implementation of MDisplay.

        */

        MDisplay& Display() const;

        /**

        * Returns a reference to the implementaion of MConnection,

        * through wich some high-level connection specific data can be set.

        * @return reference to MConnection object.

        */

        MConnection& Connection( ) const;

        /**

        * Returns reference to the implementation of MPrefences.

        * @return An implementation of MPrefences.

        */

        MPreferences& Preferences() const;

        /**

        * Returns reference to the implementation of MCommsModel.

        * @return An implementation of MCommsModel.

        */

        MCommsModel& CommsModel() const;

        /**

        * Returns reference to the CBrCtlInterface

		* @return A reference to CBrCtlInterface

        */

		CBrCtlInterface& BrCtlInterface() const;

		/**

        * Returns reference to CBrowserLoadObserver.

        * @return An implementation of MBrCtlLoadEventObserver

        */

		CBrowserLoadObserver& LoadObserver() const;

	    /**

        * Returns reference to CBrowserLoadObserver.

        * @return An implementation of MBrCtlLoadEventObserver

        */

		CBrowserSpecialLoadObserver& SpecialLoadObserver() const;

		CBrowserSoftkeysObserver& SoftkeysObserver() const;

		/**

        * Returns reference to CBrowserDialogsProvider.

        * @return An implementation of MBrCtlDialogsProvider

        */

		CBrowserDialogsProvider& DialogsProvider() const;

        CBrowserPopupEngine& PopupEngine() const;

        /**

        * Returns reference to the implementation of MBmOTABinSender.

        * @return An implementation of MBmOTABinSender.

        */

        MBmOTABinSender& BmOTABinSenderL();

        /**

        * Returns reference to the implementation of MStartPageHandler.

        * @return An implementation of MStartPageHandler.

        */

        CBrowserWindowManager& WindowMgr() const;

        /**

        *

        */

        inline TBool StartedUp() const { return iStartedUp; };

        /**

        *

        */

        void ConnNeededStatusL( TInt aErr );

        /**

        * Checks the last used AP.

        * @return the Id of the last used AP.

        */

        inline TUint32 RequestedAp() const { return iRequestedAp; }

        /**

        * In some cases it's not permitted to cancel fetching process.

        * @return ETrue if cancelling fetch is allowed, otherwise EFalse.

        */

        TBool IsCancelFetchAllowed() const;

        /**

        * Sets uid which should be activated if needed.

        * If not, it activates view immediately.

        * @param aUid Uid of the view.

        * @param aMessageId Id of the message.

        */

        void SetViewToBeActivatedIfNeededL( TUid aUid, TInt aMessageId = 0 );

        /**

        * Returns the Uid of the last visited Uid.

        * @return Uid of the last used view.

        */

        TUid LastActiveViewId() const;

        /**

        * Sets uid of the last used view.

        * @param aUid Uid of the latest used view.

        */

        void SetLastActiveViewId( TUid aUid );

        /**

        * Gets uid of the current view.

        * @param none

        * @return TUid of the current view

        */

        TUid GetCurrentViewId() const 

            {

            return iCurrentView;

            }

        /**

        * Set the View for in which the last CBA update was made

        * @since 5.0

        */

        void SetLastCBAUpdateView( TUid aView ) { iLastCBAUpdateView = aView; }

        /**

        * Get the view in which the last CBA update was made

        * @since 5.0

        * @return TUid of last view for which CBA was updated

        */

        TUid GetLastCBAUpdateView() { return iLastCBAUpdateView; }

        /**

        * Tells if Browser is in the middle of a shutdown process.

        * @return ETrue if the app is being closed, otherwise with EFalse.

        */

        TBool ExitInProgress() const;

        /**

        * Sets a flag in Browser to indicate shutdown process.

        * @param aValue ETrue if exit process will be started, otherwise EFalse.

        */

        void SetExitInProgress( TBool aValue );

        /**

        * Is Browser connection procedure ongoing or not.

        * @return ETrue if connection procedure is ongoing, otherwise EFalse.

        */

        TBool IsConnecting() const;

        /**

        * Updates progress bar in contentview.

        * @param aStatusMsg Progress bar text.

        */

        void UpdateNaviPaneL( TDesC& aStatusMsg );

        /**

        * Set view to return to when closing the content view.

        * @since Series60 1.2

        * @param aUid View uid

        */

        void SetViewToReturnOnClose( TUid const &aUid );

        /**

        * Close the content view by activating the bookmarks view

        * @since Series60 1.2

        */

        void CloseContentViewL();

		/**

        * Tells if Browser is in the embedded mode

        * @return ETrue if the Browser is in the embedded mode, 

        * otherwise with EFalse.

		*/

		TBool IsEmbeddedModeOn() const;