/*

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

*     Defines the CMceUi class

*

*/

#ifndef MCEUI_H

#define MCEUI_H

//  INCLUDES

#include <aknViewAppUi.h>       // CAknViewAppUi

#include <MuiuMsvSingleOpWatcher.h>

#include "MtmRegistryObserver.h" // MMtmUiDataRegistryObserver

#include <MsgArrays.h>          // CUidNameArray

#include <gulicon.h>            // CGulIcon

#include "MceUtils.h"           // MMceAccountManager

#include "MsgFunctionInfo.h"

#include "MceIds.h"

#include "MceLogText.h"

#include <AknTabObserver.h>     // MAknTabObserver

#include <rconnmon.h>

#include "MceMailAccountItem.h"

#include <mcesettingsaccountmanager.h> // in MceSettings.dll

#include <bldvariant.hrh>

#include "MceEmailNotifHandler.h"

#include <AknQueryDialog.h>

#include <mmsclient.h>

// DATA TYPES

enum

    {

    EMceMainViewActive = 0x01,

    EMceMessageViewActive = 0x02,

    EMceDeliveryReportsViewActive = 0x04

    };

enum

    {

    EMceUiFlagsFinishedConstruction = 0x01,

    EMceUiFlagsServerReady          = 0x02,

    EMceUiFlagsTabsActive           = 0x04,

    EMceUiFlagsWantToExit           = 0x08,

    EMceUiFlagsExitAfterDisconnect  = 0x10,

    EMceUiFlagsDoNotExitAfterNextOperationComplete = 0x20,

    EMceUiFlagsMainViewActivated = 0x40,

    EMceUiFlagsMediaUnavailable = 0x80,

    EMceUiFlagsSupressViewUpdate = 0x100,

    EMceUiFlagsMainViewAiwCreated = 0x200,

    EMceUiFlagsMessageViewAiwCreated = 0x400,

    EMceUiFlagsSettingsDialogOpen = 0x800,

    EMceUiFlagsExitOnMsvMediaAvailableEvent = 0x1000,

    EMceUiFlagsContainerAddedToStack = 0x2000,

    };

#define KMsvMyFoldersEntryIdValue 0x1008

const TMsvId KMsvMyFoldersEntryId=KMsvMyFoldersEntryIdValue;

typedef CArrayFixFlat<TMceMailAccountItem> CMceMailAccountItemArray;

// FORWARD DECLARATIONS

class CMsvSession;

class CMtmStore;

class CMtmUiDataRegistry;

class CMceMessageListView;

class CMceMainViewListView;

class CMceSessionHolder;

class CMceBitmapResolver;

class CMceConnectMailboxTimer;

class CMceLogEngine;

class CMessageIterator;

class CAknNavigationControlContainer;

class CAknNavigationDecorator;

class CMceIdleMtmLoader;

class CAknLocalScreenClearer;

class CErrorUI;

class CAknTitlePane;

class CSendingServiceInfo;

class CMceDeliveryReportView;

class CImumInternalApi;

class CMceIAUpdateUtils;

class CMmsCodecClient;

// CLASS DECLARATION

/**

*  Mce's UI class.

*/

class CMceUi :

    public CAknViewAppUi,

    public MMsvSessionObserver,

    public MMtmUiDataRegistryObserver,

    public MMsvSingleOpWatcher,

    public MMceSettingsAccountManager,

    public MAknTabObserver,

    public MConnectionMonitorObserver,

    public MCoeForegroundObserver // CR : 401-1806

    {

    public:  // Constructors and destructor

        /**

        * C++ default constructor.

        */

        CMceUi();

        /**

        * Destructor.

        */

        virtual ~CMceUi();

    public:

        /**

        * Opens message folder and activates message view

        * @param aFolderId id of the folder to be opened

        */

        void OpenFolderViewL( TMsvId aFolderId );

        /**

        * Opens remote mailbox and activates message view

        * @param aFolderId id of the folder to be opened

        */

        void OpenRemoteMailboxViewL( TMsvId aFolderId );

        /**

        * Cancels ConnectMailboxTimer.

        */

        void CancelMailboxTimer();

        /**

        * Calls corresponding mtm to edit entry

        * @param aEntry: entry to be edited.

        */

        void EditMTMEntryL( const TMsvEntry& aEntry );

        /**

        * Used to launch unieditor

        */

        void LaunchUniEditorL();

        /**

        * Opens connection to account

        * @param aAccount account id to be connected.

        */

        void GoOnlineL( TMsvId aAccount );

        /**

        * Opens connection to account with confirmation query.

        * @param aAccount account id to be connected.

        */

        void GoOnlineWithQueryL( TMsvId aAccount );

        /**

        * Closes connection to mailbox.

        * @param aAccount account id to be disconnected.

        */

        void GoOfflineL( TMsvId aAccount );

        /**

        * Connects or disconnects

        * @param aServiceId id of the account to be connected

        * or disconnected.

        * @param aConnect ETrue if connected, EFalse if disconnected.

        */

        void ChangeServiceConnectionStateL(TMsvId aServiceId, TBool aConnect);

        /**

        * Fills TMsvEntry structure of the message.

        * @param aId id of the message.

        * @param aEntry structure to be filled.

        */

        TMsvId GetEntryL(TMsvId aId, TMsvEntry& aEntry) const;

        /**

        * Closes connection if only one online. If more than one connection on

        * displayes query to disconnect.

        */

        void CloseConnectionWithListQueryL();

        /**

        * Returns pointer to log engine.

        */

        CMceLogEngine* LogEngine();

        /**

        * Launches help application

        */

        void LaunchHelpL();

        /**

        * Checks if command is currently available

        * @param aCommand command id

        * @param aEntryToCheck current entry selected

        * @return 0 if available. != 0 otherwise

        */

        TInt CheckCommandAvailableL( TInt aCommand, TMsvEntry& aEntryToCheck );

        /**

        * Checks if command is currently available

        * @param aCommand command id

        * @param aEntriesToCheck currently selected entries

        * @return 0 if available. != 0 otherwise

        */

        TInt CheckCommandAvailableL( TInt aCommand, CMsvEntrySelection* aEntriesToCheck );

        /**

        * Called when UI receives HandleSessionEventL( EMsvServerReady, .... )

        * from msgs.

        * Creates needed messaging related objects, collects info of the

        * installed MTMs, creates icon array and finally activates main view.

        */

        void HandleServerStartupL();

        /**

        * Displayes tabs (creates tabs if not already created).

        * Should be called when opening folder.

        * @param: aOpenedId: id of the folder to be opened (used to set active tab)

        * @param: aOpeningDeliveryReports: ETrue when opening delivery reports view and aOpenedId is ignored.

        *                                  EFalse if opening folder from msgs.

        */

        void ShowTabsL( TMsvId aOpenedId, TBool aOpeningDeliveryReports = EFalse );

        /**

        * Removes tabs.

        */

        void RemoveTabs();

        /**

        * Should be called by view's DoActivate to inform mceui what view is active.

        * Sets view flag.

        * @param aActiveView: EMceMainViewActive or EMceMessageViewActive, etc

        */

        void SetMceViewActive( TUint aActiveView );

        /**

        * Query function to query is certain view active

        * For example MceViewActive( EMceMainViewActive ).

        * @param aActiveView: EMceMainViewActive or EMceMessageViewActive, etc

        * @return ETrue if view is active, EFalse otherwise

        */

        TBool MceViewActive( TInt aActiveView ) const;

        /**

        * Sends entry via BT or IR.

        * @param aId: id of the message to be sent

        * @param aMtm: mtm to be used to send

        */

        void SendViaL( TMsvId aId, TUid aMtm );

        /**

        * Returns ETrue if mce is performing editor opening operation

        */

        TBool IsEditorOpen( ) const;

        /**

        * Gets status pane of the mce application

        * @return pointer to status pane (to the object of CAknTitlePane)

        */

        CAknTitlePane* TitlePaneL() const;

        /**

        * Activates timer for mailbox connection query

        * @param aEntryId: folder to be opened

        */

        void ActivateConnectionQueryTimerL( TMsvId aEntryId );

        /**

        * Clears EMceUiFlagsExitAfterDisconnect flag

        * 

        */

        void ClearExitAfterDisconnectFlag();

        void SetViewUpdateSuppressionFlag( TBool aValue, CMsvOperation* aOp );

        TBool ViewUpdateSuppressionFlag();

        /**

        * Sets EMceUiFlagsDoNotExitAfterNextOperationComplete flag

        * 

        */

        void SetDontExitOnNextOperationComplete();

        /**

        * Clears EMceUiFlagsDoNotExitAfterNextOperationComplete flag

        * 

        */

        void ClearDontExitOnNextOperationComplete();

        /**

        * Call back function, clears EMceUiFlagsDoNotExitAfterNextOperationComplete flag

        * 

        */

        static TInt ClearDontExitOnNextOperationComplete( TAny* aAny );

        /**

        * Checks if SyncML mail synchronizing going on

        * Returns ETrue, if synchronizing is going on 

        */

        TBool IsSyncronizingL( const TMsvEntry& entry );

        /**

        * Checks when last always online connection succeeded

        * @param aAccount: service id

        * Returns EFalse, if last connection failed 

        */

        TBool AlwaysOnlineLastConnectionL( const TMsvId aAccount );

        /**

        * Checks if always online feature is supported       

        * Returns ETrue, if always online is supported

        */

        TBool AlwaysOnline( );

        /**

        * Checks if remote mailbox connection was made in mce

        * @param aServiceId: service id

        * Returns ETrue, if connection was made in Mce 

        */

        TBool ServiceIdFound( const TMsvId& aServiceId );

        /**

        * If connection is made in mce, adds operation id/service in iMailAccountItemArray

        * @param aOp: operation id

        * @param aServiceId: service id  

        */

        void AddOperationIdL( const TMsvOp& aOp, const TMsvId& aServiceId );

        /**

        * Removes operation id from iMailAccountItemArray 

        * @param TMsvId: operation id

        * @param aServiceId: service id  

        */

        void RemoveOperationId( const TMsvId& aOpId, const TMsvId& aServiceId );

        /**

        * Shows a query in mce startup,

        * if message store was automatically changed to phone from MMC

        * @param aShowQuery: if ETrue, query can be shown

        */

        void ToPhoneMemoryQueryL( TBool aShowQuery );       

        /**

        * Sets EMceUiFlagsMainViewActivated flag

        *        

        */

        void SetMainViewActivatedFlag( );

        /**

        * Removes folder tabs.

        */

        void RemoveFolderTabs();

        /**

        * Shows folder tabs.

        * @param aDepth: folder path depth

        */

        void ShowFolderTabsL( const TInt aDepth );

        /**

        * Adds mtm specific functions to the menu for multiselection

        * @param aMenuPane

        * @param aMenucommandId id of the command after mtm specific functions are added

        */

        void AddMultiselectionMTMFunctionsL( CEikMenuPane& aMenuPane, TInt aMenuCommandId );

        /**

        * Check mtm specific tecnology uid

        * @param aTechnologyType

        * @param aMtmType

        * Returns ETrue, if tecnologyUid match with mtm.

        */

        TBool CheckTechnologyTypeFromMtm( const TUid aTechnologyType, TUid aMtmType );

        /**

        * Checks if the message is set to be deleted from server

        * Returns ETrue, if the message is set to be deleted from server, EFalse otherwise

        */        

        TBool IsMailSetToBeDeletedFromServerL( TMsvId aItemId );

        /**

        * Defines item to be anchored when entries are deleted or moved from entry list.

        */

        void DefineAnchorIdL( const CMsvEntrySelection* aSelection );

        /**

        * Return itemId that should be focused after deleting or moving some entries.

        */

        TMsvId AnchoredItem();

        /**

        * Set anchorId.

        * @param aAnchorId itemId that should be focused after deleting or moving some entries.

        */

        void SetAnchorId( TMsvId aAnchorId );

    public:     // Functions from base classes

        /**

        * From CEikAppUi

        */

        void HandleCommandL( TInt aCommand );

        /**

        * From CEikAppUi

        */

        void DynInitMenuPaneL( TInt aResourceId, CEikMenuPane* aMenuPane );

        /**

        * From MMsvSessionObserver

        */

        virtual void HandleSessionEventL(

            TMsvSessionEvent aEvent,

            TAny* aArg1,

            TAny* aArg2,

            TAny* aArg3);

        /**

        * From CAknViewAppUi

        */

        void ActivateLocalViewL( TUid aViewId );

        /**

        * From MMceAccountManager

        */

        TBool CreateNewAccountL(

            TUid aMessageType,

            TMsvId aOldServiceId );

        /**

        * From MMceAccountManager

        */

        void EditAccountL( TMsvId aId );

        /**

        * From MMceAccountManager

        */

        CUidNameArray* MtmAccountsL( TUid aType );

        /**

        * From MMceAccountManager

        */

        TBool CanCreateNewAccountL(TUid aMtm);

        /**

        * From MMceAccountManager

        */

        void DeleteAccountL(TMsvId aId);

        /**

        * From MMceAccountManager

        */

        CMsvSession& Session();

        /**

        * From MMceAccountManager

        */

        TBool IsPresent( TUid aMtm ) const;

        /**

        * From MMceAccountManager

        */

        THumanReadableName MtmName( TUid aType ) const;

        /**

        * From MMceAccountManager

        */

        void SetChangeMessageStore( TBool aChangeEnded );

        /**

        * From MMtmUiDataRegistryObserver

        */

        virtual CBaseMtmUiData* GetMtmUiDataL( TUid aEntryType );

        /**

        * From MMsvSingleOpWatcher

        */

        virtual void OpCompleted(

            CMsvSingleOpWatcher& aOpWatcher,

            TInt aCompletionCode );

        /**

        * From MAknTabObserver

        */		

        void TabChangedL( TInt aIndex );

        /**

        * From CEikAppUi

        */

        void HandleResourceChangeL( TInt aType );

        /**

        * From MConnectionMonitorObserver

        */

        void EventL( const CConnMonEventBase &aConnMonEvent );

        /**

         * From MCoeForegroundObserver

         */

        void HandleGainingForeground(); // CR : 401-1806

         /**

         * From MCoeForegroundObserver

         */

        void HandleLosingForeground(); // CR : 401-1806

        /**

        * MMS.Content.Upload

        */

        void DoUploadL( TInt aCommand );

        /**

        * MMS.Content.Upload query

        */

        void ShowUploadQueryL( );

		/**