/*

* Copyright (c) 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 editor class declaration

 *

*/

#ifndef CALENUNFIEDEDITOR_H

#define CALENUNFIEDEDITOR_H

// system includes

#include <AknForm.h>

#include <MAgnEntryUi.h>

#include <calcommon.h>

#include <calentry.h>

#include <fepbase.h>

#include <calennotificationhandler.h>

// user includes

#include "calenentryutil.h"

#include "CalenEditorDataHandler.h"

#include "calenunifiededitorcontrol.h"

// forward declaration

class MCalenServices;

class CAknNavigationControlContainer;

class CCalenEditorDataHandler;

class CCalenEntryUpdater;

class CCalenEntryUtil;

class CCalenGlobalData;

class CEnvironmentChangeNotifier;

class CPosLandmark;

/**

 * Class declaration for Unified Editor

 */ 

NONSHARABLE_CLASS( CCalenUnifiedEditor ) : public CAknForm,

                                           public MAgnEntryUi, 

                                           public MCalenNotificationHandler,

                                           public MCoeFepObserver

    {

    public: // Constructors

        /**

         * @brief Two-phased constructor. This overload should be used when 

         *        it is known which repeat type will be used to edit the entry.

         *        Use this overload in conjunction with viewer.

         * @param aEntry: Reference entry

         */    

        static CCalenUnifiedEditor* NewL ( CCalEntry& aEntry,

                                           const TAgnEntryUiInParams& aParams,

                                           MAgnEntryUiCallback& aCallback,

                                           TAgnEntryUiOutParams& aOutParams,

                                           CalCommon::TRecurrenceRange aRepeatType);

        /**

         * @brief Two-phased constructor. This overload should be used when

         *        the user should be prompted to select the repeat type when

         *        the entry is modified. Use this overload when the viewer is

         *        not present.

         * @param aEntry: Reference entry

         */

        static CCalenUnifiedEditor* NewL( CCalEntry& aEntry,

                                          const TAgnEntryUiInParams& aParams,

                                          MAgnEntryUiCallback& aCallback,

                                          TAgnEntryUiOutParams& aOutParams );  

        /**

         * @brief Destructor

         */

        virtual ~CCalenUnifiedEditor();

    private:

        /**

         * @brief Default constructor with repeat type

         */

        CCalenUnifiedEditor( CCalEntry& aEntry,

                             const TAgnEntryUiInParams& aParams,

                             MAgnEntryUiCallback& aCallback,

                             TAgnEntryUiOutParams& aOutParams,

                             CalCommon::TRecurrenceRange aRepeatType );

        /**

         * @brief Default constructor

         */

        CCalenUnifiedEditor( CCalEntry& aEntry,

                             const TAgnEntryUiInParams& aParams,

                             MAgnEntryUiCallback& aCallback,

                             TAgnEntryUiOutParams& aOutParams );

    private:

        /**

         * @brief Second phase constructor

         */

        void ConstructL();

    private:

        /**

         * @brief For handling external database changes keeping

         *        editor active eg..synchronizing

         */

        enum TEntryExistenceStatus

            {

            EEntryOk,

            EEntryModifiedByAnotherProcess,

            EEntryDeletedByAnotherProcess

            };

    public:

        /**

         * @brief from MCalenNotificationhandler

         *        Handles calendar notifications

         */

        void HandleNotification( TCalenNotification aNotification );

        /**

         * @brief From MCoeFepObserver 

         * 

         */

        void HandleCompletionOfTransactionL();

    public:      

        /**

        * @brief Executes proper UI view based on given parameters.

        * @param aEntries all having the same GUID, ownership not transferred

        * @param aInParams input parameters

        * @param aOutParams contains output when method returns

        * @param aCallback observer

        * @return KErrNone or a system wide error code

        */

       TInt ExecuteViewL( RPointerArray<CCalEntry>& aEntries,

                          const TAgnEntryUiInParams& aInParams,

                          TAgnEntryUiOutParams& aOutParams,                                   

                          MAgnEntryUiCallback& aCallback );

        /**

        * @brief Method for setting help context for the UI.

        *        Must be called before executing UI.

        * @param aContext help context

        */

        void SetHelpContext(const TCoeHelpContext& aContext);

        /**

         * @brief From CEikDialog.

         *        Handles exiting of the unified editor

         */

         TBool OkToExitL( TInt aButtonId );

        /**

         * @brief From CCoeControl.

         *        Handles key events

         */

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

        /**

         * @brief From CEikDialog

         *        Initializes the dialog's controls before the dialog is sized and 

         *        layed out. Empty by default.

         */

        void PreLayoutDynInitL();

        /**

         * @brief From CEikDialog

         *        Initializes the dialog's controls after the dialog has been sized 

         *        but before it has been activated. Empty by default.

         */        

        void PostLayoutDynInitL();

        /**

         * @brief From CEikDialog

         *        Handles a state change in the control with id aControlId. 

         *        Empty by default.

         * @param aControlId holds the control id for which the state is changed

         */

        void HandleControlStateChangeL( TInt aControlId );

        /**

         * @brief From CEikDialog

         *        Tries to change focus to the specified line. Fails if the line ID 

         *        is not valid. Calls @c PrepareForFocusTransitionL() before focus 

         *        is given to the line.

         */

        void PrepareForFocusTransitionL();

        /**

         * @brief From CEikDialog

         *        Handles editor menu commands

         * @param aCommandId The ID of the commannd to be handled

         */

        void ProcessCommandL( TInt aCommandId );

//Single click integration

        /**

         * From CAknForm.

         * Takes any action required when the dialog page event happens.

         * 

         * @param aEventId Event id. 

         */

        void HandleDialogPageEventL( TInt aEventID );

        /**

         * @brief From CAknForm

         * Handles the resource change like layout change/theme change

         * @param aType Holds the type of the resource change

         */

        void HandleResourceChange( TInt aType );

        /**

         * @brief From MEikMenuObserver

         * Delete and add items to menu dynamically

         * @param aResourceId: Resource ID of menu pane

         * @param aMenuPane  : Menu Pane object

         */

        void DynInitMenuPaneL( TInt aResourceId, CEikMenuPane* aMenuPane );

        /** 

         * @brief From CEikDialog.

         *        This is needed to create custom form control

         * @param aControlType       

         */

        SEikControlInfo CreateCustomControlL( TInt aControlType );

        /**

         * @brief To get custom control layout correctly in Avkon form

         * @param aControlType 

         */

        MEikDialogPageObserver::TFormControlTypes ConvertCustomControlTypeToBaseControlType( 

             TInt aControlType ) const;

        /**

         * @brief To check for repeattype

         * @return aRepeatType

         */

        CCalenEditorDataHandler::TError AskRepeatingNoteQueriesL(

            CalCommon::TRecurrenceRange& aRepeatType );

        /**

         * @brief Check Start date change query should shown.

         * @return ETrue if query need to be displayed else EFalse

         */

        TBool ShouldQueryForStartDateChange();

        /**

         * @brief Display Start date change query

         * @return CCalenEditorDataHandler::TError

         */

        CCalenEditorDataHandler::TError QueryStartDateChangeL();

        /*

         * Sets the control as ready to be drawn.

         * @return void

         */

        void  ActivateL();

    private:

        /**

         * @brief Insert Send menu item if needed.

         * @param : Menu pane where send menu is inserted

         */

        void TryInsertSendMenuL( TInt aResourceId, CEikMenuPane* aMenuPane );

        /**

         * @brief Handles "Cancel" menu command for discarding the user changes.

         */

        void OnCmdCancelL();

        /**

         * @brief Handles "Delete" command for deleting the notr

         */

        void OnCmdDeleteNoteL();

        /**

         * @brief Handles send command

         * @param aCommandId Holds ECalenSend command

         */

        void OnCmdSendL( TInt aCommandId );

        /**

         * @brief Handles "Help" command.

         */

        void OnCmdHelpL();

        /**

         * @brief Handles "Exit" command.

         * @param aCmd Holds the command issued.

         */

        void OnCmdExitL(TInt aCmd);

        /**

         * @brief Delete note from Calendar.

         * @param aIsViaDeleteMenu : ETrue if via "Delete" menu.

         * @return ETrue if note is deleted.

         */

        void TryToDeleteNoteL( TBool aIsViaDeleteMenu );

        /**

         * @brief Close form without further actions. Needed when note is deleted.

         */

        void CloseFormWithoutActionsL();

        /**

         * @brief Handles saving of the entry when RSK "Done" is pressed

         * @return TBool returns whenther the entry is saved 

         */

        TBool HandleDoneL();

        /**

         * @brief Check for entry existence

         * @retur TEntryExistenceStatus returns the entry is modified by 

         *        external database change

         */

        TEntryExistenceStatus EntryStillExistsL();

        /** 

         * @brief Key callback function for deferred key event (for FEP).

         * @param a pointer of CCalenUnifiedEditor.

         * @return always EFalse.

         */

        static TInt KeyCallBack( TAny *aSelf );

        /**

         * @brief This function is called when a locale(or today) is changed.

         * @param aThisPtr Specified to be TCallBack()

         * @return EFalse

         */

        static TInt LocaleCallback( TAny* aThisPtr );

        /**

         * @brief Handles locale change notifications

         * @param aChange Holds the environment change information

         * @return TInt returns 0

         */

        TInt HandleLocaleChange( TInt aChange );

        /**

         * @brief Handles locale change notifications

         * @param aChange Holds the environment change information

         */

        void DoHandleLocaleChangeL( TInt aChange );

    public:

        /**

         * @brief Inserts dialog line (form field) defined by aResourceId 

         *        and aControlId after existing dialog line aPrevControlId.

         * @resourceId dialog line resource

         * @aControlId ControlId of the dialog line to be inserted

         * @aPrevControlId Previous control id

         */ 

        void InsertFieldL( TInt aResourceId, TInt aControlId,

                            TInt aPrevControlId );

        /** 

         * @brief Check for field exists in unified editor

         * @aField focused controlid

         * @TBool returns ETrue if control exists otherwise EFalse

         */

        TBool HasField( TInt aField );

        /**

         * @brief Update form. You can force update of form with this,

         *        if you modify some of the field values dynamically.

         */

         void UpdateFormL();

        /**

         * @brief Copy of a given entry

         * @param aOther holds the source entry

         * @return CCalEntry returns target entry

         */

         static CCalEntry* CreateCopyL( CCalEntry& aOther );

        /**

         * @brief Access to the unified editor's fields

         * @return CCalenUnifiedEditorControl returns unified editor's fields

         */

        CCalenUnifiedEditorControl& EditorFields();

        /**

         * @brief Returns layout variant dependent maximum value for text editors.

         * @return TInt returns maximum editor length

         */

        TInt MaxTextEditorLength() const;

        /**

         * @brief Check if note editor is launched to create new entry

         * @return TBool returns ETrue if creating a new entry

         */

        TBool IsCreatingNewEntry() const;

        /**

         * @brief Gets unified editor's entry type

         * @return CCalEntry entry type of the unified editor

         */

        CCalEntry::TType GetEntryType();

        /**

         * @brief Sets the unified editor's entry type

         * @param aEntryType Holds the new entry type

         */

        void SetEntryType( CCalEntry::TType aEntryType );

        /**

         * @brief Access to the editor data handler

         * @returns CCalenEditorDataHandler editor data handler

         */

        CCalenEditorDataHandler& EditorDataHandler();

        /**

         * @brief Access to the edited editor data

         * @returns edited editor data

         */

        CCalenEntryUtil& Edited();

        /**

         * @brief Access to the original editor data

         * @returns CCalenEntryUtil returnd original editor data 

         */ 

        const CCalenEntryUtil& Original() const;

        /**

         * @brief Sets editor text

         * @param aCOntrolId Id of the editor text

         * @param aDes Text to be set to editor

         */

        void SetEditorTextL( TInt aControlId, const TDesC* aDes );

        /**

         * @brief Reads subject field from unified editor

         */

        void ReadSubjectFromEditorL();

        /**

         * @brief Reads "Place" item from unified editor

         */

        void ReadPlaceFromEditorL();

        /**

         * @brief For setting alarm field on or off

         * @param aOnOff For toggling on or off

         */

        void SetAlarmFieldOnOffL( TBool aOnOff );

        /**

         * @brief For setting AllDay filed Yes or No

         */

        void SetAllDayFieldL( TBool aYesNo );

        /**

         * @brief For getting Id of the focused control

         * @return TInt controlId of the focused control

         */

        TInt IdOfFocusedControl();

        /**

         * @brief Set attachment names to the editor if attachments

         *        exists for the entry being edited

         */

        void SetAttachmentNamesToEditorL();

        /**

         * Update CBA with corresponding MSK button.

         * This function is e.g. called from HandleControlEvent()

         * Will issue HandleControlStateChangeL() call.

         */

        void SetMskFromResourceL();

         /**

         * @brief Merges all the attachment names into a single string

         */

        void GetAttachmentNamesString( RPointerArray<HBufC>& aAttachmentNames,

                                        HBufC& aAttachmentNamesString );

        /*

         * Verify if the collectionid exsists in the array of collecteids

         * leave is generated if collectionid is not found.

         * @param TCalCollectionId aColId to verified from the array of collecteids

         * @return void

         */

        void VerifyCollectionIdL(const TCalCollectionId aColId);

        /*

         * Return attachment names

         * @param aAttachmentNames names of the attachments.

         * @return HBufC 

         */

        void GetAttachmentNamesL(RPointerArray<HBufC>& aAttachmentNames);

    protected:

        /**

         * From CEikDialog

         * We will hit this event each time a line has changed in the form

         */

        void LineChangedL( TInt aControlId );

    private:        

        /**

         * @breif Checks if the Flash File System storage will fall below

         *        Critical Level. Warning will be displayed if storage

         *        is below Critical Level.

         * @return ETrue : Below critical level

         */

        TBool CheckSpaceBelowCriticalLevelL();

        /**

         * @brief Try to save note. Used in normal exit.

         * @return ETrue if note was saved

         */

        TBool TryToSaveNoteL();