/*

* Copyright (c) 2005-2010 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:  CSysApAppUi class definition. This class handles all user

*                actions and also System Agent events.

*

*/

#ifndef SYSAPAPPUI_H

#define SYSAPAPPUI_H

// INCLUDES

#include <aknappui.h>

#include <aknkeylock.h>

#ifndef RD_MULTIPLE_DRIVE

 #include <aknmemorycarddialog.h>

#endif // RD_MULTIPLE_DRIVE

#include <starterclient.h>

#include <starter.hrh>

#include <babackup.h>

#include <rmmcustomapi.h>

#include <DosSvrServices.h>

#include "SysAp.hrh"

#include "SysApMMCObserver.h"

#include "MSysApPropertyResponder.h"

#include "SysApTimer.h"

#include <e32property.h>

#include "CoreApplicationUIsPrivateCRKeys.h"

#include <sysapcallback.h>

#include "SysApAccessoryObserver.h"

#ifdef RD_MULTIPLE_DRIVE

  #include "sysapdrivelist.h"

#endif // RD_MULTIPLE_DRIVE

#include "sysapusbchargerdetector.h"

#include "sysappsmcontroller.h"

// FORWARD DECLARATIONS

class CAknSmallIndicator;

class CAknSignalNotify;

class CAknBatteryNotify;

class CAknGlobalListQuery;

class CAknGlobalNote;

class CSystemLock;

class CSysApLightsController;

class CSysApPubSubObserver;

class CSysApProfileObserver;

class CSysApConnectionMonitorObserver;

class CSysApCenRepLightSettingsObserver;

class CSysApCenRepLogsObserver;

class CSysApCenRepBtObserver;

class CSysApCenRepFmTxObserver;

class CSysApCenRepController;

class CSysApStartupController;

class CSysApPowerKeyMenuObserver;

class CSysApWaitNote;

class CSysApSsSettingsObserver;

class CSysApShutdownImage;

class CSysApShutdownAnimation;

class CSysApEtelConnector;

class CSysApMsgSimMemLowQuery;

class CSysApNspsHandler;

class CSysApConfirmationQuery;

class CSysApFeatureManager;

class MSysApOfflineModeController;

class MSysApBtController;

class MSysApBtSapController;

class MSysApUsbIndicator;

class MSysApLocationPrivacyIndicator;

class MProfileEngine;

class MProfilesNamesArray;

class CSysApKeySndHandler;

class CSysApKeyManagement;  // KEF

class CSysApMediatorObserver;

class CAknAppUiBase;

class CSysApCenRepHacSettingObserver;

class CSysApAudioRoutingObserver;

class CSysApCenRepCallForwardingObserver;

class CSysApCenRepMsgWaitingObserver;

// POC launching

class CAiwServiceHandler;

class CSysApDefaultKeyHandler;

class CSysApDriveUnlockHandler;

class CSysApDriveEjectHandler;

class CSysApBatteryInfoController;

//CONSTANTS

const TInt KDummyReason( -1 );

const TInt KBluetoothModulePowerModeOn ( 1 );

const TInt KBluetoothModulePowerModeOff ( 0 );

const TInt KGeneralProfileId ( 0 );

const TInt KOfflineModeProfileId ( 5 );

const TInt KApplicationScanningInterval( 1 ); // 1 second

_LIT( KFSName, "Fat" );                 // MMC file system name

const TDriveNumber KMMCDrive = EDriveE; // MMC drive number

//CLASS DECLARATION

/**

*  CSysApAppUi class. This class serves as a link between the other

*  SysAp classes and performs the most UI specific operations on SysAp's

*  responsibility.

*

*  @lib   sysap

*  @since 1.0

*/

class CSysApAppUi :

                    public CAknAppUi,

#ifndef RD_MULTIPLE_DRIVE

                    public MAknMemoryCardDialogObserver,

#endif // RD_MULTIPLE_DRIVE

                    public MSysApMemoryCardObserver,

                    public MSysApTimerResponder,

                    public MSysapCallback,

                    public MSysApPsmControllerNotifyCallback

{

    public:

        /**

        * C++ default constructor.

        * @param None

        * @return void

        */

        CSysApAppUi();

        /**

        * Destructor

        * @param None

        * @return void

        */

        virtual ~CSysApAppUi();

    protected: // From MSysApTimerResponder

        /**

        * Handle events from CSysApTimer

        * @param None

        * @return void

        */

        void TimerExpiredL();

    public:

        /**

        * Gets called when shutdown continues after shutdown animation

        * @param None

        * @return void

        */

        void ContinueShutdown();

        /**

        * Gets called when there is need to shutdown the device initiated by Symbian side

        * @param None

        * @return void

        */

        void DoShutdownL( const TBool aReset, const TInt aResetReason );

        /**

        * Gets called by CSysApSharedDataObserver if user has selected "No" in

        * "Do you want to use the phone in Off-line mode?" query in startup.

        * @param aDoProfileChange if ETrue, the last active profile is restored

        * @return void

        */

        void GoOnlineL( TBool aDoProfileChange = ETrue );

        /**

        * Gets called by CSysApSharedDataObserver in Simless Offline Mode startup.

        * @param None

        * @return void

        */

        void GoOfflineL();

        /**

        * Calls CSysApOfflineModeController::SwitchFromOnlineToOfflineModeL()

        * @param None

        * @return void

        */

        void SwitchFromOnlineToOfflineModeL();

        /**

        * Called when offline mode change has been finished.

        */

        void OfflineModeChangedL();

        /**

        * Gets called after changing the SW state.

        * @param aSwState The new state

        * @return void

        */

        void DoStateChangedL( const RStarterSession::TGlobalState aSwState  );

#ifdef SYSAP_USE_STARTUP_UI_PHASE        

        /**

        * Called when UI is ready after boot.

        */

        void HandleUiReadyAfterBootL();

#endif // SYSAP_USE_STARTUP_UI_PHASE

        /**

        * Returns whether UI is ready after boot.

        */

        TBool UiReady() const;

        /**

        * Gets called when any case selection on powerkey menu is done.

        * Does what is needed per selection.

        * @param TInt aSelection

        * @return void

        */

        void PowerKeyPopUpMenuSelectionDoneL( TInt aSelection );

        /**

        * Gets called when Alarm is being shown to user and lights need to be blinked.

        * @param TBool aAlerting

        * @return void

        */

        void AlertUiAlertingL( const TBool aAlerting );

        /**

        * Gets called when Alarm is being shown to user and keylock need to be turned off.

        * @param TBool aKeyLockOff

        * @return void

        */

        void AlertUiKeyLockOff( const TBool aKeyLockOff );

        /**

        * Notifies changes in KPSUidCoreApplicationUIs::KLightControl to light controller.

        */

        void HandleLightsRequireL() const;

        /**

        * Notifies changes in KPSUidCoreApplicationUIs::KCoreAppUIsLightsRawKeyEvent to light controller.

        *

        * @since S60 3.2

        */

        void HandleRawKeyEventLightsRequireL() const;

        /**

        * Gets called when Video Telephony requests to force/cancel lights on/

        * @param const TInt aLightsParameter

        * @return void

        */

        void HandleForcedLightsVTRequireL( const TInt aLightsParameter ) const;

        /**

        * Gets called when Screen Saver requests to force lights on/off

        * @param const TInt aLightsParameter

        * @return void

        */

        void HandleForcedLightsSSRequireL( const TInt aLightsParameter ) const;

				/**

        * Gets called when AT Command requests to force lights on/off

        * @param const TInt aLightsParameter

        * @return void

        */

				void HandleForcedLightsATCRequireL( const TInt aLightsParameter ) const;

        /**

        * Calls SysApLightsController::SwitchLightsOnSoftRejectL

        *

        * @since S60 3.1

        * @param None.

        * @return None.

        */

        void SwitchLightsOnSoftRejectL();

        /**

        * Asks state of one property from PubSub

        * @param const TUid&

        * @param const TUint

        * @return const TInt ( value of property or error code )

         */

        TInt StateOfProperty( const TUid& aCategory, const TUint aKey ) const;

        /**

        * Sets the indicator's aIndicator state to state aState.

        * @param TInt aIndicator

        * @param TInt aState

        * @return void

        */

        void SetIndicatorStateL( const TInt aIndicator, const TInt aState ) const;

        /**

        * Returns the state of keylock

        * @param none

        * @return TBool the state of keylock

        */

        TBool KeyLockState() const;

        /**

        * Returns the state of devicelock

        * @param none

        * @return TBool the state of devicelock

        */

        TBool DeviceLockState() const;

        /*

        * @param None

        * @return void

        */

        void SetIhfIndicatorL();

        /*

        * Handles actions needed when either SIM memory gets too full to receive any more SMS's.

        * @param aSimStoreFull If true, SIM memory is full.

        * @return void

        */

        void HandleSmsStorageNotificationL( TBool aSimStoreFull );

        void HandleNspsRawKeyEventL();

        void HandleNetworkNspsNotification( RMmCustomAPI::TNspsStatus aNspsStatus );

        void HandleMessageTonePlayingQuitability( TInt aTonePlayingStatus );

        /*

        * Called by SysApLightsController when the lights are switced on/off

        * @param aActivate If ETrue forwarding is activated, otherwise deactivated

        * @return void

        */

        void ActivateKeyeventForwardingForLights(TBool aActivate);

        /**

        * Gets called when shutdown requested when sw state == ESWStateAlarm

        * context active.

        * @param None

        * @return void

        */

        void StartShutDownTimerOnAlarmAndChargingStates();

        static TInt DoShutdownOnAlarmStateAfterCallBack( TAny* aObject );

#ifndef RD_STARTUP_ANIMATION_CUSTOMIZATION

        /**

        * Starts shutdown animation timing after shutdown tone sync is done

        */

        void StartAnimTiming();

#endif // RD_STARTUP_ANIMATION_CUSTOMIZATION

        /**

        * Stops shutdown animation timing and continues shutdown.

        */

        static TInt DoStopAnimTiming( TAny* aObject );

        /**

        * Gets called when GPRS is suspended because of a phone call established while

        * context active. Delay (KDelayBeforeShowingGprsSuspendedNote) required to ensure

        * that the phone call was really established.

        * @param None

        * @return void

        */

        void StartGprsSuspendedTimer();

        static TInt ShowGprsSuspendedNoteAfterCallBack( TAny* aObject );

        /**

        * Gets called when an accessory was connected to device. The indicator

        * is shown and profile gets changed if needed.

        * @param aAccessoryState Indicates the new accessory state

        * @return void

        */

        void HandleAccessoryConnectedL( TAccMode aAccessoryState );

        /**

        * Gets called when headset/loopset was disconnected from device. The indicator

        * is hidden and the original profile gets restored if needed.

        * @param None

        * @return void

        */

        void HandleAccessoryDisconnectedL();

        /**

        * Gets called when SysAp receives KSysApSatRefreshStart. All

        * non-system UI applications are closed

        * and an information note is shown to the user.

        * @param None

        * @return void

        */

        void HandleSatRefreshL();

#ifndef RD_MULTIPLE_DRIVE

        /**

        * Mounts MMC drive

        * @param None

        * @return TInt : error value from RFs::MountFileSystem()

        */

        TInt MountMMC();

        /**

        * Dismounts MMC drive

        * @param None

        * @return TInt : error value from RFs::MountFileSystem()

        */

        TInt DismountMMC();

#endif // RD_MULTIPLE_DRIVE

        /**

        * MMC Hot Swap Ejection from powerkey menu

        * @param None

        * @return void

        */

        void EjectMMCL();

        /**

        * Disconnect BtSap from powerkey meny

        * @param None

        * @return void

        */

        void DisconnectBtSap();

         /**

         * Enable or disable FM transmission 

         */

         void ChangeFmTxStateL( TBool aEnable );

#ifndef RD_MULTIPLE_DRIVE

    public: // from MAknMemoryCardDialogObserver

        /**

        * To be notified when unlock completed

        * @param TInt aResult

        * @return void

        */

        void UnlockComplete( TInt aResult );

#endif // RD_MULTIPLE_DRIVE

    public:

        /**

        * Plays the sound EAvkonSIDInformationTone

        * @param None

        * @return void

        */

        void Beep();

#ifndef RD_MULTIPLE_DRIVE

        /**

        * Unlocks MMC

        * @param None

        * @return void

        */

        void RunUnlockNotifierL( TSysApMemoryCardStatus aMemoryCardStatus = ESysApMemoryCardStatusNotKnown );

        /**

        * From MSysApMemoryCardObserver.

        * Gets called by CSysApMMCObserver when an MMC is inserted/removed

        * @return void

        */

        void MMCStatusChangedL();

        /**

        * Shows "MMC removed..." dialogs

        * @param None

        * @return void

        */

        void ShowMMCDismountedDialogL();

#else // RD_MULTIPLE_DRIVE

        /**

        * Updates PS key during boot

        * @return void

        */

        void MMCInsertedL();

        /**

        * Unlocks MMC

        * @param None

        * @return void

        */

        void RunUnlockNotifierL();

        /**

        * From MSysApMemoryCardObserver.

        * Gets called by CSysApMMCObserver when an MMC is inserted/removed

        * @param aDrive Changed drive

        * @return void

        */

        void MMCStatusChangedL( TInt aDrive );

        /**

        * Shows "MMC removed..." dialogs

        * @param aDrive Drive to dismount

        * @param aEjectType Eject type used for the drive

        * @return void

        */

        TBool ShowMMCDismountedDialogL(

            TInt aDrive, CSysApDriveList::TDriveEjectType aEjectType );

#endif // RD_MULTIPLE_DRIVE

        /**

        * Called after confirming dialog "MMC removed..."

        * @param None

        * @return void

        */

        void MMCDismountedDialogConfirmed();

        /**

        * Gets called by CSysApSharedDataObserver when "Eject" is started

        * or finished in File Manager application.

        * @param None

        * @return void

        */

        void EjectStarted( TBool ejectStarted );

    private:

        /**

        * EPOC default constructor.

        * @param None

        * @return void

        */