/*

* 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: 

*           Methods for Phonebook Contact editor dialog.

*

*/

// INCLUDE FILES

#include "CPbkContactEditorDlg.h"

#include <eikspane.h>

#include <avkon.hrh>

#include <akntitle.h>

#include <aknnavi.h>

#include <eikmenub.h>

#include <featmgr.h>

#include <StringLoader.h>

#include <AknQueryDialog.h>

#include <aknnotewrappers.h>

#include <AknsUtils.h>

#include <eikcapc.h>

#include <hlplch.h>   

#include "CPbkThumbnailCmd.h"

#include "CPbkContextPaneIcon.h"

#include "CPbkContactEditorFieldArray.h"

#include "MPbkContactEditorUiBuilder.h"

#include <MPbkContactEditorField.h>

#include <MPbkContactEditorControl.h>

#include "PbkContactEditorStrategyFactory.h"

#include "MPbkContactEditorStrategy.h"

#include "TPbkAddItemManager.h"

#include "CPbkThumbnailPopup.h"

#include <PbkView.hrh>

#include "PbkUID.h"

#include "MPbkFieldEditorVisitor.h"

#include "MPbkFieldEditorControl.h"

#include "MPbkEditorOkToExitCallback.h"

#include <CPbkContactEngine.h>

#include <CPbkContactItem.h>

#include <CPbkFieldsInfo.h>

#include <CPbkConstants.h>

#include <CPbkFieldData.h>

#include <MPbkContactEditorExtension.h>

#include <MPbkExtensionFactory.h>

#include <CPbkExtGlobals.h>

#include <PbkDebug.h>

/// Unnamed namespace for local definitions

namespace {

// LOCAL CONSTANTS AND MACROS

/// Escape key press event

static const TKeyEvent KEscKeyEvent = { EKeyEscape, 0, 0, 0 };

#ifdef _DEBUG

/// Panic codes for CPbkContactEditorDlg

enum TPanicCode

    {

    EPanicPostCond_Constructor,

    EPanicPreCond_ResetWhenDestroyed,

    EPanicPreCond_CmdFetchThumbnailL,

    EPanicPreCond_CmdRemoveThumbnailL,

    EPanicPreCond_PreLayoutDynInitL,

    EPanicPostCond_PreLayoutDynInitL,

    EPanicPreCond_SetInitialCurrentLine,

    EPanicPreCond_ContactAlreadyExistsL

    };

void Panic(TPanicCode aReason)

    {

    _LIT(KPanicText, "CPbkContactEditorDlg");

    User::Panic(KPanicText, aReason);

    }

#endif  // _DEBUG

void UpdateCbasL( MPbkContactEditorField* aCurrentField,

                  CEikButtonGroupContainer& aCba )

    {

    if ( aCurrentField )

        {

        TPbkFieldEditMode editMode =

            aCurrentField->ContactItemField().FieldInfo().EditMode();

        if ( editMode ==  EPbkFieldEditModeSelector )

            {

            if ( !aCba.IsCommandInGroup(EAknSoftkeyChange) )

                {

                aCba.SetCommandSetL( R_PBK_SOFTKEYS_OPTIONS_DONE_CHANGE );    

                aCba.DrawDeferred();

                } 

            }

        else

            {

            if ( !aCba.IsCommandInGroup(EAknSoftkeyContextOptions) )

                {

                aCba.SetCommandSetL( R_PBK_SOFTKEYS_OPTIONS_DONE_CONTEXT );    

                aCba.DrawDeferred();                

                }

            }

        }

    }

}  // namespace

// ================= MEMBER FUNCTIONS =======================

/**

 * Extension implementation.

 */

NONSHARABLE_CLASS(CPbkContactEditorDlg::CExtension) :

        public CBase,

        public MPbkContactEditorControl

    {

    public: // Constructor and destructor

        /**

         * Creates a new CExtension.

         * @param aContact currently edited contact

         */

        static CExtension* NewL

            (CPbkContactItem& aContact,

            const CPbkContactEditorDlg& aParent);

        /**

         * Destructor

         */

        ~CExtension();

    public: // From MPbkContactEditorExtension API

        void DynInitMenuPaneL(TInt aResourceId, CEikMenuPane* aMenuPane);

        TBool ProcessCommandL(TInt aCommandId);

        void PreOkToExitL(TInt aButtonId);

        void PostOkToExitL(TInt aButtonId);

        void SetStateModified();

    public: // From MPbkContactEditorControl

        MPbkContactEditorField* FocusedField();

        TInt EditorCount();

        const MPbkContactEditorField& FieldAt(TInt aFieldIndex);

    private: // Implementation

        CExtension(const CPbkContactEditorDlg& aParent);

        void ConstructL(CPbkContactItem& aContact);

    private: // Data

        /// Ref: for creating editor extension

        CPbkExtGlobals* iExtGlobal;

        /// Ref: editor extension

        MPbkContactEditorExtension* iEditorExtension;

        /// Ref: parent editor

        const CPbkContactEditorDlg& iParent;

    };

CPbkContactEditorDlg::CExtension::CExtension

        (const CPbkContactEditorDlg& aParent) :

        iParent(aParent)

    {

    }

void CPbkContactEditorDlg::CExtension::ConstructL

        (CPbkContactItem& aContact)

    {

    iExtGlobal = CPbkExtGlobals::InstanceL();

    iEditorExtension = iExtGlobal->FactoryL().

        CreatePbkContactEditorExtensionL(aContact, iParent.iEngine, *this);

    }

CPbkContactEditorDlg::CExtension* CPbkContactEditorDlg::CExtension::NewL

        (CPbkContactItem& aContact,

        const CPbkContactEditorDlg& aParent)

    {

    CExtension* self = new (ELeave) CExtension(aParent);

    CleanupStack::PushL(self);

    self->ConstructL(aContact);

    CleanupStack::Pop(self);

    return self;

    }

CPbkContactEditorDlg::CExtension::~CExtension()

    {

    Release(iEditorExtension);

    Release(iExtGlobal);

    }

void CPbkContactEditorDlg::CExtension::DynInitMenuPaneL

        (TInt aResourceId, CEikMenuPane* aMenuPane)

    {

    iEditorExtension->DynInitMenuPaneL(aResourceId, aMenuPane);

    }

TBool CPbkContactEditorDlg::CExtension::ProcessCommandL(TInt aCommandId)

    {

    return iEditorExtension->ProcessCommandL(aCommandId);

    }

void CPbkContactEditorDlg::CExtension::PreOkToExitL(TInt aButtonId)

    {

    iEditorExtension->PreOkToExitL(aButtonId);

    }

void CPbkContactEditorDlg::CExtension::PostOkToExitL(TInt aButtonId)

    {

    iEditorExtension->PostOkToExitL(aButtonId);

    }

void CPbkContactEditorDlg::CExtension::SetStateModified()

    {

    iParent.iEditorStrategy->SetStateModified();

    }

MPbkContactEditorField* CPbkContactEditorDlg::CExtension::FocusedField()

    {

    const TInt id = iParent.IdOfFocusControl();

    return iParent.iFieldManager->Find(id);

    }

TInt CPbkContactEditorDlg::CExtension::EditorCount()

    {

    return iParent.iFieldManager->EditorCount();

    }

const MPbkContactEditorField& CPbkContactEditorDlg::CExtension::

        FieldAt(TInt aFieldIndex)

    {

    return iParent.iFieldManager->FieldAt(aFieldIndex);

    }

/**

 * Editor implementation class.

 */

NONSHARABLE_CLASS(CPbkContactEditorDlgImpl) :

        public CPbkContactEditorDlg,

        private MPbkContactEditorUiBuilder

    {

    public: // constructor

        /**

         * Creates a new instance of this class.

         * @param aEngine phonebook engine

         * @param aContactItem contact item

         * @param aIsNewContact defines is this new contact or not

         * @param aFocusIndex field to focus

         * @param AEdited edited flag

         */

        static CPbkContactEditorDlgImpl* NewL(

            CPbkContactEngine& aEngine,

            CPbkContactItem& aContactItem,

            TBool aIsNewContact,

            TInt aFocusIndex = -1,

            TBool aEdited = EFalse);

        /**

         * Destructor.

         */

        ~CPbkContactEditorDlgImpl();

    private: // from MPbkContactEditorUiBuilder

        CCoeControl* CreateLineL(const TDesC& aCaption, TInt aControlId,

                TInt aControlType);

        CEikCaptionedControl* LineControl(TInt aControlId) const;

        void DeleteControl(TInt aControlId);

        void TryChangeFocusL(TInt aControlId);

        void SetCurrentLineCaptionL(const TDesC& aText);

        CCoeControl* Control(TInt aControlId) const;

        void SetEditableL(TBool aState);

    private: // from CAknForm

        void HandleResourceChange(TInt aType);

    private: // from CCoeControl

        void FocusChanged(TDrawNow aDrawNow);

    private: // implementation

        CPbkContactEditorDlgImpl

            (CPbkContactEngine& aEngine,

            CPbkContactItem& aContactItem,

            TInt aFocusIndex = -1);

    private:

        class CPbkIconReloaderVisitor;

        CPbkIconReloaderVisitor* iIconReloaderVisitor;

    };

/**

 * Editor icon reloader visitor.

 */

NONSHARABLE_CLASS(CPbkContactEditorDlgImpl::CPbkIconReloaderVisitor) :

        public CBase,

        public MPbkFieldEditorVisitor

    {

    public:

        CPbkIconReloaderVisitor(MPbkContactEditorUiBuilder& aUiBuilder);

        ~CPbkIconReloaderVisitor();

    private: // From MPbkFieldEditorVisitor

        void VisitL(MPbkFieldEditorControl& aThis);

    private: // Data

        MPbkContactEditorUiBuilder& iUiBuilder;

    };

CPbkContactEditorDlgImpl::CPbkIconReloaderVisitor::CPbkIconReloaderVisitor

        (MPbkContactEditorUiBuilder& aUiBuilder) :

    iUiBuilder(aUiBuilder)

    {

    }

CPbkContactEditorDlgImpl::CPbkIconReloaderVisitor::~CPbkIconReloaderVisitor()

    {

    }

void CPbkContactEditorDlgImpl::CPbkIconReloaderVisitor::VisitL

        (MPbkFieldEditorControl& aThis)

    {

    aThis.LoadBitmapToFieldL(iUiBuilder);

    }

inline CPbkContactEditorDlgImpl::CPbkContactEditorDlgImpl(

        CPbkContactEngine& aEngine,

        CPbkContactItem& aContactItem,

        TInt aFocusIndex) :

    CPbkContactEditorDlg(aEngine, aContactItem, aFocusIndex)

    {

    }

CPbkContactEditorDlgImpl* CPbkContactEditorDlgImpl::NewL(

        CPbkContactEngine& aEngine,

        CPbkContactItem& aContactItem,

        TBool aIsNewContact,

        TInt aFocusIndex,

        TBool aEdited)

    {

    // Create the dialog

    CPbkContactEditorDlgImpl* self = new(ELeave) CPbkContactEditorDlgImpl(

            aEngine, aContactItem, aFocusIndex);

    CleanupStack::PushL(self);

    self->BaseConstructL(aIsNewContact, aEdited);

    // create field managing object

    self->iFieldManager = CPbkContactEditorFieldArray::NewL

        (aContactItem, *self);

    self->iIconReloaderVisitor = new(ELeave) CPbkIconReloaderVisitor(*self);

    CleanupStack::Pop(self);

    return self;

    }

CPbkContactEditorDlgImpl::~CPbkContactEditorDlgImpl()

    {

    delete iIconReloaderVisitor;

    }

CCoeControl* CPbkContactEditorDlgImpl::CreateLineL

        (const TDesC& aCaption,

        TInt aControlId,

        TInt aControlType)

    {

    return CreateLineByTypeL(

            aCaption, aControlId, aControlType, NULL);

    }

CEikCaptionedControl* CPbkContactEditorDlgImpl::LineControl

        (TInt aControlId) const

    {

    return Line(aControlId);

    }

void CPbkContactEditorDlgImpl::DeleteControl

        (TInt aControlId)

    {

    DeleteLine(aControlId);

    }

void CPbkContactEditorDlgImpl::TryChangeFocusL

        (TInt aControlId)

    {

    if (ControlOrNull(aControlId))

        {

        TryChangeFocusToL(aControlId);

        }

    }

void CPbkContactEditorDlgImpl::SetCurrentLineCaptionL

        (const TDesC& aText)

    {

    SetControlCaptionL(IdOfFocusControl(), aText);

    }

CCoeControl* CPbkContactEditorDlgImpl::Control

        (TInt aControlId) const

    {

    return ControlOrNull(aControlId);

    }

void CPbkContactEditorDlgImpl::SetEditableL(TBool aState)

    {

    CPbkContactEditorDlg::SetEditableL(aState);

    }

void CPbkContactEditorDlgImpl::HandleResourceChange(TInt aType)

    {

    CPbkContactEditorDlg::HandleResourceChange(aType);

    if (aType == KAknsMessageSkinChange)

        {

        TRAP_IGNORE(iFieldManager->AcceptL(*iIconReloaderVisitor));

        }

    else if (aType == KEikDynamicLayoutVariantSwitch)

        {        

        // It is not bad if thumbnail showing fails

        TRAP_IGNORE( ReloadThumbnailL() );        

        }

    }

void CPbkContactEditorDlgImpl::FocusChanged(TDrawNow /*aDrawNow*/)

    {

    // Thumbnail will be set as hidden if the control is not focused.

    // all is done in ReloadThumbnailL -method.

    // No big deal if thumbnail is not shown    

    TRAP_IGNORE(ReloadThumbnailL());

    }

///////////////////////////////////////////////////////////////

/// CPbkContactEditorDlg

inline CPbkContactEditorDlg::CPbkContactEditorDlg

        (CPbkContactEngine& aEngine,

        CPbkContactItem& aContactItem,

        TInt aFocusIndex) :

    iContactItem(aContactItem),

    iEngine(aEngine),

    iFocusIndex(aFocusIndex)

    {

    __ASSERT_DEBUG(!iTitlePane && !iThumbnailHandler && !iStoredTitlePaneText,

        Panic(EPanicPostCond_Constructor));

    }

inline void CPbkContactEditorDlg::StoreTitlePaneTextL()

    {

    CEikStatusPane* statusPane = iEikonEnv->AppUiFactory()->StatusPane();

    if (statusPane && statusPane->PaneCapabilities(TUid::Uid(EEikStatusPaneUidTitle)).IsPresent())

        {

        iTitlePane = static_cast<CAknTitlePane*>

            (statusPane->ControlL(TUid::Uid(EEikStatusPaneUidTitle)));

        if (iTitlePane->Text())

            {

            iStoredTitlePaneText = iTitlePane->Text()->AllocL();

            }

        }

    }

inline void CPbkContactEditorDlg::ConstructContextMenuL()

    {

    CEikMenuBar* newMenuBar = new(ELeave) CEikMenuBar();

    CleanupStack::PushL(newMenuBar);

    newMenuBar->ConstructL(this, NULL, R_PBK_CONTACTEDITOR_CONTEXT_MENUBAR);

    iEikonEnv->EikAppUi()->AddToStackL(newMenuBar, ECoeStackPriorityMenu, ECoeStackFlagRefusesFocus);

    iContextMenuBar = newMenuBar;

    CleanupStack::Pop(newMenuBar);

    }

inline void CPbkContactEditorDlg::ConstructNaviPaneL()

    {

    CEikStatusPane* statusPane = iEikonEnv->AppUiFactory()->StatusPane();

    if (statusPane && statusPane->PaneCapabilities(TUid::Uid(EEikStatusPaneUidNavi)).IsPresent())

        {

        // create a default empty status pane, otherwise sync field will show

        iNaviContainer = static_cast<CAknNavigationControlContainer *>(statusPane->ControlL(

                TUid::Uid(EEikStatusPaneUidNavi)));

        iNaviContainer->PushDefaultL();

        }

    }

inline void CPbkContactEditorDlg::BaseConstructL

        (TBool aIsNewContact, TBool aEdited)

    {

    // set feature manager in TLS

    FeatureManager::InitializeLibL();

    CAknDialog::ConstructL(R_PBK_CONTACTEDITOR_MENUBAR);

    iEditorStrategy = PbkContactEditorStrategyFactory::CreateL

        (iEngine, iContactItem, aIsNewContact);

    if (aEdited)

        {

        iEditorStrategy->SetStateModified();

        }

    // check existance of syncronization field

    if(!iContactItem.FindField(EPbkFieldIdSyncronization))

        {

        CPbkFieldInfo* syncFieldInfo = iEngine.FieldsInfo().Find(

            EPbkFieldIdSyncronization);

        if (syncFieldInfo)

            {

            // add syncronization field to contact - compulsory

            iContactItem.AddFieldL(*syncFieldInfo);

            iEditorStrategy->SetStateModified();

            }

        }

    StoreTitlePaneTextL();

    ConstructContextMenuL();

    ConstructNaviPaneL();

    iThumbnailHandler = CPbkThumbnailPopup::NewL(iEngine);

    iThumbnailCmd = CPbkThumbnailCmd::NewL(iEngine, *iThumbnailHandler);

    iExtension = CExtension::NewL(iContactItem, *this);

    }

EXPORT_C CPbkContactEditorDlg* CPbkContactEditorDlg::NewL

        (CPbkContactEngine& aEngine,