/*

* Copyright (c) 2006 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:  IM application AppUi class

 *

*/

#ifndef CCAAPPUI_H

#define CCAAPPUI_H

// INCLUDES

#include "MCAViewSwitcher.h"	// MCAViewSwitcher

#include "ChatDefinitions.h"

#include "MCAAppUi.h"

#include "MCAUiLoginCmdCB.h"

#include "TEnumsPC.h"

#include "MCAUiGlobalNotificationObserverPC.h"

#include <aknviewappui.h>		// CAknViewAppUi

#include <aknwaitdialog.h>

#include <akntabobserver.h>

#include <MWVSettingsCASettingsng.h>

#include <MWVSettingsObserverng.h>

#include "CAExternalInterface.h"

#include <AknInfoPopupNoteController.h> // for CAKnInfoPopupNote

#include <MIMPSSAPObserver.h>

#include "MCABackGroundTaskObserver.h"

#include "MCASplashScreenObserver.h"

#include "MCASkinVariant.h"

#include <cimpspresenceconnectionuing.h> // for enum TIMPSLoginType

// FORWARD DECLARATIONS

class CCAEngine;

class CIMPSConnectionUiAgent;

class CIMPSSAPSettingsStore;

class CIMPSSAPSettings;

class CCASplashScreen;

class CCAStatusPaneHandler;

class CCAAudioManager;

class CCAInputAbsorber;

class CIdle;

class MCALayoutChangeObserver;

class CCAGroupUtils;

class CCAUISessionManager;

class CCAIconLoader;

class CCAMessageExtensionsHandler;

class MCAOpBrandVariant;

class MCAServerChangeNotify;

class MCANotifierInterface;

class MCALayoutInfo;

class CCALayoutInfo;

class CWVSettingsUIDialog;

class MCAProcessManager;

class TAknLayoutScalableParameterLimits;

class TAknWindowComponentLayout;

class MCAConversationMessage;

class MCAApplicationNGPC;

class MCAGroupManagerInterface;

// CLASS DECLARATION

/**

 *  Eikon application architectures AppUi class

 *

 *  @lib chatng.app

 *  @since 3.2

 */

class CCAAppUi : public CAknViewAppUi,

            public MCAAppUi,

            public MCAViewSwitcher,

            public MProgressDialogCallback,

            public MAknTabObserver,

            public MCAUiGlobalNotificationObserverPC,

            public MWVSettingsCASettings,

            public MWVSettingsObserver,

            public MAknInfoPopupNoteObserver,

            public MIMPSSAPObserver,

            public MCABackGroundTaskObserver,

            public MCASplashScreenObserver

    {

    public: // Constructors and destructor

        /**

         * C++ default constructor.

         * @param aEngine Reference to application model (engine)

         */

        CCAAppUi( CCAEngine& aEngine, MCAProcessManager& aProcessManager );

        /**

         * Destructor.

         */

        virtual ~CCAAppUi();

    public: // New functions

        class CKludgeScheduler : public CActiveScheduler

            {

            public:

                 TInt PublicLevel() const;

            };

        //Get the level of current active scheduler

        TInt LevelOfActiveScheduler();

        /**

        * Handle to IM Connection UI

        * @since 3.2

        * @return Handle to im connection ui

        */

        CIMPSPresenceConnectionUi& ConnectionUI();

        /**

        * Handle to UI session manager

        * @since 2.1

        * @return Handle to ui session manager

        */

        CCAUISessionManager& UISessionManager();

        /**

         * Fetches a handle to status pane handler

         * @return handle to status pane handler (CCAStatusPaneHandler*)

         */

        CCAStatusPaneHandler* CAStatusPane() const;

        /**

         * Fetches a handle to application's process manager

         * @see MCAProcessManager

         * @Returns a reference to process manager

         */

        MCAProcessManager& GetProcessManager() const;

        /**

         * Gets a pointer to screenname buffer containing

         * KScreenNameMaxLength of editable space

         * @return Descriptor that contains screen name

         */

        HBufC* ScreenNamePtr();

        /**

         * Clears Universal Indication Pane's IM-icon

         */

        void IMUIPIConForcedClear();

        /**

         * Sets new counter value to IM's soft notification

         * @param aCount new count of unread messages

         */

        void SetSoftNotificationCounterL( TInt aCount ) const;

        /**

         * Plays default beep

         */

        void PlayBeep();

        /**

         * Capture events if needed

         */

        void CaptureEventsL();

        /**

         * Releases events capturing

         */

        void ReleaseCapturingL();

        /**

         * Returns if events are captured

         * @return ETrue if captured

         */

        TBool AreEventsCaptured() const;

        /**

         * Handles the actual invitation response

         * @param aAcceptance ETrue if accepted

         * @param aUserId Descriptor that contains user id

         * @param aGroupName Descriptor that contains group name

         * @param aResponse Descriptor that contains response message

         */

        void DoHandleInvitationResponseL( TBool aAcceptance,

                                          const TDesC& aUserId,

                                          const TDesC& aGroupName,

                                          const TDesC& aResponse );

        /**

         * Returns the number of received messages (invitations + p2pmessages)

         * since last call to ResetMsgCount

         * @return received messages count

         */

        TInt ReceivedInvites() const;

        /**

         * Returns the instance of CCAGroupUtils

         * @return pointer to group utility class's instance

         */

        CCAGroupUtils* GroupUtils();

        /**

         * Sets the forwarded message. This method will not take the

         * ownership of the passed message, but will create a clone

         * of it. So it doesn't matter if the actual message gets deleted.

         * @param aFwdMessage forwarded message

         */

        void SetForwardMessageL( const MCAConversationMessage* aFwdMessage );

        /**

         * Gets the forwarded message or NULL

         * @return forwarded message

         */

        const MCAConversationMessage* ForwardMessage();

        /**

         * Shows wait dialog. Remember to call DismissWaitDialogL after this!

         * !! Remember to TRAP everything between ShowWaitDialogL and

         * DismissWaitDialogL and give the error code as parameter to

         * DismissWaitDialogL !!

         * @param aTextResource Resource ID of text to be displayed

         * @param aShowImmediately Should the dialog be shown immediately

         */

        void ShowWaitDialogL( TInt aTextResource, TBool aShowImmediately = EFalse );

        /**

         * Shows wait dialog. Remember to call CleanupStack::Pop and DismissWaitDialogL

         * after this! Call CleanupStack::Pop first. Leaves one item in cleanup stack.

         * @param aTextResource Resource ID of text to be displayed

         * @param aShowImmediately Should the dialog be shown immediately

         */

        void ShowWaitDialogLC( TInt aTextResource, TBool aShowImmediately = EFalse );

        /**

         * Overridden version that takes text descriptor as parameter

         * @param aText Prompt text

         * @param aShowImmediately Should the dialog be shown immediately

         */

        void ShowWaitDialogL( const TDesC& aText, TBool aShowImmediately = EFalse );

        /**

         * Overridden version that takes text descriptor as parameter and places one item

         * in cleanup stack. Remember to call CleanupStack::Pop and DismissWaitDialogL

         * after this! Call CleanupStack::Pop first.

         * @param aText Prompt text

         * @param aShowImmediately Should the dialog be shown immediately

         */

        void ShowWaitDialogLC( const TDesC& aText, TBool aShowImmediately = EFalse );

        /**

         * Dismisses the wait dialog. Shows also error note on imps errors.

         * @param aErrorCode Error code. Leaves on system error codes

         *        (greater than Imps_ERROR_BASE) after deleting the dialog.

         * @param aWaitUntilDismissed Should we wait until the dialog is gone

         * @param aAdditionalData Additional data for the dialog

         */

        void DismissWaitDialogL( TInt aErrorCode, TBool aWaitUntilDismissed = EFalse,

                                 const TDesC& aAdditionalData = KNullDesC );

        /**

         * Returns icon loader

         * @since 2.1

         * @return Reference to icon loader

         */

        CCAIconLoader& IconLoader() const;

        /**

         * Returns message handler

         * @since 2.1

         * @return Reference to message handler

         */

        CCAMessageExtensionsHandler& MessageHandler() const;

        /**

         * Modify ID for display. From userid, groupid "wv:" is hidden.

         * From list id "wv:userid" is hidden.

         * @param aId The id to modify

         * @param aListHiding Modify id for list hiding

         * @return The id with some parts hidden

         */

        static TPtrC DisplayId( const TDesC& aId, TBool aListHiding = EFalse );

        /**

         * Read the branded resources and set appropriate flags.

         * Done during construction and SAP change event.

         * Reads:

         *   - the wv: hiding setting.

         * @since 2.1

         */

        void ReadBrandedResourcesL();

        /**

         * Sets the refresh flag

         */

        void SetRefreshed();

        /**

         * @return ETrue if the "refresh list"-command has been used

         */

        TBool ListRefreshed();

        /**

         * Changes the resource of connection UI agent.

         * @param aNewResource the resource to be used

         */

        void ChangeConnUiAgentResourceL( const TDesC& aNewResource );

        /**

         * Returns view which should be called after refreshView.

         * @param aPrevious This is used normally. Override if needed.

         */

        TUid AfterRefreshViewId( const TUid& aPrevious );

        /**

         * Set mode of after refresh.

         * @param aMode True, use default, EFalse switch to MainView after refrehs.

         */

        void SetAfterRefreshMode( TBool aMode );

        /**

         * @return a MCALayoutInfo pointer

         */

        MCALayoutInfo* LayoutInfo();

        /**

         * To get information of refrheswaitflag.

         * @return reference to refresh wait flag.

         */

        TInt& RefreshWaitFlag();

        /**

        * Returns a flag which informs about the state of appui.

        * Either it's fully functional or being destroyed.

        * @return ETrue if appui is being destroyed

        */

        TBool IsUnderDestruction();

        /**

         * Initialize observers to the engine.

         * @since 3.0

         */

        void InitializeEngineObserversL();

        /**

         * Finalize construction of chat

         * @since 3.0

         */

        void FinalizeChatConstructionL();

        /**

         * Sets new message beep not to be played next time

         * when playing is requested.

         * @since 3.1

         * @param aPlayOnce ETrue if beep allready played, EFalse otherwise.

         */

        void SetPlayOnce( TBool aPlayOnce );

        /**

         * Launches server settings dialog

         * @since 3.1u

         */

        void LaunchServerSettingsDialogL();

        /**

         * Notify resource observers.

         * This should be called whenever resources are changed.

         * @since 3.0

         */

        void NotifyResourceChangeL();

#ifdef RD_CHAT_GROUP_MESSAGE_INDICATION_NEW

        /**

         * Returns construction state.

         * @since S60 v3.2

         * @return ETrue if construction done, EFalse otherwise.

         */

        TBool IsFullyConstructed() const;

#endif  // RD_CHAT_GROUP_MESSAGE_INDICATION_NEW

#ifdef RD_SETTINGS_FACELIFT

        /**

         * Is settings dialog active or not.

         * @since S60 v3.2

         * @return ETrue if iServSettingsDialog != NULL

         */

        TBool IsSettingsDialogActive() const;

#endif  // RD_SETTINGS_FACELIFT

        /**

         * Call this when asynchronously launched dialog has returned

         * @see ReportPendingDialog

         * @since 3.1

         */

        void ReportPendingDialogClosed();

        /**

         * When launching a dialog asynchronously, this method should be

         * called, so that AppUI knows to give dialog time to return.

         * If you call this, you MUST call ReportPendingDialogClosed when

         * the dialog is closed. Otherwise the AppUI hangs on exit!

         * @since 3.1

         */

        void ReportPendingDialog();

        /**

         * Sets if forward once.

         * ReSets if forward is more than once..

         */

        void SetResetForwardTo( TEnumsPC::TForwardStatus aForward );

        /**

         *  Return iForward.

         */

        TEnumsPC::TForwardStatus RetForwardTo( );

        /**

         * Unregisters the previous view registered

         * before forwarding.

         */

        void UnRegisterPreviousview();

#ifdef RD_MULTIPLE_DRIVE

        /**

         * Gets the status of the drive.

         *	@since 2.1

         *  @param aDriveNumber: the drive to be checked.

         *	@return ETrue if accessable else EFalse.

         */

        TBool GetDriveStatusL( const TDriveNumber aDriveNumber );

#endif

        // Get the value of iStopUpdateCba

        TBool GetStopUpdateCba();

        // Get the value of iIsFSWExit

        TBool  GetIsFSWExitFlag();

        // Set the value of iIsFSWExit

        void SetFSWExitFlag( TBool aValue );

    private: // From MWVSettingsCASettings

        /**

        * @see MWVSettingsCASettings

        */

        TInt LaunchSettingsL ( CIMPSSAPSettings& aServer );

    private: // From MWVSettingsObserver

        /**

         * @see MWVSettingsObserver

         */

        void ServerChangedL ( const TDesC& aNewServerName,

                              TBool aDefaultServerChanged  = EFalse );

        /**

         * @see MWVSettingsUICaller

         */

        HBufC* CurrentServerNameLC();

    public: // From MCAAppUi

        /**

         * @see MCAAppUi

         */

        TDes& MbmFullPath();

        /**

         * @see MCAAppUi

         */

        void AddLayoutChangeObserver( MCALayoutChangeObserver* aObserver );

        /**

         * @see MCAAppUi

         */

        void RemoveLayoutChangeObserver( MCALayoutChangeObserver* aObserver );

        /**

         * @see MCAAppUi

         */

        void AddResourceChangeObserver( MCAResourceChangeObserver* aObserver );

        /**

         * @see MCAAppUi

         */

        void RemoveResourceChangeObserver( MCAResourceChangeObserver* aObserver );

    private: // From MProgressDialogCallback

        /**

         * From MProgressDialogCallback Get's called when a dialog is dismissed

         * @param aButtonId Button that was used to dismiss the dialog

         */

        void DialogDismissedL( TInt aButtonId );

    private:

        //popup pane related functionss.

        void AddToPreviewListL( const TDesC& aContactId, const TDesC& aMsg );

        void CalculatePreviewPaneWidth();

        TInt SelectWindowVariety( const TInt aNumberOfLines,

                                  const TAknLayoutScalableParameterLimits& aLimits ) const;

        TRect RectFromLayout( const TRect& aParent,

                              const TAknWindowComponentLayout& aComponentLayout ) const;

    public: // Functions from base classes

        /**

         * From CEikAppUi, takes care of command handling.

         * @param aCommand command to be handled

         */

        void HandleCommandL( TInt aCommand );

        /**