/*

* Copyright (c) 2006-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:   Unified SMS and MMS Editor Application UI class definition.      

*

*/

#ifndef _UNIEDITORAPPUI_H

#define _UNIEDITORAPPUI_H

//  INCLUDES

#include <gmxmlparser.h>                // for MMDXMLParserObserver & CMDXMLParser

#include <MsgEditorAppUi.h>             // for CMsgEditorAppUi

#include <MsgEditorView.h>

#include <MsgAddressControl.h>

#include <MsgBodyControl.h>             // for CMsgBodyControl

#include <MsgEditor.hrh>

#include <msgimagecontrol.h>            // for CMsgImageControl (needed in .inl)

#include <msgasynccontrolobserver.h>

#include <MsgRecipientItem.h>           // for CMsgRecipientArray

#include <MsgAttachmentUtils.h>

#include <MMGFetchVerifier.h>

#include <akntoolbarobserver.h>

#include <AknServerApp.h>               // for MAknServerAppExitObserver

#include <AknProgressDialog.h>          // for MProgressDialogCallback

#include <peninputclient.h>

#include <peninputsrveventhandler.h>

#include <cenrepnotifyhandler.h>    // MCenRepNotifyHandlerCallback

#include <eikedwob.h>                   // for MEikEdwinObserver

// Needed by inline functions

#include "uniobjectlist.h"

#include "unidatamodel.h"

#include "UniSendingSettings.h"

#include "UniEditorHeader.h"            // THeadersFields,  

#include "UniEditorApp.hrh"             // TUniEditorPanicIds

#include "UniEditorOperation.h"         // MUniEditorOperatorObserver

// CONSTANTS

// FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

class TFilename;

class TChar;

class CAknTitlePane;

class CAknNavigationDecorator;

class CAknNavigationControlContainer;

class CAknWaitDialog;

class CUniEditorDocument;

class CAknLocalScreenClearer;

class CRepository;

class CSelectionItemList;

class CEikImage; // for context icon

class CAknInfoPopupNoteController;

class CDocumentHandler;

class CAknIconArray;

class CAknInputBlock;

class CMDXMLDocument;

class CAknToolbar;

class CMsgMediaInfo;

class CMsgImageControl;

class TMsgControlsIds;

class CUniClientMtm;

class CUniSmilModel;

class CUniSlideLoader;

class CUniEditorLaunchOperation;

class CUniEditorSaveOperation;

class CUniEditorSendOperation;

class CUniEditorChangeSlideOperation;

class CUniEditorInsertOperation;

class CUniEditorVCardOperation;

class CUniEditorHeader;

class CAknToolbarExtension;

// CLASS DECLARATION

/**

* CUniEditorAppUi

*

* @since 3.2

*/

class CUniEditorAppUi : 

    public CMsgEditorAppUi,

    public MMGFetchVerifier,

    public MMsgAsyncControlObserver,

    public MUniEditorOperationObserver,

    public MAknToolbarObserver,

    public MMDXMLParserObserver,

    public MAknServerAppExitObserver,

    public MEikEdwinObserver,

    public MProgressDialogCallback,

    public MPenUiActivationHandler,

    public MCenRepNotifyHandlerCallback

    {

    public:  // Constructors and destructor

        /**

        * C++ default constructor.

        */

        CUniEditorAppUi();

        /**

        * Destructor.

        */

        virtual ~CUniEditorAppUi();

        /**

        * Removes object from screen.  (Objectsview callback method)

        * @param aRegion, region to remove the object from

        * @param aLayout, layout before removed from model

        */

        void RemoveObjectL( TUniRegion aRegion, TUniLayout aLayout );

        /**

        * Changes object order on screen. (Objectsview callback method)

        * @param aLayout, new layout

        */

        void ChangeOrderL( TUniLayout aLayout );

        /**

        * If there is image control, sets image release/lock

        * according to parameter. Otherwise does nothing.

        * @param aRelease, ETrue = release/unlock, EFalse = lock

        */

        void ReleaseImage( TBool aRelease );

        /**

        * Saves, if needed and exits

        */        

        void ExitAndSaveL();

        /**

        * Wrapper on the FetchFileL function of Base Editor.

        * Called by "Insert" functions.

        *

        * @param aFetchType, EImage or ENewImage or

        *                    EAudio or ENewAudio or

        *                    EVideo or ENewVideo

        */

        TBool FetchFileL( MsgAttachmentUtils::TMsgAttachmentFetchType aFetchType );

        /**

        * Sets focus to first focusable control on body.

        */

        void SetFocusToBodyBeginningL();

        /**

        * Callback for CPeriodic

        */        

        static TInt DelayedExitL( TAny* aThis );

        /**

        * Callback for MProgressDialogCallback

        */        

        void DialogDismissedL( TInt /*dismissed*/ );

        /**

        * Exit Unieditor without save during critimal memory condition

        */   

        void ExitWithoutSave();

    public: // Functions from base classes

        /**

        * From MMsgEditorObserver. Calls DoEditorObserverL()

        *

        * For passing events from Base Editor to MMS Editor

        */

        void EditorObserver( TMsgEditorObserverFunc aFunc,

                             TAny* aArg1,

                             TAny* aArg2,

                             TAny* aArg3 );

        /**

        * Handles the editor observer event.

        */

        void DoEditorObserverL( TMsgEditorObserverFunc aFunc,

                                TAny* aArg1,

                                TAny* aArg2,

                                TAny* aArg3 );

        /**

        * From MMGFetchVerifier

        */

        TBool VerifySelectionL( const MDesCArray* aSelectedFiles );

        /**

         * From MAknToolbarObserver

         */

        void DynInitToolbarL( TInt aResourceId, CAknToolbar* aToolbar );

        /**

         * From MAknToolbarObserver

         */

        void OfferToolbarEventL( TInt aCommand );

        /**

         * From MApaServerAppExitObserver

         */

        void HandleServerAppExit( TInt aReason );

        /**

        * From MEikEdwinObserver

        */

        void HandleEdwinEventL( CEikEdwin* aEdwin, TEdwinEvent aEventType );

        /**

         * From CMsgEditorAppUi

         */

        void HandleEntryMovedL( TMsvId aOldParent, TMsvId aNewParent );

        /*

        * From MPenUiActivationHandler

        */

        void OnPeninputUiDeactivated();

        /*

        * From MPenUiActivationHandler

        */

        void OnPeninputUiActivated();       

    private: // Functions from base classes

        /**

        * From MMsgEditorLauncher

        */

        void LaunchViewL();

        /**

        * From CCoeAppUi 

        */

        TKeyResponse HandleKeyEventL( const TKeyEvent& aKeyEvent, TEventCode aType );

        /**

        * From CEikAppUi 

        */

        void HandleCommandL( TInt aCommand );

        /**

        * Performs the command.

        */

        void DoHandleCommandL( TInt aCommand );

        /**

         * Performs the command.

         */

        void DoOfferToolbarEventL( TInt aCommand );

        /**

        * From CAknAppUi.

        *

        * Handles navipane updating when launched from idle and

        * when returning from preview.

        *

        * @param aForeground, ETrue if app is foreground.

        */

        void HandleForegroundEventL(TBool aForeground);

        /**

        * From MEikMenuObserver 

        */

        void DynInitMenuPaneL( TInt aMenuId, CEikMenuPane* aMenuPane );

        /**

        * Helper function to be called in normal unimode and upload mode.

        * Handles the menu options based on the focused media object

        */

        void DynInitFocusedMediaBasedOptionsL( CEikMenuPane* aMenuPane );

        /**

        * From MUniEditorOperationObserver. Called when operation 

        * state is changed.

        */

        void EditorOperationEvent( TUniEditorOperationType aOperation,

                                   TUniEditorOperationEvent aEvent );

        /**

        * Performs the real operation event handling

        */

        void DoEditorOperationEventL( TUniEditorOperationType aOperation,

                                      TUniEditorOperationEvent aEvent );

        /**

        * From MUniEditorOperationObserver. Query is wanted to be shown 

        * to the user.

        */

        TBool EditorOperationQuery( TUniEditorOperationType aOperation,

                                    TUniEditorOperationQuery aEvent );        

        /**

        * Shows the query to the user.

        */

        TBool DoEditorOperationQueryL( TUniEditorOperationType aOperation,

                                       TUniEditorOperationQuery aEvent );        

        /**

        * Performs the change slide operation event handling.

        */

        void DoChangeSlideCompleteL();

        /**

        * Performs the insert operation event handling.

        */

        void DoInsertCompleteL( TUniEditorOperationEvent aEvent );

        /**

        * Performs the 2nd phase of insert operation event handling.

        */

        void DoInsertComplete2ndPhaseL();

        /**

        * Performs launch operation event handling.

        */

        void DoLaunchCompleteL();

        /**

        * Performs save operation event handling.

        */

        void DoSaveCompleteL();

        /**

        * Performs the 2nd phase of saving operation event handling.

        */

        void DoSavingComplete2ndPhase();

        /**

        * Performs send operation event handling.

        */

        void DoSendCompleteL();

        /**

        * Performs 2nd phase of send operation event handling.

        */

        void DoSendComplete2ndPhase();

        /**

        * Performs vCard insert operation event handling.

        */

        void DoVCardCompleteL();

        /**

        * Shows insert errors

        */

        void ShowInsertErrorsL();

        /**

        * From MMsgAsyncControlObserver. Called when asynchronous control

        * state is changed

        */

        void MsgAsyncControlStateChanged( CMsgBaseControl& aControl,

                                          TMsgAsyncControlState aNewState,

                                          TMsgAsyncControlState aOldState );

        /**

        * From MMsgAsyncControlObserver. Called when asynchronous control

        * receives resource change event.

        */

        void MsgAsyncControlResourceChanged( CMsgBaseControl& aControl, TInt aType );

        /**

        * 2nd phase constructor.

        */

        void ConstructL(); 

    private:

        enum TUniEditorInsertTextType

            {

            ETemplateText,

            EMemoText

            };

        enum TUniEditorInsertOtherType

            {

            ETextFile,

            EOtherFile

            };

    private: // New functions

        /**

        * Update the msglength information in navipane.

        * Reads the current size from document.

        *

        * @param aForceDraw, forces drawing of size label. 

        */

        void MsgLengthToNavipaneL( TBool aForceDraw = EFalse );    

        /**

        * Calculates the SMS Messages Characters left in the current segment and Total No. of segments in the message

        * Total No. of segments in the message

        *

        * @Return value

        * charsLeft: Characters left in the current segment

        * msgsParts: Total No of segments 

        */

        void CalculateSMSMsgLen(TInt& charsLeft, TInt& msgsParts);

        /**

        * Check if message has any data i.e. either in header ("To"),

        * in message body or as attachments.

        *

        * @return ETrue, message empty,

        *         EFalse, message not empty

        */        

        TBool IsMessageEmpty() const;

        /**

        * Draw the "not viewable" icons

        * (editable 3GPP SMIL or non-editable SMIL).

        *

        * @param aEditable, ETrue should be set if SMIL is Template SMIL

        */

        void InsertPresentationL( TBool aEditable );

        /**

        * Updates the address size to CUniEditorDocument

        */

        void SetAddressSize();

        /**

        * Updates the subject size to CUniEditorDocument

        */

        void SetSubjectSize();

        /**

        * Checks message content and if ok send message

        */        

        void DoUserSendL();

        /**

        * Handles message saving after exit 

        */        

        void DoMsgSaveExitL();

        /**

        * Handles delayed (external) exit 

        * @param aDelayTime in microsecods

        */        

        void DoDelayedExit( TInt aDelayTime );

        /**

        * Handles message saving after user has pressed close.

        */        

        void DoBackSaveL();

        /**

        * Does actual saving of message to DRAFT folder.

        *

        * @param aSaveType, Controls how the saving is done

        *                   e.g. keep entry hidden etc.

        */        

        void DoSaveL( TUniSaveType aSaveType ); 

        /**

        * Verifies addresses in address control.

        *

        * @return ETrue, if verify successful,

        *         EFalse otherwise

        */        

        TBool VerifyAddressesL( TBool& aModified );

        /**

        * Handles user move and select page commands. 

        */        

        void DoUserMoveOrSelectPageL( TBool aMovePage );

        /**

        * Handles user objects view command. 

        */        

        void DoUserObjectsViewL( TBool aFocusAttachments );

        /**

        * Handles user add recipient command. 

        */        

        void DoUserAddRecipientL();

        /**

        * Handles user message info command. 

        */        

        void DoUserMessageInfoL();

        /**

        * Handles user sending settings command. 

        */        

        void DoUserSendingOptionsL();

        /**

        * Handles user insert media command. 

        */        

        void DoUserInsertMediaL();

        /**

        * Handles user insert image command. Creates attachment

        * and draws image to display. 

        *

        * @param aFetchType, ENewImage or EImage 

        */        

        void DoUserInsertImageL( MsgAttachmentUtils::TMsgAttachmentFetchType aFetchType );

        /**

        * Handles user insert video command. Creates attachment

        * and draws image to display. 

        *

        * @param aFetchType, ENewVideo or EVideo

        */        

        void DoUserInsertVideoL( MsgAttachmentUtils::TMsgAttachmentFetchType aFetchType );