/*

* Copyright (c) 2005-2009 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:  Controller for the PhoneUI View component

*

*/

#ifndef CPHONEVIEWCONTROLLER_H

#define CPHONEVIEWCONTROLLER_H

//  INCLUDES

#include <apgcli.h>

#include <eikenv.h>

#include <e32base.h>

#include <cntdef.h>

#include <cphcntspeeddialmonitor.h>

#include "mphoneviewcommandhandle.h"

#include "cphonerecoverysystem.h"

#include "mphonestatuspaneobserver.h"

#include "tphonecmdparamspeeddial.h"

#include "aknkeylock.h"

#include "tphonecmdparamtranseffect.h"

#include "mphoneviewblockingdialogobserver.h"

// FORWARD DECLARATIONS

class CPhoneButtonsController;

class CLogsClient;

class CPhoneView;

class CPhoneDialerView;

class TPhoneViewId;

class TPhoneCommandParam;

class TPhoneCmdParamBoolean;

class CEikButtonGroupContainer;

class CPhoneMenuController;

class CPhoneNoteController;

class CPhoneQueryController;

class CPhoneKeyCaptureController;

class CSpdiaControl;

class CEikStatusPane;

class CAknNavigationControlContainer;

class CPhoneBubbleWrapper;

class CCoeControl;

class CPhoneStatusPane;

class TPhoneNoteType;

class CPhoneNoteUtilities;

class CPhoneIncallIndicator;

class CPhoneTimer;

class CPhoneContactController;

class CPhoneCntSaveAddToName;

class CPhCntSingleItemFetch;

class CPhoneApplicationExit;

class CPhoneAudioController;

class CPhoneRingingTonePlayerAO;

class RAknUiServer;

class CPhoneSingleItemFetch;

class CPhoneDialerController;

class CAknIndicatorContainer;

class CPhCntRfsHandler;

class CPhoneToolbarController;

class CEikonEnv;

class CPhoneVmbxHandler;

class CAknAppUi;

class CDialer;

class MPhoneNumberEntryChangedHandler;

class MPhoneViewCustomization;

class CPhoneViewController :

    public CBase,

    public MPhoneViewCommandHandle,

    public MPhoneStatusPaneObserver,

    public MPhoneViewBlockingDialogObserver

    {

    public:  // Constructors and destructor

        IMPORT_C static CPhoneViewController* NewL( TRect aRect );

        /**

        * Destructor.

        */

        IMPORT_C virtual ~CPhoneViewController();

        IMPORT_C CPhoneView* PhoneView();

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual void ExecuteCommandL(

            TPhoneViewCommandId aCmdId );

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual void ExecuteCommandL(

            TPhoneViewCommandId aCmdId,

            TInt aCallId );

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual void ExecuteCommandL(

            TPhoneViewCommandId aCmdId,

            TPhoneCommandParam* aCommandParam );

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual void ExecuteCommandL(

            TPhoneViewCommandId aCmdId,

            TInt aCallId,

            TPhoneCommandParam* aCommandParam );

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual void ExecuteCommandL(

            TPhoneViewCommandId aCmdId,

            TInt aCallId,

            TDesC& aMessage );

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual void ExecuteCommand(

            TPhoneViewCommandId aCmdId );

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual void ExecuteCommand(

            TPhoneViewCommandId aCmdId,

            TPhoneCommandParam* aCommandParam );

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual TPhoneViewResponseId HandleCommandL(

            TPhoneViewCommandId aCmdId );

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual TPhoneViewResponseId HandleCommandL(

            TPhoneViewCommandId aCmdId,

            TPhoneCommandParam* aCommandParam );

        /**

        * From MPhoneViewCommandHandle

        */

        IMPORT_C virtual const TDesC& FetchContent();

        /**

        * @see MPhoneStatusPaneObserver.

        */

        void HandleTitlePaneActiveL( TBool aActive = ETrue );

        /**

        * Returns window group id of the phone application.

        */

        IMPORT_C TInt ApplicationWindowGroupId();

        /**

        * Returns window group id of the Idle application.

        */

        IMPORT_C TInt IdleWindowGroupId();

        /**

        * Returns window group id of the application that is currently

        * in the foreground.

        */

        IMPORT_C TInt ForegroundApplicationWindowGroupId();

        /**

        * Fetches foreground application's window group id.

        */

        IMPORT_C static TInt DoFetchForegroundApplicationWindowGroupIdL(

            CEikonEnv& aEnv );

        /**

        * Hides / makes visible Phone icon in fast swap menu.

        * @since 2.8

        * @param aHidden is application hidden or shown.

        */

        IMPORT_C void SetHiddenL( const TBool aHidden );

        /**

        * Get the help context

        * @return Saved help context

        */

        IMPORT_C const TDesC& HelpContext();

        /**

        * From CCoeControl; notifier for resource changes

        * @param aType : Type of resource change

        */

        IMPORT_C void HandleResourceChangeL( TInt aType );

        /**

        * From CCoeControl; notifier for layout changes

        * @param aRect : screen size

        */

        IMPORT_C void HandleLayoutChange( TRect aRect );

        /**

        * Indicates that a blocking dialog is currently being displayed

        * This is required by the AppUI to determine if

        * the End key should be processed in HandleWsEventL()

        */

        IMPORT_C TBool BlockingDialogIsDisplayed() const;

        /**

        * Indicates that a status panel is currently being displayed

        * This is required by the AppUI

        */

        IMPORT_C TBool StatusPaneDisplayed();

        /**

        * Set single item fetch content

        */

        void SetFetchContent( TDesC& aFetchContent );

        /**

        * Sets single item fetch type

        * @aType   single item fetch type

        */

        void SetSingleItemFetchType( TInt aType );

         /**

        * From MPhoneViewBlockingDialogObserver

        * Sets the is blocking dialogs in screen.

        * @param aBlockingDialog ETrue if blocking dialog is

        *                        displayed.

        */

        IMPORT_C void SetBlockingDialogIsDisplayed( TBool aBlockingDialog );

    private:     // New functions

        /**

        * read IdleApplicationUid from PubSub

        */

        TInt IdleAppUid();

        /**

        * Indicates whether application needs to return to the

        * background after being brought to the foreground using

        * BringToForeground()

        */

        TBool NeedToSendToBackground();

        /**

        * Gets the blocking dialogs status

        */

        void GetBlockingDialogIsDisplayed( TPhoneCommandParam* aCommandParam );

        /**

        * Sets the required background status of the application

        */

        void SetNeedToSendToBackground( TPhoneCommandParam* aCommandParam );

        /**

        * Sends application to background.

        */

        void SendToBackgroundL();

        /**

        * Brings foreground given application.

        * @param aCommandParam command parameter.

        */

        void BringAppToForeground( TPhoneCommandParam* aCommandParam );

        /**

        * Brings phone application to foreground.

        * @param aCommandParam command parameter.

        */

        void BringPhoneAppToForeground( TPhoneCommandParam* aCommandParam );

        /**

        * Sets the top application

        * @param aCommandParam command parameter

        */

        void SetTopApplicationL( TPhoneCommandParam* aCommandParam );

        /**

        * Gets the foreground application

        * @param aCommandParam command parameter

        */

        void GetForegroundApplication( TPhoneCommandParam* aCommandParam );

        /**

        * Sets phone application windowgroup position.

        */

        void SetWindowGroupPosition();

        /**

        * Activate other application.

        * @param aCommandParam command parameter

        */

        void ActivateAppL( TPhoneCommandParam* aCommandParam );

        /**

        * Activate other application with specific view.

        * @param aCommandParam command parameter

        */

        void ActivateAppViewL( TPhoneCommandParam* aCommandParam );

        /**

        * Activate other application with specific view and custom message.

        * @param aCommandParam command parameter

        */

        void ActivateAppViewWithCustomMessageL(

            TPhoneCommandParam* aCommandParam );

        /**

        * Activate other application with specific view with conventional way

        * @param aCommandParam command parameter

        */

        void ActivateAppViewConventionalL( TPhoneCommandParam* aCommandParam );

        /**

        * Launches application.

        */

        void LaunchApplicationL();

        /**

        * Launches help application

        * @param aHelpCommand help command string

        */

        void LaunchHelpApplicationL( const TDesC& aHelpCommand );

        /**

        * Continues construction of contact manager.

        */

        static TInt DoConstructContactControllerL( TAny* aAny );

        void SetCbaL( TPhoneCommandParam* aCommandParam );

        void ShowInfoNote( TPhoneCommandParam* aCommandParam );

        /**

        * Creates connection.

        */

        void CreateConnectionL();

        /**

        * Activate another instance of the application

        */

        void ActivateAppInstanceL( TUid aUid );

        /**

        * Set the global Avkon notifier disabler status

        * @param aCommandParam a command parameter

        */

        void SetGlobalNotifiersDisabledL( TPhoneCommandParam* aCommandParam );

        /* Set the Eikon notifier disable status

        * @param aCommandParam a command parameter

        */

        void SetEikonNotifiersDisabled( TPhoneCommandParam* aCommandParam );

        /**

        * Cancel all notification from screen.

        */

        void CancelAllNotications();

        /**

        * Handles bubble updating

        */

        void HandleUpdateBubbleL(

            TInt aCallId,

            TPhoneCommandParam* aCommandParam );

        /**

        * Remove Phone dialogs

        */

        void RemovePhoneDialogsL();

        /**

        * Remove add to contact dialog.

        */

        void RemoveAddToContactDialog();

        /**

        * Update menu and CBAs based on current audio path

        * @param aCommandParam a command parameter

        */

        void UpdateAudioPathOptions( TPhoneCommandParam* aCommandParam );

        /**

        * Update menu and CBAs based on current audio availability

        * @param aCommandParam a command parameter

        */

        void UpdateAudioAvailabilityOptions( TPhoneCommandParam* aCommandParam );

        /**

        /**

        * Soft Reject feature enable status

        */

        TBool SoftRejectIsEnabled() const;

        /**

        * Set Speed Dial location

        */

        void SetSpeedDialLocation( TPhoneCommandParam* aCommandParam );

        /**

        * Get number from Speed Dial location

        * @return   EFalse if user cancel or failed.

        */

        TBool GetNumberFromSpeedDialLocationL(

            TPhoneCommandParam* aCommandParam );

        /**

        * Assign Speed Dial location

        * @param aCommandParam a command parameter

        * @return ETrue if speed dial location is assigned

        */

        TBool AssignSpeedDialLocation( TPhoneCommandParam* aCommandParam );

        /**

        * Assign Speed Dial location

        * @param aLocation a speed dial location

        * @return ETrue if speed dial location is assigned

        */

        TBool AssignSpeedDialLocationL( TInt aLocation );

        /**

        * Opens Contact and adds address to contacts.

        * @param aCommand a contact command

        * @param aString a string to be added to contacts, if KNullDesC string

        *                will be added from the number entry.

        */

        void OpenAddToContactL( TInt aCommand,

                                const TDesC& aString = KNullDesC );

        /**

        * Launches Restore Factory Settings

        * @param aDeepRfs - ETrue if deep rfs, EFalse if normal

        */

        void LaunchRfsL( TBool aDeepRfs );

        /**

        * Open the SMS or MMS message editor

        */

        void OpenMessageEditorL( TPhoneCommandParam* aCommandParam );

        /**

        * Open the soft reject message editor

        */

        void OpenSoftRejectMessageEditorL(TPhoneCommandParam* aCommandParam );

        /**

        * By default EPOC constructor is private.

        */

        void ConstructL( TRect aRect );

        /**

        * C++ default constructor.

        */

        CPhoneViewController();

        /**

        * Fetches phone number's type for aSpeedDialLocation located number.

        * @param aSpeedDialLocation - speed dial location of number.

        * @return Phone number's type.

        */

        TPhoneNumberType SpeedDialNumberTypeL( TInt aSpeedDialLocation );

        /**

        * Convert number type from Speed Dial field info

        * @param  aFieldInfo - field info

        * @return Phone number's type

        */

        TPhoneNumberType ConvertNumberTypeFromSpeedDialFieldInfo(

            CPhCntSpeedDialMonitor::TSpdDialFieldInfo aFieldInfo );

        /**

        * Open the Unified message editor and get

        * number from number entry

        */

        void SendMessageL();

        /**

        * Set security mode to view and statuspane

        */

        void SetSecurityMode( TPhoneCommandParam* aCommandParam );

        /**

        * Get security mode status

        */

        void GetSecurityModeStatus ( TPhoneCommandParam* aCommandParam );

        /**

        * Set security mode to view and statuspane

        */

        void SetStatusPaneVisible( TPhoneCommandParam* aCommandParam );

        /**

        * Reads information is security code query displayed on the screen.

        * @return ETrue if is displayed, otherwise EFalse

        */

        TBool IsSecurityCodeQuery() const;

        /**

        * Set update of FSW

        */

        void UpdateFSW();

        /**

        /**

        * Creates Speed Dial Controller if it doesn't exist already.

        */

        void CreateSpeedDialControllerL();

        /**

        * Checks replace option.