/*

* 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 Group UI extension group view.

*

*/

#include "CPguGroupView.h"

// Phonebook 2

#include "Pbk2GroupUi.hrh"

#include <CPbk2UIExtensionView.h>

#include <CPbk2AppUiBase.h>

#include <CPbk2NamesListControl.h>

#include <CPbk2ViewState.h>

#include <CPbk2ControlContainer.h>

#include <MPbk2ViewActivationTransaction.h>

#include <MPbk2ViewExplorer.h>

#include <CPbk2StoreConfiguration.h>

#include <Pbk2GroupUIRes.rsg>

#include <Pbk2CommonUi.rsg>

#include <Pbk2Commands.rsg>

#include <Pbk2UIControls.rsg>

#include <csxhelp/phob.hlp.hrh>

#include <MPbk2CommandHandler.h>

#include <Pbk2UID.h>

#include <MPbk2AppUi.h>

#include <CPbk2ViewStateTransformer.h>

#include <MPbk2StartupMonitor.h>

#include <CPbk2StorePropertyArray.h>

#include <CPbk2StoreProperty.h>

#include <MPbk2ApplicationServices.h>

#include <MPbk2ContactViewSupplier.h>

#include <CPbk2ApplicationServices.h>

#include <MPbk2StoreValidityInformer.h>

#include <Pbk2MenuFilteringFlags.hrh>

// Virtual Phonebook

#include <MVPbkContactStoreList.h>

#include <CVPbkContactStoreUriArray.h>

#include <MVPbkContactStore.h>

#include <CVPbkContactManager.h>

#include <TVPbkContactStoreUriPtr.h>

#include <MVPbkContactStoreProperties.h>

#include <VPbkContactStoreUris.h>

#include <MVPbkContactViewBase.h>

#include <MVPbkViewContact.h>

// System includes

#include <eikmenup.h>

#include <eikbtgpc.h>

#include <avkon.rsg>

#include <featmgr.h>

#include <StringLoader.h>

#include <AiwCommon.hrh>

#include <eikmenub.h>

#include <AknUtils.h>

#include <eiklbx.h>

#include <eiklbo.h>

#include <coecntrl.h>

#include <touchfeedback.h>

/// Unnamed namespace for local definitions

namespace {

_LIT( KNewline, "\n" );

/**

 * Returns ETrue if shift is depressed in given key event.

 *

 * @param aKeyEvent     Key event

 * @return  ETrue if shift is depressed.

 */

inline TBool ShiftDown( const TKeyEvent& aKeyEvent )

    {

    return ( aKeyEvent.iModifiers &

           ( EModifierShift|EModifierLeftShift|EModifierRightShift ) ) != 0;

    }

} /// namespace

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

// CPguGroupView::CPguGroupView

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

//

CPguGroupView::CPguGroupView( CPbk2UIExtensionView& aView ) :

            iView( aView )

    {

    }

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

// CPguGroupView::~CPguGroupView

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

//

CPguGroupView::~CPguGroupView()

    {

    if ( iStoreConfiguration )

        {

        iStoreConfiguration->RemoveObserver( *this );

        }

    delete iControlState;

    delete iParamState;

    if ( iContainer )

        {

        CCoeEnv::Static()->AppUi()->RemoveFromStack( iContainer );

        delete iContainer;

        }

    }

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

// CPguGroupView::NewL

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

//

CPguGroupView* CPguGroupView::NewL( CPbk2UIExtensionView& aView )

    {

    CPguGroupView* self = new ( ELeave ) CPguGroupView( aView );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

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

// CPguGroupView::ConstructL

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

//

inline void CPguGroupView::ConstructL()

    {

    iStoreConfiguration = &Phonebook2::Pbk2AppUi()->ApplicationServices().

        StoreConfiguration();

    iStoreConfiguration->AddObserverL( *this );

    iCommandHandler = Phonebook2::Pbk2AppUi()->ApplicationServices().

        CommandHandlerL();

    // Attach AIW providers

    iCommandHandler->RegisterAiwInterestL

        ( KAiwCmdPoC, R_PHONEBOOK2_GROUPVIEWS_POC_MENU,

          R_PHONEBOOK2_POCUI_AIW_INTEREST, ETrue );

    }

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

// CPguGroupView::HandleStatusPaneSizeChange

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

//

void CPguGroupView::HandleStatusPaneSizeChange()

    {

    // Resize the container to fill the client rectangle

    if ( iContainer )

        {

        iContainer->SetRect( iView.ClientRect() );

        }

    }

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

// CPguGroupView::ViewStateLC

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

//

CPbk2ViewState* CPguGroupView::ViewStateLC() const

    {

    CPbk2ViewState* state = iControl->ControlStateL();

    CleanupStack::PushL( state );

    return state;

    }

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

// CPguGroupView::HandleCommandKeyL

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

//

TBool CPguGroupView::HandleCommandKeyL

        ( const TKeyEvent& aKeyEvent, TEventCode aType )

    {

    TBool result = EFalse;

    TBool itemSpecEnabled = 

        Phonebook2::Pbk2AppUi()->ActiveView()->MenuBar()->ItemSpecificCommandsEnabled();

    if ( itemSpecEnabled && (EStdKeyHash == aKeyEvent.iScanCode) )

        {

        //make sure Hash key won't be passed to default keyHandler

        return ETrue;

        }

    if ( aType == EEventKey )

        {

        switch ( aKeyEvent.iCode )

            {

            case EKeyBackspace:

                {

                if ( itemSpecEnabled && ( iControl->NumberOfContacts() > 0 ) &&

                     ( iControl->FindTextL() == KNullDesC ) )

                    {

                    HandleCommandL( EPbk2CmdRemoveGroup );

                    result = ETrue;

                    }

				break;

				}

            case EKeyEnter: // FALLTHROUGH

            case EKeyOK:

                {

                if ( !ShiftDown( aKeyEvent )  // pure OK or ENTER key

                    && iControl->NumberOfContacts() == 0 )

					{

                    result = ETrue;

                    }

                break;

                }

            default:

                {

                break;

                }

            }

        }

    return result;

    }

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

// CPguGroupView::HandleListBoxEventL

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

//

void CPguGroupView::HandleListBoxEventL(CEikListBox* /*aListBox*/,TListBoxEvent aEventType)

    {

    if( AknLayoutUtils::PenEnabled() )  

        {

        switch ( aEventType )

            {

            case EEventItemSingleClicked:

                {

                ShowContextMenuL();

                break;

                }

            case EEventItemClicked: //Happens after focus changed

            break;

            case EEventEnterKeyPressed:

                {

                // Select key is mapped to "Open Group" command

                HandleCommandL( EPbk2CmdOpenGroup );

                break;

                }    

            default:

               break;

            }

        }

    }

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

// CPguGroupView::HandlePointerEventL

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

//

void CPguGroupView::HandlePointerEventL( const TPointerEvent& aPointerEvent )

    {

    if ( AknLayoutUtils::PenEnabled() )

        {

        if ( iPointerEventInspector->FocusableItemPointed() && iContainer )

            {

            iContainer->LongTapDetectorL().PointerEventL( aPointerEvent );

            }

        if ( iControl->NumberOfContacts()==0) 

            {

            if ( aPointerEvent.iType == TPointerEvent::EButton1Down )

                {

                MTouchFeedback* feedback = MTouchFeedback::Instance();

                if ( feedback )

                    {

                    feedback->InstantFeedback( ETouchFeedbackNone );

                    }

                }

            else if ( aPointerEvent.iType == TPointerEvent::EButton1Up )		

                {

                ShowContextMenuL();

                }

            }

        }

    }

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

// CPguGroupView::ShowContextMenuL

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

//

void CPguGroupView::ShowContextMenuL()

    {

    if ( iStylusPopupMenuLaunched )

        {

        // Absorb EButton1Up event if we already launched the stylus

        // popup menu

        iStylusPopupMenuLaunched = EFalse;

        }

    else if ( !iPointerEventInspector->SearchFieldPointed() )

        {

        if ( iControl->NumberOfContacts() > 0 )

            {

            if ( iPointerEventInspector->FocusedItemPointed() )

                {

                // Open group

                HandleCommandL(EPbk2CmdOpenGroup);

                }

            }

        }

    }

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

// CPguGroupView::GetViewSpecificMenuFilteringFlagsL

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

//

TInt CPguGroupView::GetViewSpecificMenuFilteringFlagsL() const

    {

    TInt flags( 0 );

    flags |= CurrentStoreSupportsGroupsL();

    if ( iControl )

        {

        flags |= iControl->GetMenuFilteringFlagsL();

        const MVPbkViewContact* contact = iControl->FocusedViewContactL();

        if( contact && contact->Expandable() )

            {

            flags |= KPbk2FocusedItemIsExpandable;

            }

        }

    return flags;

    }

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

// CPguGroupView::DoActivateL

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

//

void CPguGroupView::DoActivateL

        ( const TVwsViewId& aPrevViewId, TUid aCustomMessageId,

          const TDesC8& aCustomMessage )

    {

    // Add this view to observe menu command events

    iCommandHandler->AddMenuCommandObserver(*this);

    HBufC* title = StringLoader::LoadLC( R_QTN_PHOB_TITLE );

    MPbk2ViewActivationTransaction* viewActivationTransaction =

        Phonebook2::Pbk2AppUi()->Pbk2ViewExplorer()->HandleViewActivationLC

            ( iView.Id(), aPrevViewId, title, NULL,

              Phonebook2::EUpdateNaviPane | Phonebook2::EUpdateTitlePane |

              Phonebook2::EUpdateContextPane );

    // Check activation parameters

    delete iParamState;

    iParamState = NULL;

    if ( aCustomMessageId == CPbk2ViewState::Uid() )

        {

        iParamState = CPbk2ViewState::NewL( aCustomMessage );

        }

    else if (aCustomMessageId == TUid::Uid(KPbkViewStateUid))

        {

        // Handle legacy view state

        CPbk2ViewStateTransformer* transformer = CPbk2ViewStateTransformer::NewLC

            ( Phonebook2::Pbk2AppUi()->ApplicationServices().ContactManager() );

        iParamState = transformer->

            TransformLegacyViewStateToPbk2ViewStateLC( aCustomMessage );

        CleanupStack::Pop();

        CleanupStack::PopAndDestroy( transformer );

        }

    // Notifies startup monitor of view activation

    if (Phonebook2::Pbk2AppUi()->Pbk2StartupMonitor())

        {

        Phonebook2::Pbk2AppUi()->Pbk2StartupMonitor()->

            NotifyViewActivationL( iView.Id(),

            *Phonebook2::Pbk2AppUi()->ApplicationServices().

                ViewSupplier().AllGroupsViewL() );

        }

    CreateControlsL();

    iContainer->ActivateL();

    CCoeControl* ctrl=iControl->ComponentControl(0);

    CEikListBox* listbox=static_cast <CEikListBox*> (ctrl);

    listbox->SetListBoxObserver( this ); 

    viewActivationTransaction->Commit();

    CleanupStack::PopAndDestroy( 2 ); //title, viewActivationTransaction

    // Should be here because in NOT READY case view does not become ready

    // and cbas are not updated without this.

    UpdateCbasL();

    }

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

// CPguGroupView::DoDeactivate

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

//

void CPguGroupView::DoDeactivate()

    {

    iCommandHandler->RemoveMenuCommandObserver( *this );

    // Trash the old states

    delete iParamState;

    iParamState = NULL;

    delete iControlState;

    iControlState = NULL;

    if ( iContainer )

        {

        CCoeEnv::Static()->AppUi()->RemoveFromStack( iContainer );

        // Store current state, safe to ignore. There's no real harm,

        // if theres no stored state when activating this view again

        TRAP_IGNORE( StoreStateL() );

        delete iContainer;

        iContainer = NULL;

        iControl = NULL;

        }

    }

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

// CPguGroupView::HandleCommandL

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

//

void CPguGroupView::HandleCommandL( TInt aCommand )

    {

    // this will leave if control is NULL due to e.g. bad view switch

    CheckUiControlL();

    switch( aCommand )

    	{

        case EAknCmdExit:

        case EAknSoftkeyExit:

        case EPbk2CmdExit:

        case EAknCmdHideInBackground:

            {

            // AppUi will send the application to background.

            // Because the control is not destroyed it must be reset so that

            // when the view comes foreground again it will look like a fresh

            // and brand new control.

            iControl->Reset();

       	    break;

            }

    	default:

    	    break;

        }

    // No command handling in this class, forward to Commands

    if ( !iCommandHandler->HandleCommandL( aCommand, *iControl, &iView ) )

        {

        iControl->ProcessCommandL( aCommand );

        Phonebook2::Pbk2AppUi()->HandleCommandL( aCommand );

        UpdateCbasL();

        }

    }

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

// CPguGroupView::DynInitMenuPaneL

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

//

void CPguGroupView::DynInitMenuPaneL(

        TInt aResourceId,

        CEikMenuPane* aMenuPane )

    {

    // this will leave if control is NULL due to e.g. bad view switch

    CheckUiControlL();

    if ( iControl )

        {

        // Ask the control do control specific filtering

        // (for example call HandleMarkableListDynInitMenuPane if needed)

        iControl->DynInitMenuPaneL( aResourceId, aMenuPane );

        }

    switch ( aResourceId )

        {

        case R_PHONEBOOK2_GROUPSLIST_MENU:

            {

            if ( !CurrentStoreSupportsGroupsL() )

                {

                aMenuPane->SetItemDimmed( EPbk2CmdCreateNewGroup, ETrue );

                }

            // Weed out commands not meant to be used with empty list

            if ( iControl->NumberOfContacts() == 0 )

                {

                aMenuPane->SetItemDimmed( EPbk2CmdOpenGroup, ETrue );

                aMenuPane->SetItemDimmed( EPbk2CmdWriteGroup, ETrue );

                aMenuPane->SetItemDimmed( EPbk2CmdRemoveGroup, ETrue );

                aMenuPane->SetItemDimmed( EPbk2CmdRenameGroup, ETrue );

                aMenuPane->SetItemDimmed( EPbk2CmdSetToneToGroup, ETrue );

                }

            break;

            }

        case R_PHONEBOOK2_GROUPLIST_CONTEXT_MENU:

            {

            if( !CurrentStoreSupportsGroupsL() )

                {

                aMenuPane->SetItemDimmed( EPbk2CmdCreateNewGroup, ETrue );

                }

            break;

            }

        case R_PHONEBOOK2_INFO_MENU:

            {

            // If there are no available stores, "memory details" should not be shown in Options menu

            if( !CurrentStoreIsAvailableL() )

                {

                aMenuPane->SetItemDimmed( EPbk2CmdPhonebook2Info, ETrue ); 

                }

            break;