/*

* Copyright (c) 2007-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:  App UI class for cameraapp

*

*/

#ifndef CAMAPPUI_H

#define CAMAPPUI_H

// ===========================================================================

//  INCLUDES

#include "CamAppUiBase.h"

#include "CamNewFileService.h"

#include "CamSelfTimerObserver.h"  

#include "CamVolumeKeyObserver.h"

#include "mcamcameraobserver.h"

#include "CamFileCheckAo.h"

#include "MCamAddToAlbumObserver.h"

class CFbsBitGc;

class CAknNavigationDecorator;

class CAknNavigationControlContainer;

class CCamWaitDialog;

class CCamTimerBase;

class CCamNaviCounterControl;

class CCamNaviCounterModel;

class CCamNaviProgressBarControl;

class CCamNaviProgressBarModel;

class CCamSelfTimer;

class MCamBurstModeObserver;

class CDocumentHandler;

class CTextResolver;

class CCamSidePane;

class CCamZoomPane;

class MCamResourceLoader;

class CCamTimer;

class CIdle;

class CAknStylusPopUpMenu; 

class CGSPluginInterface;

class CGSTabHelper;

class CCamGSInterface;

class CAknGlobalNote;

//class CASpaAppLauncherActionData;

//class CSFIUtilsAppInterface;    // InCall Send interface

class CCamPropertyWatcher;

class CRepository;

class MActivePalette2UI;

class CCamActivePaletteHandler;

class CAknLocalScreenClearer;

class CAknStaticNoteDialog;

class CCamCollectionManagerAO;

class CCamStillPreCaptureView;

class CCamVideoPreCaptureView;

class CCamMemoryMonitor;

// ===========================================================================

// CLASS DECLARATION

/**

*  AppUi class for Camera

*

*  @since 2.8

*/

class CCamAppUi : public CCamAppUiBase,

                  public MCamSelfTimerObserver,

                  public MCamControllerObserver,

                  public MCamVolumeKeyObserver,

                  public MCamFileCheckObserver,

                  public MCamCameraObserver

                  ,public MCamAddToAlbumObserver

  {

  // =======================================================

  // Data Types

  private: 

    // enumeration to describe the type of view switch required when 

    // the capture mode or view state changes

    enum TCamViewSwitch

        {

        ECamViewSwitchNone,    // no switch required

        ECamViewSwitchModeOnly,// only capture mode or view state need updating

        ECamViewSwitch         // full view switch required including state 

                               // and mode update

        };

    /**

     * Enumeration used for the state of delayed postacapture views

     * construction. Only used if CAMERAAPP_DELAYED_POSTCAPTURE_CREATION is

     * enabled.

     */

    enum TCamPostCapConstruction

        {    

        ECamConstructStillPostCap,

        ECamConstructBurstPostCap,

        ECamConstructVideoPostCap,

        ECamPostCapsDone

        };

    enum TSoftkeyIndex

        {

        ESoftkeyIndex1 = 0,

        ESoftkeyIndex2 = 2

        };

    enum TPendingViewSwitchType 

        {

        EPendingViewSwitchNone = 0,

        EPendingViewSwitchNormal,

        EPendingViewSwitchDeactivateFirst

        };

    /**

     * Memory card status

     */

    enum TCamMemoryStatus

        {

        ECamMemoryStatusOK,

        ECamMemoryStatusFull,

        ECamMemoryStatusInternalFull,

        ECamMemoryStatusCardNotInserted,

        ECamMemoryStatusCardReadOnly,

        ECamMemoryStatusCardLocked,

        ECamMemoryStatusMassStorageFull

        };

  // =======================================================

  // Methods 

  // -------------------------------------------------------

  // Constructors and destructor

  public:  

    /**

    * C++ constructor.

    * @since 2.8

    * @param aController Reference to CCamAppController

    * @return Pointer to CCamAppUi

    */

    CCamAppUi( CCamAppController& aController );

    /**

    * Perform the second phase construction of a CCamAppUi object.

    * @since 2.8

    */

    void ConstructL();

    /**

    * Destructor.

    */

    virtual ~CCamAppUi();

  // -------------------------------------------------------

  // From MCamCameraObserver

  public:

    /**

    * Handle camera event.

    *

    * @param aStatus    Status code describing the event status.

    * @param aEventId   Identifier for the event.

    * @param aEventData Event associated data. If such data is provided with

    *                   the event, it is mentioned in the documentation of

    *                   particular event id.

    *                   Ownership not transferred to observer.

    */

    void HandleCameraEventL(

        TInt aStatus, 

        TCamCameraEventId aEventId, 

        TAny* aEventData = NULL );   

  // -------------------------------------------------------

  // From MCamFileCheckObserver

  public:

    /**

    * Callback to notify that file checking operation has completed.

    * @param aStatus Number of files that were missing

    * @param aError  Error code

    */

    void FileCheckingCompleteL( TInt aStatus, TInt aError );   

  // -------------------------------------------------------

  // New functions

  public: 

      /**

      * Returns whether or the toolbar has been activated/visible

      * Will return ETrue when when the toolbar is active/visible

      * @since 3.2

      * @return ETrue if toolbar is active/visible, else returns EFalse

      */

      virtual TBool IsToolBarVisible() const;

        /**

        * Check if given view state indicates that "internal",

        * CCamViewBase inherited view is in question.

        */

        TBool IsInternalView( TCamViewState aViewState ) const;

        /**

        * Set status of standby mode.

        */

        void SetStandbyStatus( TInt aStatus );

        /**

        * Get status of standby mode.

        */

        TInt StandbyStatus() const;

        /*

        * Check for file name deletion/renaming outside camera

        */

        void StartFileNameCheck();

        /**

        * Determines whether or not all construction has been completed

        * Used on view activation to determine if the view should

        * open in standby mode. This will happen if the app is waiting for

        * an orientation switch to complete or for the initial view to be set

        * when launched in embedded

        * @since 3.0

        * @return ETrue if all construction has completed, else EFalse

        */   

        TBool IsConstructionComplete() const;

        /**

        * Set title pane text from a resource.

        * @since 2.8

        * @param aResourceId resource to read from

        */

        void SetTitleL( TInt aResourceId );

        /**

        * Set title pane text from a descriptor.

        * @since 2.8

        * @param aText title pane text

        */

        void SetTitleL( const TDesC& aText );

        /**

        * In embedded mode set title to name of embedding application

        * @since 2.8

        */

        void SetTitleEmbeddedL();

        /**

        * Push navi pane indicators on to navi pane stack.

        * @since 2.8

        */

        void PushNaviPaneCounterL();

        /**

        * Push navi pane progress bar on to navi pane stack.

        * @since 2.8

        */

        void PushNaviPaneProgressBarL();

        /**

        * Push default navi pane on to navi pane stack.

        * @since 2.8

        */

        void PushDefaultNaviPaneL();

        /**

        * Call DisplayDeleteNoteL on the current view

        * @return whether the delete was performed

        * @since 2.8

        */

        TBool DisplayDeleteNoteL();

        /**

        * Enable or disable self-timer functionality

        * @since 2.8

        * @param aEnable The selftimer functionality to use

        */

        void SelfTimerEnableL( TCamSelfTimerFunctions aEnable );

        /**

        * Returns current self-timer state

        * @since 2.8

        * @return Returns whether or not Self Timer is currently enabled.

        */

        TBool SelfTimerEnabled() const;

        /**

        * Returns pointer to self-timer

        * @since 2.8

        * @return pointer to CCamSelfTimer object.

        */

        CCamSelfTimer* SelfTimer();

        /**

        * Registers an observer for changes in burst mode activation

        * @since 2.8

        * @param aBurstModeObserver the object observing burst mode changes

        */

        void AddBurstModeObserverL( MCamBurstModeObserver* aBurstModeObserver );

        /**

        * Removes an observer for changes in burst mode activation

        * @since 2.8

        * @param aBurstModeObserver the observer to remove

        */

        void RemoveBurstModeObserver( const MCamBurstModeObserver* aBurstModeObserver );

        /**

        * Returns whether or not burst capture mode is enabled.

        * Will return ETrue when burst mode is enabled for still capture

        * even if the application is currently in video capture mode

        * @since 2.8

        * @return ETrue if burst mode is enabled, else returns EFalse

        */

        TBool IsBurstEnabled() const;

        /*

        * Gets the handle to the controller, which is used inturn by the

        * plugin to call the interfaces for performing needed actions.

        */

        MCamAppController& AppController();

        /*

        * Gets the handle to the settings model, which is used inturn by the

        * plugin to call the interfaces for performing needed actions.

        */

        MCamStaticSettings& StaticSettingsModel();

        /**

        * Returns the currently enabled burst mode.

        * @since 3.0

        * @return the currently enable burst mode or ECamImageCaptureNone if 

        * burst is not enabled

        */

        TCamImageCaptureMode CurrentBurstMode() const;

        /**

        * Sets the current capture mode ( and target capture mode )

        * @since 2.8

        */

        void SetCaptureMode(

            TCamCameraMode aMode, 

            TCamImageCaptureMode aImageMode = ECamImageCaptureNone );

        /**

        * Changes the state of sequence capture

        * @since 3.0

        * @param aImageMode Single/Multi/Timelapse

        * @param aReprepare Whether or not the engine should be reprepared with sequence

        * settings (Do not reprepare if the engine is about to be deleted/released)

        * @param aUpdateUi  Whether or not to do Ui update related things. Those are not

        * needed/allowed if this method is called just to return sequence mode setting

        * to default value (single capture).

        */ 

        void SwitchStillCaptureModeL( TCamImageCaptureMode aImageMode, 

                                      TBool                aReprepare, 

                                      TBool                aUpdateUi = ETrue );

        /**

        * Returns whether or the secondary camera has been activated

        * Will return ETrue when when the second camera is active

        * @since 2.8

        * @return ETrue if second camera is active, else returns EFalse

        */

        TBool IsSecondCameraEnabled() const;

        /**

        * Secondary camera orientation is constructed according to this flag.

        * Flag can be forced to portrait/landscape or it can follow qwerty 

        * state. Variation is handled via KCamCr2ndCamOrientation CenRep key.

        * @param aLock, Lock orientation state flag. 

        *               ETrue, ask state and lock it.

        *               EFalse, ask current state.

        * @return ETrue if secondary camera orientation must be landscape

        */

        TBool IsQwerty2ndCamera( TBool aLock = EFalse );  

        /**

        * 

        * @return ETrue if wait dialog exist

        */

        TBool CCamAppUi::IsWaitDialog() const;

        /**

        * Returns the active camera

        * @since 2.8

        * @return either primary, secondary or none ( if in process of switching )

        */

        TCamActiveCamera ActiveCamera() const;

        /**

        * Called just prior to capture. Checks if there is sufficient memory

        * available for capture and handles out of memory/error conditions. 

        * @since 2.8

        * @return ETrue if there is memory available for capture

        */

        TBool CheckMemoryL();

        /**

        * Display error note - with OK softkey only

        * @since 2.8

        * @param aStatus error status

        */

        void ShowErrorNoteL( TCamMemoryStatus aStatus );

        /**

        * Display error note for OOM condition - OK and Cancel softkeys

        * @since 2.8

        * @param aLabel text to be shown

        * @param aWithCancel Enables cancel softkey; default=ETrue

        * @return Response code returned from Out of memory dialog

        */

        TInt ShowOOMNoteL( TDesC& aLabel, TBool aWithCancel = ETrue);

        /**

        * Set the requested resolution for a new file

        * @since 3.2

        * @param aRequestedResolution the requested resolution from the new file request.

        */

        void SetRequestedNewFileResolution( const TSize& aRequestedResolution );

        /**

        * Get the requested resolution for a new file

        * @since 3.2

        * @return the requested resolution from the new file request.

        *  Default is TSize(0,0) which interpreted as mms quality resolution

        */

        TSize RequestedNewFileResolution() const;

        /**

        * Shows the mmc removal note if it is required

        * @since 2.8

        */

        void ShowMMCRemovalNoteIfRequiredL();

        /**

        * Check memory card for available space and card status

        * @since 2.8

        * @param aFull on return contains ETrue if card is full

        * @param aStatus on return contains the card status

        * @param aCurrentLocation current storage location

        */

        void CheckMemoryCard( TBool& aFull,

                TCamMemoryStatus& aStatus, TCamMediaStorage aCurrentLocation );

        /**

        * Checks if aStorage location is full

        * @since 2.8

        * @param aStorage target storage location

        * @param aCurrentLocation current storage location

        * @return ETrue if aStorage location is full

        */

        TBool MemoryFull( TCamMediaStorage aStorage, TCamMediaStorage aCurrentLocation );

        /**

        * Starts the video/photo capture

        * @since 2.8

        * @param aKeyEvent Key used to start the capture

        * @return whether the key was consumed by the function

        */

        TKeyResponse StartCaptureL( const TKeyEvent& aKeyEvent );

        /**

        * Stops the video capture

        * @since 2.8

        */

        void EndCapture();

        /**

        * Changes the orientation to aNewOrientation

        * If aNewOrientation is EAppUiOrientationUnspecified, switches

        * to the normal orientation (this may depend on the currently

        * activated camera)

        * @since 3.0

        */

        void SwitchOrientationIfRequiredL( TInt aNewOrientation );

        /**

        * Returns pointer to side-pane

        * @since 2.8

        * @return pointer to CCamSidePane object constructed by appUi

        */

        CCamSidePane* SidePane();

        /**

        * Returns pointer to zoom-pane

        * @since 2.8

        * @return pointer to CCamZoomPane object constructed by appUi

        */

        CCamZoomPane* ZoomPane();

        /**

        * Returns current camera orientation

        * @since 3.0

        * @return current camera orientation

        */

        TCamOrientation CamOrientation();

        /**

        * set current camera orientation as landscape

        */

        void SetCamOrientationToLandscape();

        /**

        * Returns current viewstate

        * @since 3.0

        * @return current viewstate

        */

        TCamViewState CurrentViewState() const;

        /**

        * Returns target view state

        * @since 4.0

        * @return target view state