/*

* Copyright (c) 2005-2008 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:

*     A base class for an object implementing the state.

*

*/

#ifndef CPHONESTATE_H

#define CPHONESTATE_H

// INCLUDES

#include <w32std.h>

#include <remconcoreapitargetobserver.h>

#include <MProfileEngine.h>

#include <bmbubblemanager.h>

#include "mphonestate.h"

#include "mphoneviewcommandhandle.h"

#include "cphonecbamanager.h"

// FORWARD DECLARATIONS

class MPhoneState;

class MPhoneStateMachine;

class CPhoneCallHeaderManager;

class CPhoneTimer;

class TPhoneCmdParamCallHeaderData;

class MPhoneCustomization;

class CPhoneNumberEntryManager;

enum TStateTransEffectType

    {

    ENoneType,

    ENumberEntryOpen,

    ENumberEntryClose,

    ENumberEntryCreate

    };

// CLASS DECLARATION

/**

*  An abstract class for an object implementing the state.

*

*/

class CPhoneState :

    public CBase,

    public MPhoneState

    {

    public:

        /**

        * Constructor

        */

        IMPORT_C CPhoneState(

            MPhoneStateMachine* aStateMachine,

            MPhoneViewCommandHandle* aViewCommandHandle,

            MPhoneCustomization* aCustomization);

        /**

        * Creates CbaManager instance.

        */

        IMPORT_C void BaseConstructL();

        /**

        * Destructor.

        */

        IMPORT_C virtual ~CPhoneState();

        /**

        * A message handling function for Phone Engine messages

        * @param aMessage Message from Phone Engine

        * @param aCallId Call id the message concerns

        */

        IMPORT_C virtual void HandlePhoneEngineMessageL(

            const TInt aMessage,

            TInt aCallId );

        /**

        * HandleError

        * Implements error handling framework

        * @param aErrorInfo: the error info

        */

        IMPORT_C virtual void HandleErrorL(

            const TPEErrorInfo& aErrorInfo );

        /**

        * Handle processed (short, long) key messages from the key event

        * handler

        * @param aMessage a key message

        * @param aCode key event code

        */

        IMPORT_C virtual void HandleKeyMessageL(

            TPhoneKeyEventMessages aMessage,

            TKeyCode aCode );

        /**

        * Handles raw key events from the key event handler

        * @param aKeyEvent a key event

        * @param aEventCode key event code

        */

        IMPORT_C virtual void HandleKeyEventL(

            const TKeyEvent& aKeyEvent,

            TEventCode aEventCode );

        /**

        * Handles key press duration events from the key event handler

        * @param aCode key event code

        * @param aKeyPressDuration key press duration

        */

        IMPORT_C virtual void HandleKeyPressDurationL(

            TKeyCode aCode,

            TTimeIntervalMicroSeconds aKeyPressDuration );

        /**

        * From CAknAppUi, initialise a menupane (dynamic).

        *

        * @param aResourceId It is the resource id for the pane.

        * @param aMenuPane It is the menu pane corresponding to the resource.

        */

        IMPORT_C virtual void DynInitMenuPaneL(

            TInt aResourceId,

            CEikMenuPane* aMenuPane );

        /**

        * From CAknAppUi, initialise a menubar (dynamic).

        *

        * @param aResourceId It is the resource id for the bar.

        * @param aMenuBar It is the menu bar corresponding to the resource.

        */

        IMPORT_C virtual void DynInitMenuBarL(

            TInt aResourceId,

            CEikMenuBar* aMenuBar );

        /**

        * From CEikAppUi. For Idle indicator

        */

        IMPORT_C virtual void HandleSystemEventL(

            const TWsEvent& aEvent );

        /**

        * From CAknAppUi, indicates when app ui is on the foreground.

        * @param aForeground It is true if app is on the foreground.

        */

        IMPORT_C virtual void HandleForegroundEventL( TBool aForeground );

        /**

        * Indicates when the Phone app is in the foreground.

        */

        IMPORT_C virtual void HandlePhoneForegroundEventL();

        /**

        * Indicates when the Phone app is losing focus.

        */

        IMPORT_C virtual void HandlePhoneFocusLostEventL();

        /**

        * Indicates when the Idle app is in the foreground.

        */

        IMPORT_C virtual void HandleIdleForegroundEventL();

        /**

        * Handle environment changes.

        * @param aChanges environment changes which may be reported by

        *  a change notifier through the RChangeNotifier interface.

        */

        IMPORT_C void HandleEnvironmentChangeL( const TInt aChanges );

        /**

        * Handles startup of the phone application

        */

        IMPORT_C virtual void HandlePhoneStartupL();

        /**

        * This function is called when there is property value change.

        * @param aCategory Category of the property

        * @param aKey Property key that is changed

        * @param aValue New property value

        */

        IMPORT_C virtual void HandlePropertyChangedL(

            const TUid& aCategory,

            const TUint aKey,

            const TInt aValue );

        /**

        * Handle the change of the setting from Central Repository

        * @param aUid identifing the central repository UID.

        * @param aId central repository ID.

        */

        IMPORT_C virtual void HandleCenRepChangeL(

            const TUid& aUid,

            const TUint aId );

        /**

        * Handles commands.

        * @param aCommand It is the code of the command to be handled.

        * @returns boolean value was the command handled by the state

        *          (ETrue) or not (EFalse)

        */

        IMPORT_C virtual TBool HandleCommandL( TInt aCommand );

        /**

        * Processes command.

        * @param aCommand It is the code of the command to be handled.

        * @returns boolean value was the command handled by the state

        *          (ETrue) or not (EFalse)

        */

        IMPORT_C virtual TBool ProcessCommandL( TInt aCommand );

        /**

        * Handles commands from the Remote Control framework.

        * @param aOperationId The operation ID of the command.

        * @param aButtonAct The button action associated with the command.

        * @return ETrue if the event was handled, EFalse otherwise.

        */

        IMPORT_C virtual TBool HandleRemConCommandL(

            TRemConCoreApiOperationId aOperationId,

            TRemConCoreApiButtonAction aButtonAct);

        /**

        * Setter for divert indication showing in bubble.

        * @param aDivertIndication ETrue to show divert indication,

        *          EFalse to not. Usually setting EFalse isn't necessary

        *         as it's a default value in bubble creation.

        */

        IMPORT_C virtual void SetDivertIndication(

            const TBool aDivertIndication );

        /**

        * Handles Long hash key press

        */

        IMPORT_C void HandleLongHashL();

        /**

        * Informs view to start Transition effect

        * @param aType a transition effect, default none

        * EndTransEffect() must be called when update is done.

        */

        IMPORT_C void BeginTransEffectLC( TStateTransEffectType aType = ENoneType );

        /**

        * Informs view to complete Transition effect

        */

        IMPORT_C void EndTransEffect();

        /**

        * Checks whether customized dialer view is active,

        * @return ETrue if customized dialer is active

        */

        IMPORT_C TBool IsCustomizedDialerVisibleL() const;

        /**

        * Closes customized dialer view

        */

        IMPORT_C void CloseCustomizedDialerL();

        /**

         * Plays DTMF tone for key event

         * */

        IMPORT_C void HandleDtmfKeyToneL( const TKeyEvent& aKeyEvent,

                TEventCode aEventCode );

        /**

        * Show global InfoNote

        * @param aResourceId resource id to be resolved

        */

        IMPORT_C void SendGlobalInfoNoteL( TInt aResourceId );

        /**

        * Show global ErrorNote

        * @param aResourceId resource id to be resolved

        */

        IMPORT_C void SendGlobalErrorNoteL( TInt aResourceId );

        /**

        * Fetches autolock information - is it set on or not

        * @return is autolock set on (ETrue) or off (EFalse)

        */

        IMPORT_C TBool IsAutoLockOn() const;

        /**

        * Return is sim state ok

        * @return ETrue if is sim ok, otherwise EFalse

        **/

        IMPORT_C TBool IsSimOk();

        /**

        * Checks Svivel state.

        * @return ETrue if swivel is closed.

        */

        IMPORT_C TBool IsSwivelClosed() const;

        /**

        * Check if note, query or blockingDialog is visible

        * @return boolean value indicating that note, query or

        * blocking dialog is visible

        */

        IMPORT_C TBool IsAnyQueryActiveL();

        /**

        * Check if menu bar is visible

        * @return boolean value indicating that menu bar is visible

        */

        IMPORT_C TBool IsMenuBarVisibleL() const;

        /**

         * Sets context menu to correspond the incall options menu

         *

         */

        IMPORT_C virtual void UpdateInCallContextMenuL();

        /*

        * If KFeatureIdFfSimlessOfflineSupport is undefined and

        * UI shows note which will be closed by key event then

        * method return ETrue otherwise EFalse.

        */

        TBool IsNoteDismissableL();

        /**

        * Check if possible dialer extension is in focus

        * @return boolean value indicating if dialer extension is in focus

        */

        IMPORT_C TBool IsDialingExtensionInFocusL() const;

    public: // NumberEntry functions.

        /**

        * Passes create number entry command forward if NE can be created.

        */

        IMPORT_C virtual void HandleCreateNumberEntryL(

                const TKeyEvent& aKeyEvent,

                TEventCode aEventCode );

        /**

        * Check if number entry is used

        * @return boolean value indicating that number entry is used

        */

        IMPORT_C virtual TBool IsNumberEntryUsedL();

        /**

        * Check if number entry is visible

        * @return boolean value indicating that number entry is visible

        */

        IMPORT_C TBool IsNumberEntryVisibleL();

    protected:

        /**

        * Handle EPEMessageAudioMuteChanged

        */

        IMPORT_C void HandleAudioMuteChangedL();

        /**

        * Handle EPEMessageAudioOutputChanged

        */

        IMPORT_C void HandleAudioOutputChangedL();

        /**

        * Handle SideVolumeKeyInc

        */

        IMPORT_C void IncreaseAudioVolumeL();

        /**

        * Handle SideVolumeKeyDec

        */

        IMPORT_C void DecreaseAudioVolumeL();

        /**

        * Dial CS multimedia call

        */

        IMPORT_C void DialMultimediaCallL();

        /**

        * Dial CS voice call

        */

        IMPORT_C void DialVoiceCallL();

        /**

        * Disconnect call

        */

        IMPORT_C virtual void DisconnectCallL();

        /**

        * Display idle screen

        */

        IMPORT_C void DisplayIdleScreenL();

        /**

        * Set up the Idle screen in the background for the cases

        * where the phone is no longer the top application (eg. end

        * call when an external app is being displayed)

        */

        IMPORT_C void SetupIdleScreenInBackgroundL();

        /**

        * Display call header for call coming in ( the remote info data

        * and picture is displayed immediately )

        * @param aCallid call id

        * @param aWaitingCall waiting call indication

        */

        IMPORT_C void DisplayHeaderForCallComingInL(

            TInt aCallId,

            TInt aWaitingCall );

		/**

        * Sets call header texts for call coming in

        * @param aCallid call id

        * @param aWaitingCall waiting call indication

		* @param aCallHeaderData - Call header parameter into which the text

        *                          will be set.

        */

        IMPORT_C void SetCallHeaderTextsForCallComingInL(

			TInt aCallId,

            TBool aWaitingCall,

            TPhoneCmdParamCallHeaderData* aCallHeaderData );

        /**

        * Display call header for outgoing call (the phone number is initially

        * displayed)

        * @param aCallid call id

        */

        IMPORT_C void DisplayHeaderForOutgoingCallL( TInt aCallId );

        /**

        * Update Single Active Call

        * @param aCallid call id

        */

        IMPORT_C void UpdateSingleActiveCallL( TInt aCallId );

        /**

        * Update remote information data in the call header

        * @param aCallid call id

        */

        IMPORT_C void UpdateRemoteInfoDataL( TInt aCallId );

        /**

        * Return remote info data

        * @param aCallid call id

        * @param aData the returned remote info data

        */

        IMPORT_C void GetRemoteInfoDataL( TInt aCallId, TDes& aData );

        /**

         * Sets context menu

         *

         * @param aResourceId   resource

         */

        IMPORT_C virtual void SetContextMenuL( TInt aResourceId );

        /**

         * Sets context menu to correspond the incoming options menu

         *

         * @param aCallId   incoming call id

         */

        IMPORT_C virtual void UpdateIncomingContextMenuL( TInt aCallId );

        /**

        * Show note

        * @param aResourceId resource id to be resolved

        */

        IMPORT_C void ShowNoteL( TInt aResourceId );

        /**

        * Show query

        * @param aResourceId resource id to be resolved

        */

        IMPORT_C void ShowQueryL( TInt aResourceId );

        /**

        * Show text query

        * @param aDialogResourceId dialog's resource id

        * @param aDefaultCbaResourceId default CBA's resource id

        * @param aContentCbaResourceId content CBA's resource id

        * @param aDataText pointer to data text

        * @param aSendKeyEnabled send key enabled status for the query

        */

        IMPORT_C void ShowTextQueryL(

            TInt aDialogResourceId,

            TInt aDefaultCbaResourceId,

            TInt aContentCbaResourceId,

            TDes* aDataText,

            TBool aSendKeyEnabled = EFalse );

        /**

        * Check if note is visible

        * @return boolean value indicating that note is visible

        */

        IMPORT_C TBool IsNoteVisibleL();

        /**

        * Handle numeric key event

        */

        IMPORT_C virtual void HandleNumericKeyEventL(

            const TKeyEvent& aKeyEvent,

            TEventCode aEventCode );

        /**

        * Check if the application needs to be sent to the background

        * @return boolean value indicating that application needs to be

        *  sent to the background

        */

        IMPORT_C TBool NeedToReturnToForegroundAppL() const;

        /**

        * Check if the top application is currently displayed in the foreground

        * @return boolean value indicating that top app is displayed

        */

        IMPORT_C TBool TopAppIsDisplayedL() const;

        /**

        * Capture keys during call notifications (dialing, incoming, waiting)

        * @param aCaptured ETrue if keys are to be captured

        */

        IMPORT_C void CaptureKeysDuringCallNotificationL( TBool aCaptured );

        /**

        * Displays the call termination note, if required