/*

* 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 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:  It manages Browser's preferences.

*

*/

#ifndef BROWSER_PREFERENCES_H

#define BROWSER_PREFERENCES_H

// INCLUDE FILES

#include <e32base.h>

#include <ActiveApDb.h>

#include <brctldefs.h>

#include "Browser.hrh"

#include "Preferences.h"

#include <BrowserNG.rsg>

#include "BrowserUiPrivateCRKeys.h"

#include <browseruisdkcrkeys.h>

#include <centralrepository.h> 

#include <bldvariant.hrh>

// CONSTANTS

// FORWARD DECLARATION

class MCommsModel;

class MApiProvider;

class CRepository;

// class CBrCtlInterface;

class TBrowserOverriddenSettings;

class CApDataHandler;

class CVpnApItem;

class CVpnApEngine;

// CLASS DECLARATION

/**

*  Stores Browser settings.

*  

*  @lib Browser.app

*  @since Series60 1.2

*/

class CBrowserPreferences : public CBase,

                                public MPreferences,

                                public MActiveApDbObserver

    {

    public:     // construction

        /**

        * Two-phased constructor.

        * @since Series60 1.2

        * @param aCommsModel Comms model

        * @return The constructed preferences object

        */

        static CBrowserPreferences* NewLC( MCommsModel& aCommsModel, 

                                            MApiProvider& aApiProvider, 

                                            TBrowserOverriddenSettings* aSettings);

        /**

        * Two-phased constructor.

        * @since Series60 1.2

        * @param aCommsModel Comms model

        * @return The constructed preferences object

        */

        static CBrowserPreferences* NewL( MCommsModel& aCommsModel,

                                            MApiProvider& aApiProvider ,

                                            TBrowserOverriddenSettings* aSettings );

    public:     // destruction

        /**

        * Destructor.

        */

        virtual ~CBrowserPreferences();

    public:     // observation

        /**

        * Adds an observer to the list of observers to be notified about changes.

        * @since Series60 1.2

        * @param anObserver Observer to be notified about events

        */

        void AddObserverL( MPreferencesObserver* anObserver );

        /**

        * Removes an observer.

        * @since Series60 1.2

        * @param anObserver The observer

        */

        void RemoveObserver( MPreferencesObserver* anObserver );

        /**

        * Notify all observers about change.

        * @since Series60 1.2 (updated in 3.0)

        */      

        void NotifyObserversL( TPreferencesEvent aEvent,

                                    TBrCtlDefs::TBrCtlSettings aSettingType );

    public:     // From MActiveApDbObserver

        /**

        * Derived classes should implement this method, and act accordingly

        * to database events.

        * @since Series60 1.2

        * @param anEvent Database-related event

        */

         void HandleApDbEventL( TEvent anEvent );

    public:    // New functions

        /**

        * Stores preferences into shared data db.

        * @since Series60 1.2

        */

        void StoreSettingsL() const; 

        /**

        * Returns a structure containing all of the settings according to the

        * central repository values

        * @since Series60 3.0

        */

        const TPreferencesValues& AllPreferencesL();

        /**

        * To access an int value key in ini file

        * @param aKey the ini file key to read

        * @return the value of the given key

        * @since Series60 2.0

        */

        TInt GetIntValue( TUint32 aKey) const;

        /**

        * To access an string value key in ini file

        * @param aKey the ini file key to read

        * @return the value of the given key

        * @since Series60 2.0

        */

        TInt GetStringValueL ( TUint32 aKey, TInt aMaxBufSize, TDes& aBuf ) const;

    private:    // New functions

        /**

        * restores preferences from shared data db. If fails, it uses defaults.

        * @since Series60 1.2

        */

        void RestoreSettingsL();

    private:    //Utility functions for accessing shared data

        /**

        * To set an int value key in ini file

        * @param aKey the ini file key to write

        * @param aValue new value for the key

        * @return ETrue if successful

        * @since Series60 2.0

        */

        TBool SetIntValueL ( TUint32 aKey, const TInt& aValue);

        /**

        * To access an string value key in ini file

        * @param aKey the ini file key to read

        * @return the value of the given key

        * @since Series60 2.0

        */

        HBufC* GetStringValueL ( TUint32 aKey ) const;

        /**

        * To set an int value key in ini file

        * @param aKey the ini file key to write

        * @param aValue new value for the key

        * @return ETrue if successful

        * @since Series60 2.0

        */

        TBool SetStringValueL( TUint32 aKey, const TDesC& aValue );

    private:     // New functions

        /**

        *   Enables access to functions in CBrowserAppUi

        **/

        inline MApiProvider& ApiProvider() { return iApiProvider; }

    public:     // New functions

        /**

        * To set overriden values

        * @param aSettings settings to verride

        * @return void

        * @since Series60 2.0

        */

        void SetOverriddenSettingsL(TBrowserOverriddenSettings* aSettings);

        /**

        * To set embedded mode

        * @param aEmbeddedMode true if embedded mode is on

        * @return void

        * @since Series60 2.0

        */

        void SetEmbeddedModeL(TBool aEmbeddedMode);

        /**

        * To get embedded mode

        * @return TBool

        * @since Series60 3.0

        */

        inline TBool EmbeddedMode() const { return iEmbeddedMode; }            

        /**

        * To access DefaultAccessPoint setting.

        * @since Series60 1.2

        * @return UID for default accesspoint

        */

        inline TUint DefaultAccessPoint() const;

        /**

        * Get the default snap id

        * @since Series60 1.2

        * @return

        */               

        inline TUint DefaultSnapId() const;        

        /**

        * To access Accossiated VPN if exist setting.

        * @since Series60 1.2

        * @return UID for Accossiated VPN or KWmlNoDefaultAccessPoint

        */        

        inline TUint AssociatedVpn() const;

        /**

        * To access deafult AP details if exist setting.

        * @since Series60 1.2

        * @return CApAccessPointItem* or NULL

        */         

        inline CApAccessPointItem* DefaultAPDetails();

        /**

        * To access vpn item if exists.

        * aDefaultAccessPoint

        * aVpnItem

        * @since Series60 1.2

        * @return TBool - if vpn item is valid

        */          

        TBool VpnDataL( TUint aDefaultAccessPoint, CVpnApItem& aVpnItem );

        /**

        * To access AutoLoadContent setting.

        * @since Series60 1.2

        * @return Value of setting

        */

        inline TInt AutoLoadContent() const;

        /**

        * To access PageOverview setting.

        * @return Value of setting

        */

        inline TBool PageOverview() const;

        /**

        * To access BackList setting.

        * @return Value of setting

        */

        inline TBool BackList() const;

        /**

        * To access AutoRefresh setting.

        * @return Value of setting

        */

        inline TBool AutoRefresh() const;

        /**

        * Sets the automatic updating access point of Web Feeds 

        */

        void SetAutomaticUpdatingApL( TUint aAutomaticUpdatingAP );

        /**

        * Sets the automatic updating while roaming of News & Blogs 

        */

        void SetAutomaticUpdatingWhileRoamingL( TBool aAutoUpdateRoaming ) ;

        /**

        * To access user-defined URL suffix list (.com, org, .net)

        */

        inline HBufC* URLSuffixList( ) const;

        /**

        * To modify user-defined URL suffix list (.com, .org, .net)

        */

        void SetURLSuffixList( HBufC* aValue );

        /**

        * automatic updating access point of Web Feeds

        */

        inline TUint AutomaticUpdatingAP() const;

        /**

        * automatic updating while roaming of News & Blogs 

        */

        inline TBool AutomaticUpdatingWhileRoaming() const;

        /**

        * To access TextWrap setting

        * @since Series60 1.2

        * @return setting item value

        */

        inline TBool TextWrap() const;

        /**

        * To access FontSize setting

        * @since Series60 1.2

        * @return Font size

        */

        inline TInt FontSize() const;

        /**

        * To access Encoding setting

        * @since Series60 1.2

        * @return Default Encoding

        */

        inline TUint32 Encoding() const;

        /**

        * To access Adaptive Bookmarks setting

        * @since Series60 1.2

        * @return TWmlSettingsAdaptiveBookmarks

        */

        inline TWmlSettingsAdaptiveBookmarks AdaptiveBookmarks() const;

        /**

        * To access FullScreen setting

        * @since Series60 2.1

        * @return TWmlSettingsFullScreen

        */           

        inline TWmlSettingsFullScreen FullScreen() const;

        /**

        * To access Cookies setting

        * @since Series60 1.2

        * @return TWmlSettingsCookies

        */

        inline TWmlSettingsCookies Cookies() const;

        /**

        * To access ECMA setting

        * @since Series60 2.x

        * @return TWmlSettingsECMA

        */

        inline TWmlSettingsECMA Ecma() const;

        /**

        * To access SCRIPTLOG setting

        * @since Series60 3.2

        * @return TUint32

        */

        inline TUint32 ScriptLog() const;

        /** 

        * To access HTTP security warnings setting

        * @since Series60 1.2S

        * @return ETrue if security warnings are enabled

        */

        inline TBool HttpSecurityWarnings() const;

        /** 

        * To access IMEI notification setting

        * @since Series60 2.6

        * @return ETrue if notification is enabled

        */

        inline TWmlSettingsIMEI IMEINotification() const;

        /**

        * Call this to check whether Http

        */

        inline TBool HttpSecurityWarningsStatSupressed() const;

        /**

        * To access Downloads Open setting

        * @since Series60 3.x

        * @return TBool

        */

        inline TBool DownloadsOpen() const;

        /**

        * To access user-defined homepage URL setting

        */

        TInt HomePageUrlL( TDes& aUrl, TBool aForceLoadFromSD = EFalse ) const;

        /**

        * Get the home page URL from belongs to the access point.

        */

        TInt HomePageFromIapL( TDes& aUrl, TUint aIap ) const;

        /**

        * To access user-defined search page URL setting

        */

        TPtrC SearchPageUrlL();

        /**

        * To determine that is there an overridden default access point defined or not

        */

        TBool CustomAccessPointDefined();

        /**

        * Shows/Hides the query on exit dialog

        * 0 = Not show the dialog

        * 1 = Show the dialog

        *

        * @since Series60 2.7

        * @return ETrue if query on exit is enabled

        */

        inline TBool QueryOnExit() const;

        /**

        * Sends/Don not send the referrer header

        * 0 = Do not send the referrer header

        * 1 = Send the referrer header

        *

        * @since Series60 2.7

        * @return ETrue if Send referrer header is enabled

        */

        inline TBool SendReferrer() const;

        /**

        * To access ShowConnectionDialogs setting

        * @since Series60 2.0

        * @return value of setting

        */

        inline TBool ShowConnectionDialogs() const;

        /**

        * To check that an engine local feature is supported or not

        * @since Series60 2.1

        * @return Returns ETrue if feature is supported

        * @param aBitmask Feature to check

        */

        inline TBool EngineLocalFeatureSupported( const TInt aFeature ) const;

        /**

        * To check that a ui local feature is supported or not

        * @since Series60 2.1

        * @return Returns ETrue if feature is supported

        * @param aBitmask Feature to check

        */

        inline TBool UiLocalFeatureSupported( const TInt aFeature ) const;

        /**

         * To access MediaVolume setting

         * @since Series60 2.6

         * @return TInt

         */         

        inline TInt MediaVolume() const;

        /**

        * To access home page's type: AP/user defined.

        * @since Series60 2.6

        * @return value of setting

        */

        inline TWmlSettingsHomePage HomePageType() const;

        /**

        * To access Popup Blocking Enabled setting.

        * @since Series60 3.0

        * @return value of setting

        */

        inline TBool PopupBlocking() const;

        /**

        * To access Form Data Saving setting.

        * @since Series60 3.1

        * @return value of setting

        */

        inline TWmlSettingsFormData FormDataSaving() const;

        /**

        * To access Access Keys setting.

        * @since Series60 3.2

        * @return value of setting: 1-Enabled, 0-Disabled

        */

        inline TBool AccessKeys() const;

        /**

        * To modify DefaultAccessPoint setting

        * @since Series60 1.2

        * @param aDefaultAccessPoint Id of default accesspoint

        */

        void SetDefaultAccessPointL( TUint aDefaultAccessPoint, TUint aAssocVpn = KWmlNoDefaultAccessPoint );

        /**

        * Set default snapid

        * @since Series60 1.2

        * @param

        */

       void SetDefaultSnapId (TUint aSnapId);

        /**

        * To modify AutoLoadContent setting

        * @since Series60 1.2

        * @param aAutoLoadContent Change the setting on/off

        */

        void SetAutoLoadContentL( TInt aAutoLoadContent );

        /**

        * To modify PageOverview setting

        * @param aPageOverview Change the setting on/off

        */

        void SetPageOverviewL( TBool aPageOverview );

        /**

        * To modify BackList setting

        * @param aBackList Change the setting on/off