/*

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

*     Incoming state implementation.

*

*/

#ifndef CPHONESTATEINCOMING

#define CPHONESTATEINCOMING

// INCLUDES

#include "cphonestate.h"

// FORWARD DECLARATIONS

class TPhoneCmdParamCallStateData;

// CLASS DECLARATION

/**

*  Incoming state

*/

class CPhoneStateIncoming : public CPhoneState

    {

    public:  

        /**

        * Destructor.

        */

        IMPORT_C virtual ~CPhoneStateIncoming();

        /**

        * Creates the Incoming state class

        * @param aStateMachine: a container of state objects

        * @param aViewCommandHandle: handle to the PhoneUIView

        * @return an instance of class CPhoneStateIncoming

        */

        static CPhoneStateIncoming* NewL( 

            MPhoneStateMachine* aStateMachine, 

            MPhoneViewCommandHandle* aViewCommandHandle,

            MPhoneCustomization* aPhoneCustomization );

        IMPORT_C void HandleKeyMessageL(

            TPhoneKeyEventMessages aMessage,

            TKeyCode aCode );

        IMPORT_C void HandleKeyEventL(

            const TKeyEvent& aKeyEvent,

            TEventCode aEventCode );

        IMPORT_C virtual void HandleKeyPressDurationL(

            TKeyCode aCode,

            TTimeIntervalMicroSeconds aKeyPressDuration );

        /**

        * 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 );       

        IMPORT_C TBool HandleCommandL( TInt aCommand );

        /** 

        * Handle state-specific behaviour when number entry is cleared

        */ 

        IMPORT_C void HandleNumberEntryClearedL();

        /** 

        * Handle keylock state change events

        */ 

        IMPORT_C void HandleKeyLockEnabled( TBool aKeylockEnabled );

    protected:

        /**

        * By default EPOC constructor is private.

        */

        IMPORT_C CPhoneStateIncoming( 

            MPhoneStateMachine* aStateMachine, 

            MPhoneViewCommandHandle* aViewCommandHandle,

            MPhoneCustomization* aPhoneCustomization );

        /**

        * ConstructL()

        */

        IMPORT_C virtual void ConstructL();

        /**

        * 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 );

        /**

        * Audio play stopped handling

        */

        IMPORT_C virtual void HandleAudioPlayStoppedL();            

    private: // From CPhoneState

        /**

        * A message handling function for EPEMessageConnected

        * @param aCallId: the call id of the call

        */

        void HandleConnectedL( TInt aCallId );

        /**

        * A message handling function for EPEMessageIdle

        * @param aCallId: the call id of the call

        */

        void HandleIdleL( TInt aCallId );

        /**

        * Handles Send key or command, when pressed from the dialer 

        */

        void HandleSendL();

        /**

        * Open soft reject message editor

        */

        /**

        * Indicator if soft reject message editor is displayed

        */

        TBool SoftRejectMessageEditorIsDisplayedL() const;

        /**

        * Open menu bar

        */

        void OpenMenuBarL();

        /**

        * Answer the MT call

        */

        void AnswerCallL();

        /**

        * Disconnects the waiting call

        */

        void DisconnectWaitingCallL();

        /**

        * Gets resource to use when number entry is open

        * @return resource id

        */

        TInt GetNumberEntryVisibleMenuBar();

        /**

        * Gets resource to use when number entry is closed

        * @return resource id

        */

        TInt GetNumberEntryNotVisibleMenuBar();

        /**

        * Updates incoming CBA's

        */

        void UpdateInCallCbaL( TInt aCallId );

        /**

        * Show disconnected note

        */        

        void ShowDisconnectingL( TInt aCallId ); 

        /**

        * Update remote data and label to the call header.

        * @param aCallId - Call Id.

        * @param aCallHeaderData - Call header parameters where modifications

        *                          are made.

        */

        void UpdateRemoteInfoDataAndLabelL( 

                TInt aCallId, 

                TPhoneCmdParamCallHeaderData aCallHeaderParam );

    protected:

        // call id of ringing call

        TInt iRingingCallId;

    };

#endif // CPHONESTATEINCOMING

// End of File