/*

* Copyright (c) 2004-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:  Application UI class for Video Telephone application.

*

*/

#ifndef CVTUIAPPUI_H

#define CVTUIAPPUI_H

//  INCLUDES

#include    <aknappui.h>

#include    <vtengcommands.h>

#include    <mvtengmedia.h>

#include    <tvtengrendering.h>

#include    <tvtengrenderingdsa.h>

#include    <tvtengrenderingdp.h>

#include    <tvtengrenderingnga.h>

#include    <mvtengaudio.h>

#include    <remconcoreapi.h>

#include    "CVtUiActiveExec.h"

#include    "tvtuilocalvariation.h"

#include    "tvtuiappstatebase.h"

// FORWARD DECLARATION

class CVtUiBlankControl;

class CAknNavigationControlContainer;

class CAknTitlePane;

class CVtEngModel;

class MVtUiVideoWindow;

class CRepository;

class CAknQueryDialog;

class CAknProgressDialog;

class TVtUiStates;

class CVtUiCommandManager;

class CVtUiComponentManager;

class CVtUiFeatureManager; // TOOLBAR MOD

class MVtUiNumberSource;

class CVtUiMainControl;

class CVtUiContextControl;

class CVtUiBitmapManager;

class CVtUiVolumeControl;

class CAknIncallBubble;

class CVtUiRemoteVideoControl;

// CLASS DECLARATION

/**

*  Application UI class for Video Telephone application.

*

*  @since Series 60 2.6

*/

class CVtUiAppUi

    : public CAknAppUi,

      protected MVtUiActiveExec,

      public MVtUiStateContext,

      public MProgressDialogCallback

    {

    public:

        // Rendering modes

        enum TRenderingMode

            {

            ERenderingModeDefault,

            ERenderingModeDialer

            };

    public: // Constructors and destructor

        /**

        * C++ constructor.

        */

        CVtUiAppUi();

        /**

        * Symbian constructor.

        */

        void ConstructL();

        /**

        * C++ destructor.

        */

        ~CVtUiAppUi();

    public: // New functions

        /*

        *  This function decides possibility of swapimg image places.

        */

        TBool CanSwapImagePlaces();

        /*

        * Switches status pane between flat and normal one.

        */

        void SwitchLayoutToFlatStatusPaneL( TBool aSwitch );

        /**

        * Refreshes all.

        */

        void RefreshL();

        /**

        * Refreshes navi pane.

        */

        void RefreshNaviPaneL();

        /**

        * Refreshes softkeys.

        */

        void RefreshSoftkeysL();

        /**

        * Refreshes menu.

        */

        void RefreshMenuL();

        /**

        * Refresh zoom popup

        */

        void RefreshZoomPopupL();

        /**

        * Stop brightness or Contrast

        */        

        void StopBrightnessOrContrast();

        /**

        * Refreshes blind flags.

        */

        void RefreshBlind();

        /**

        * Refreshes synchronisation.

        */

        void RefreshSynchronise();

        /**

        * Opens number entry.

        * @return ETrue if number entry opened.

        */

        TBool OpenNumberEntryL();

        /**

        * Handles EKeyPhoneSend presses

        */

        TKeyResponse HandlePhoneSendKeyL( const TKeyEvent& aKeyEvent,

            TEventCode aType );

        /**

        * Returns pointer to cba.

        */

        CEikButtonGroupContainer* GetCba();

        /**

        * Sets zoom mode.

        * @param aEnableZoomMode Etrue if zoom mode is on.

        * EFalse otherwise.

        * @param aIsPermanent ETrue if zoomindicator's timeout

        * should be ignored. EFalse otherwise..

        */

        void SetZoomModeL( const TBool aEnableZoomMode,

            const TBool aIsPermanent = EFalse );

        /**

        * Checks if command is active.

        * @param aCommand Command id.

        * @return Etrue if command is active

        * EFalse otherwise.

        */

        TBool IsActiveCommand( TInt aCommand ) const;

        TVtUiAppStateBase& State();

        /**

        * Returns reference to bitmap manager.

        */

        CVtUiBitmapManager& BitmapManager();

        /**

        * Sets given zoom step, if it allowed.

        * @param aZoomStep New zoom step to be set.

        */

        void SetZoomFactorL( TInt aZoomStep );

    public: // Functions from base classes

        /**

        * From CAknAppUi, handles window server events.

        * @param aEvent event.

        * @param aDestination destination control.

        */

        virtual void HandleWsEventL(

            const TWsEvent& aEvent,

            CCoeControl* aDestination );

        /**

        * From CAknAppUi, processes commands.

        * @param aCommand the identifier of the command to be handled.

        */

        virtual void ProcessCommandL(

            TInt aCommand );

        /**

        * From CAknAppUi, handles commands.

        * @param aCommand the identifier of the command to be handled.

        */

        virtual void HandleCommandL(

            TInt aCommand );

        /**

        * From CAknAppUi, handles dynamic initialisation of menu panes.

        * @param aResourceId the resource identifier for the pane.

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

        */

        virtual void DynInitMenuPaneL(

            TInt aResourceId,

            CEikMenuPane* aMenuPane );

        /**

        * From CAknAppUi, handles key events.

        * @param aKeyEvent event to be handled.

        * @param aType type of the key event.

        * @return response code (EKeyWasConsumed, EKeyWasNotConsumed)

        */

        virtual TKeyResponse HandleKeyEventL(

            const TKeyEvent& aKeyEvent,

            TEventCode aType );

        /**

        * From CAknAppUi, handles resouce changes.

        * @param aType type of resource change.

        */

        virtual void HandleResourceChangeL( TInt aType );

        /**

        * From CAknAppUi, handles foreground status changes.

        * @param aForeground ETrue if foreground.

        */

        virtual void HandleForegroundEventL( TBool aForeground );

        /**

        * Returns a pointer to CEikonEnv.

        */

        CEikonEnv* GetEikonEnv();

    protected: // Functions from base classes

        /**

        * From CAknAppUi, returns help context.

        * @return help context.

        */

        virtual CArrayFix<TCoeHelpContext>* HelpContextL() const;

        /**

        * @see MVtUiActiveExec::ActiveExecExecuteL.

        */

        virtual TBool ActiveExecExecuteL(

            CVtUiActiveExec& aActiveExec,

            const TInt aState,

            TInt& aNextState,

            TRequestStatus& aRequest );

        /**

        * @see MVtUiActiveExec::ActiveExecContinue.

        */

        virtual TBool ActiveExecContinue(

            CVtUiActiveExec& aActiveExec,

            TInt& aState,

            const TInt aError );

        /**

        * @see MVtUiActiveExec::ActiveExecCancel.

        */

        virtual void ActiveExecCancel(

            CVtUiActiveExec& aActiveExec,

            const TInt aState );

        /**

        * @see MVtUiActiveExec::ActiveExecDone.

        */

        virtual void ActiveExecDone(

            CVtUiActiveExec& aActiveExec,

            const TInt aInitialState );

    public: // from MVtUiStateContext

        /** @see MVtUiStateContext::StartupPhase1L */

        virtual void StartupPhase1L();

        /** @see MVtUiStateContext::ShutdownL */

        virtual void ShutdownL();

        /** @see MVtUiStateContext::StartupPhase2L */

        virtual void StartupPhase2L();

        /** @see MVtUiStateContext::ChangeApplicationFocus */

        virtual void ChangeApplicationFocus( const TBool aForeground );

        /** @see MVtUiStateContext::ChangeState */

        virtual void ChangeState( TVtUiAppStateBase* aState );

        /** @see MVtUiStateContext::StartTone */

        virtual void StartDtmfTone( const TChar& aTone );

        /** @see MVtUiStateContext::StopTone */

        virtual void StopDtmfTone();

        /** @see MVtUiStateContext::Model */

        virtual CVtEngModel& Model();

        /** @see MVtUiStateContext::VideoTelephonyVariation */

        virtual const TVtUiVideoTelephonyVariation&

            VideoTelephonyVariation() const;

        /** @see MVtUiStateContext::NumberSource*/

        virtual MVtUiNumberSource* NumberSource() const;

        /** @see MVtUiStateContext::RefreshL */

        virtual void RefreshL( const TInt aRefreshFlags );

        /** @see MVtUiStateContext::DoExecuteCmdL */

        virtual void DoExecuteCmdL(

            const TVtEngCommandId aCommand,

            TDesC8* aParams );

        /** @see MVtUiStateContext::DoHandleLayoutChangedL */

        virtual void DoHandleLayoutChangedL();

        /** From MVtUiShutterObserver via MVtUiStateContext

        *  Exits the application.

        */

        virtual void HandleShutdownReady();

        /**

        * Gets reference to context control.

        * @return reference to context control.

        */

        CVtUiContextControl& ContextControl();

        /**

        * Gets reference to main control.

        * @return reference to main control.

        */

        CVtUiMainControl& MainControl();

        /**

        * Gets reference to remote video control.

        * @return reference to remote video control.

        */        

        CVtUiRemoteVideoControl& RemoteVideoControl();

        /**

        * Switches viewfinder to main pane if it is currently in context

        * pane.

        */

        void SwitchViewFinderToMainPaneL( TBool aUpdateState = ETrue );

        /**

        * Switches viewfinder to context pane if it is currently in main

        * pane.

        */

        void SwitchViewFinderToContextPaneL( TBool aUpdateState = ETrue );

        /**

        * Restores viewfinder back to pane where it was prior to calling the

        * switch ViewFinderToMainPane() or ViewFinderToContextPane() methods.

        */

        void RestoreViewFinderL();

        /*

        * Updates volume to the Video Telephone engine.

        */

        void CmdUpdateVolumeL( MVtEngAudio::TVtEngOutputVolume aVolume );

        /**

        * Increases "command activating" ref.count and adds cleanup item

        * to decrease it. Refreshes commands in case of first increment from

        * zero. When PopAndDestroy() is called, cleanup decreases reference

        * count and if it reduces back to zero command refresh is again done.

        */

        void EnableCommandActivatingAndCleanupPushL();

    private: // from MProgressDialogCallback

        /**

        * @see MProgressDialogCallback::DialogDismissedL

        */

        void DialogDismissedL( TInt aButtonId );

    private:

        // COMMAND HANDLING

        /**

        * Checks if command is allowed.

        * @param aCommand command identifier.

        * @return ETrue if allowed, EFalse otherwise.

        */

        TBool IsCommandAllowedL( const TInt aCommand );

        /**

        * Refreshes iDisabledFlags.

        */

        void RefreshDisabledFlagsL();

        /**

        * Refreshes camera option availability.

        * @param aUsePrimaryCameraNotAllowed it will be updated to ETrue if

        *        it is not allowed to activate primary camera.

        * @param aUseSecondaryCameraNotAllowed it will be updated to ETrue if

        *        it is not allowed to activate secondary camera.

        */

        void RefreshCameraOptionAvailability(

            TBool& aUsePrimaryCameraNotAllowed,

            TBool& aUseSecondaryCameraNotAllowed );

        /**

        * Enables capture mode.

        */

        void CmdSnapshotL();

        /**

        * Freezes outgoing video image.

        */

        void CmdCaptureL();

        /**

        * Disables capture mode.

        */

        void CmdCancelCaptureL();

        /**

        * Enables video.

        */

        void CmdEnableVideoL();

        /**

        * Enables audio (unmute microphone).

        */

        void CmdEnableAudioL();

        /**

        * Disables video.

        */

        void CmdDisableVideoL();

        /**

        * Disables audio (mute microphone).

        */

        void CmdDisableAudioL();

        /**

        * Activates Bluetooth handsfree.

        */

        void CmdActivateBtL();

        /**

        * Deactivates Bluetooth handsfree.

        */

        void CmdDeactivateBtL();

        /**

        * Activates loudspeaker.

        */

        void CmdActivateLoudspeakerL();

        /**

        * Deactivates loudspeaker.

        */

        void CmdDeactivateLoudspeakerL();

        /**

        * Ends active call.

        */

        void CmdEndActiveCallL();

        /**

        * Swaps images places.

        */

        void CmdSwapImagesPlacesL();

        /**

        * Switches used camera.

        * @param aPrimaryCamera ETrue if primary camera is to be selected,

        *        EFalse if secondary camera is to be selected.

        */

        void CmdUseCameraL( const TBool aPrimaryCamera );

        /**

        * Launches help application.

        */

        void CmdHelpL();

        /**

        * Prepare exiting the application.

        */

        void PrepareExitL();

        /**

        * Updates zoom step to Video Telephone engine.

        */

        void CmdUpdateZoomL();

        /**

        * Dials emergency call.

        */

        void CmdDialEmergencyL();

        /**

        * Goes to Idle.

        */

        void CmdGoToIdleL();