/*

* Copyright (c) 2005-2007 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:  Phonebook 2 contact info view control.

*

*/

// INCLUDE FILES

#include <CPbk2ContactInfoControl.h>

// Phonebook 2

#include "CPbk2ContactInfoListBox.h"

#include "CPbk2ContactInfoDataSwapper.h"

#include "CPbk2ContactFieldDynamicProperties.h"

#include "CPbk2ThumbnailLoader.h"

#include "Pbk2TitlePanePictureFactory.h"

#include <Pbk2UIControls.hrh>

#include <CPbk2IconArray.h>

#include <MPbk2ContactNameFormatter.h>

#include <CPbk2ViewState.h>

#include <MPbk2ControlObserver.h>

#include <CPbk2PresentationContact.h>

#include <CPbk2PresentationContactField.h>

#include <CPbk2PresentationContactFieldCollection.h>

#include <CPbk2FieldPropertyArray.h>

#include <Pbk2MenuFilteringFlags.hrh>

#include <MPbk2ContactNavigation.h>

#include <CPbk2StorePropertyArray.h>

#include <CPbk2StoreSpecificFieldPropertyArray.h>

#include <MPbk2Command.h>

#include <Pbk2Profile.h>

// Virtual Phonebook

#include <MVPbkContactOperationBase.h>

#include <CVPbkContactManager.h>

#include <MVPbkContactLink.h>

#include <MVPbkStoreContact.h>

#include <MVPbkStoreContactField.h>

#include <MVPbkStoreContactFieldCollection.h>

#include <MVPbkContactStore.h>

#include <MVPbkContactStoreProperties.h>

#include <MVPbkContactFieldSelector.h>

#include <MVPbkFieldType.h>

#include <CVPbkFieldTypeSelector.h>

#include <CVPbkContactStoreUriArray.h>

#include <MVPbkContactFieldTextData.h>

// System includes

#include <akntitle.h>

#include <AknsConstants.h>

#include <avkon.hrh>

#include <barsread.h>

#include <bautils.h>

// Debugging headers

#include <Pbk2Debug.h>

/// Unnamed namespace for local definitions

namespace {

// LOCAL CONSTANTS AND MACROS

const TInt KNumberOfControls = 1;

const TInt KNoContacts = 0;

const TInt KNumberOfContacts = 1;

const TInt KDefaultTitleFormat = MPbk2ContactNameFormatter::EUseSeparator;

#ifdef _DEBUG

enum TPanicCode

    {

    EPanicPreCond_FocusedField = 1,

    EPanicLogic_FocusedField,

    EPanicPreCond_FocusedFieldIndex,

    EPanicPostCond_FocusedFieldIndex,

    EPanicPreCond_FieldPos,

    EPanicPreCond_OfferKeyEventL,

    EPanicPreCond_SizeChanged,

    EPanicPreCond_CountComponentControls,

    EPanicPreCond_ComponentControl

    };

void Panic(TInt aReason)

    {

    _LIT(KPanicText, "CPbk2ContactInfoControl");

    User::Panic(KPanicText, aReason);

    }

#endif // _DEBUG

} /// namespace

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::CPbk2ContactInfoControl

// --------------------------------------------------------------------------

//

CPbk2ContactInfoControl::CPbk2ContactInfoControl(

        CVPbkContactManager& aManager,

        MPbk2ContactNameFormatter& aNameFormatter,

        MPbk2FieldPropertyArray& aFieldProperties,

        CPbk2StorePropertyArray& aStoreProperties,

        MPbk2ContactNavigation* aNavigator ) :

    iContactManager( aManager ),

    iNameFormatter( aNameFormatter ),

    iNavigator( aNavigator ),

    iFieldProperties( aFieldProperties ),

    iStoreProperties( aStoreProperties ),

    iFocusedFieldIndex( KErrNotFound )

    {

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::~CPbk2ContactInfoControl

// --------------------------------------------------------------------------

//

CPbk2ContactInfoControl::~CPbk2ContactInfoControl()

    {

    if( iTitlePane )

        {

        iTitlePane->SetSmallPicture( NULL, NULL, EFalse );

        }

    if (iCommand)

        {

        // inform the command that the control is deleted

        iCommand->ResetUiControl(*this);

        }

    iObservers.Reset();

    delete iThumbnailLoader;

    delete iListBox;

    delete iContact;

    delete iStoreContact;

    delete iRetriever;

    delete iContactLink;

    delete iSpecificFieldProperties;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::ConstructL

// --------------------------------------------------------------------------

//

inline void CPbk2ContactInfoControl::ConstructL(

        const CCoeControl* aContainer)

    {

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPbk2ContactInfoControl::ConstructL begin"));

    SetContainerWindowL(*aContainer);

    // Create the listbox

    iListBox = CPbk2ContactInfoListBox::NewL(

        *this, R_PBK2_CONTACT_INFO_CONTROL, iContactManager);

    iListBox->SetObserver(this);

    iListBox->SetScrollEventObserver( this );

    iListBox->SetListBoxObserver( this );

    // Get flags from listbox

    iFlags = iListBox->Flags();

    // Create thumbnail loader

    iThumbnailLoader = CPbk2ThumbnailLoader::NewL( iContactManager );

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

    if( statusPane && statusPane->

        PaneCapabilities( TUid::Uid( EEikStatusPaneUidTitle ) ).IsPresent() )

        {

        iTitlePane = static_cast<CAknTitlePane*>(

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

        }

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPbk2ContactInfoControl::ConstructL end"));

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::NewL

// --------------------------------------------------------------------------

//

EXPORT_C CPbk2ContactInfoControl* CPbk2ContactInfoControl::NewL

        ( const CCoeControl* aContainer,

          CVPbkContactManager& aManager,

          MPbk2ContactNameFormatter& aNameFormatter,

          MPbk2FieldPropertyArray& aFieldProperties,

          CPbk2StorePropertyArray& aStoreProperties,

          MPbk2ContactNavigation* aNavigator )

    {

    CPbk2ContactInfoControl* self = new ( ELeave ) CPbk2ContactInfoControl

        ( aManager, aNameFormatter, aFieldProperties, aStoreProperties,

          aNavigator );

    CleanupStack::PushL( self );

    self->ConstructL( aContainer );

    CleanupStack::Pop( self );

    return self;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::AddObserverL

// --------------------------------------------------------------------------

//

EXPORT_C void CPbk2ContactInfoControl::AddObserverL

        (MPbk2ControlObserver& aObserver)

    {

    User::LeaveIfError(iObservers.Append(&aObserver));

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::RemoveObserver

// --------------------------------------------------------------------------

//

EXPORT_C void CPbk2ContactInfoControl::RemoveObserver

        (MPbk2ControlObserver& aObserver)

    {

    const TInt index = iObservers.Find(&aObserver);

    if (index >= 0)

        {

        iObservers.Remove(index);

        }

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::ParentControl

// --------------------------------------------------------------------------

//

MPbk2ContactUiControl* CPbk2ContactInfoControl::ParentControl() const

    {

    // Contact info control has no parent control

    return NULL;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::NumberOfContacts

// --------------------------------------------------------------------------

//

TInt CPbk2ContactInfoControl::NumberOfContacts() const

    {

    return KNumberOfContacts;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::FocusedContactL

// --------------------------------------------------------------------------

//

const MVPbkBaseContact* CPbk2ContactInfoControl::FocusedContactL() const

    {

    return iContact;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::FocusedViewContactL

// --------------------------------------------------------------------------

//

const MVPbkViewContact* CPbk2ContactInfoControl::FocusedViewContactL() const

    {

    return NULL;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::FocusedStoreContact

// --------------------------------------------------------------------------

//

const MVPbkStoreContact* CPbk2ContactInfoControl::FocusedStoreContact() const

    {

    return iStoreContact;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SetFocusedContactL

// --------------------------------------------------------------------------

//

void CPbk2ContactInfoControl::SetFocusedContactL(

        const MVPbkBaseContact& aContact)

    {

    // Load the new contact

    delete iContactLink;

    iContactLink = NULL;

    iContactLink = aContact.CreateLinkLC();

    CleanupStack::Pop(); // iContactLink

    RetrieveContactL( *iContactLink );

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SetFocusedContactL

// --------------------------------------------------------------------------

//

void CPbk2ContactInfoControl::SetFocusedContactL(

        const MVPbkContactBookmark& /*aContactBookmark*/ )

    {

    // Do nothing

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SetFocusedContactL

// --------------------------------------------------------------------------

//

void CPbk2ContactInfoControl::SetFocusedContactL(

        const MVPbkContactLink& aContactLink )

    {

    // Load the new contact

    delete iContactLink;

    iContactLink = NULL;

    iContactLink = aContactLink.CloneLC();

    CleanupStack::Pop(); // iContactLink

    RetrieveContactL( *iContactLink );

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::FocusedContactIndex

// --------------------------------------------------------------------------

//

TInt CPbk2ContactInfoControl::FocusedContactIndex() const

    {

    return KErrNotSupported;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SetFocusedContactIndexL

// --------------------------------------------------------------------------

//

void CPbk2ContactInfoControl::SetFocusedContactIndexL( TInt /*aIndex*/ )

    {

    // Do nothing

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::NumberOfContactFields

// --------------------------------------------------------------------------

//

TInt CPbk2ContactInfoControl::NumberOfContactFields() const

    {

    return iContact->Fields().FieldCount();

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::FocusedField

// --------------------------------------------------------------------------

//

const MVPbkBaseContactField* CPbk2ContactInfoControl::FocusedField() const

    {

    // PreCond:

    __ASSERT_DEBUG(iListBox && iFields, Panic(EPanicPreCond_FocusedField));

    const MVPbkBaseContactField* ret = NULL;

    const TInt fieldsCount = iFields->FieldCount();

    const TInt index = iListBox->CurrentItemIndex();

    TInt numberOfVisibleFields = 0;

    if (index >= 0)

        {

        __ASSERT_DEBUG(index < iFields->FieldCount(),

            Panic(EPanicLogic_FocusedField));

        // Field collection may have hidden fields, so find visible field

        // corresponding to the focused field in the listbox.

        for ( TInt i = 0; i < fieldsCount && ret == NULL; i++ )

            {

            if ( iFields->At( i ).IsVisibleInDetailsView() && 

                iFields->At( i ).DynamicVisibility() )

                {

                numberOfVisibleFields++;

                }

            if ( numberOfVisibleFields - 1 == index )

                {

                ret = &iFields->FieldAt( i );

                }

            }

        }

    return ret;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::FocusedFieldIndex

// --------------------------------------------------------------------------

//

TInt CPbk2ContactInfoControl::FocusedFieldIndex() const

    {

    // PreCond:

    __ASSERT_DEBUG(iContact, Panic(EPanicPreCond_FocusedFieldIndex));

    return iListBox->CurrentItemIndex();

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SetFocusedFieldIndex

// --------------------------------------------------------------------------

//

void CPbk2ContactInfoControl::SetFocusedFieldIndex(

        TInt aIndex )

    {

    iFocusedFieldIndex = aIndex;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::ContactsMarked

// --------------------------------------------------------------------------

//

TBool CPbk2ContactInfoControl::ContactsMarked() const

    {

    // This control does not support contacts marking

    return EFalse;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SelectedContactsL

// --------------------------------------------------------------------------

//

MVPbkContactLinkArray* CPbk2ContactInfoControl::SelectedContactsL() const

    {

    // No selection support in contact info control

    return NULL;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SelectedContactsOrFocusedContactL

// --------------------------------------------------------------------------

//

MVPbkContactLinkArray*

        CPbk2ContactInfoControl::SelectedContactsOrFocusedContactL() const

    {

    CVPbkContactLinkArray* array = CVPbkContactLinkArray::NewLC();

    const MVPbkBaseContact* focusedContact = FocusedContactL();

    if ( focusedContact )

        {

        MVPbkContactLink* link = focusedContact->CreateLinkLC();

        CleanupStack::Pop(); // link

        array->AppendL( link );

        }

    CleanupStack::Pop(); // array

    return array;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SelectedContactsIteratorL

// --------------------------------------------------------------------------

//

MPbk2ContactLinkIterator*

    CPbk2ContactInfoControl::SelectedContactsIteratorL() const

    {

    // No selection support in contact info control

    return NULL;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SelectedContactStoresL

// --------------------------------------------------------------------------

//

CArrayPtr<MVPbkContactStore>*

        CPbk2ContactInfoControl::SelectedContactStoresL() const

    {

    // This is not a contact store control

    return NULL;

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::ClearMarks

// --------------------------------------------------------------------------

//

void CPbk2ContactInfoControl::ClearMarks()

    {

    // Do nothing

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SetSelectedContactL

// --------------------------------------------------------------------------

//

void CPbk2ContactInfoControl::SetSelectedContactL(

        TInt /*aIndex*/,

        TBool /*aSelected*/)

    {

    // Not supported in Contact Info

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SetSelectedContactL

// --------------------------------------------------------------------------

//

void CPbk2ContactInfoControl::SetSelectedContactL(

        const MVPbkContactBookmark& /*aContactBookmark*/,

        TBool /*aSelected*/ )

    {

    // Not supported

    }

// --------------------------------------------------------------------------

// CPbk2ContactInfoControl::SetSelectedContactL

// --------------------------------------------------------------------------

//

void CPbk2ContactInfoControl::SetSelectedContactL(

        const MVPbkContactLink& /*aContactLink*/,

        TBool /*aSelected*/ )

    {

    // Not supported

    }

TInt CPbk2ContactInfoControl::CommandItemCount() const

	{

	return 0; // No command items.

	}

const MPbk2UiControlCmdItem& CPbk2ContactInfoControl::CommandItemAt(

	TInt /*aIndex*/ ) const

	{

	// There are no command items in this control

	__ASSERT_ALWAYS( EFalse, User::Panic( _L("Pbk2"), 4)); //TODO

	MPbk2UiControlCmdItem* item = NULL; // For compiler only

	return *item; // For compiler only

	}

const MPbk2UiControlCmdItem* CPbk2ContactInfoControl::FocusedCommandItem() const

	{

	return NULL;

	}