/*

* 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 names list ready state.

*

*/

// INCLUDE FILES

#include "CPbk2NamesListReadyState.h"

// Phonebook 2

#include "CPbk2AdaptiveSearchGridFiller.h"

#include "CPbk2ThumbnailLoader.h"

#include "CPbk2ContactViewListBox.h"

#include "CPbk2ContactViewIterator.h"

#include "MPbk2UiControlEventSender.h"

#include "CPbk2FindDelay.h"

#include "CPbk2NamesListControl.h"

#include "CPbk2FindStringSplitter.h"

#include <CPbk2ViewState.h>

#include <MPbk2ControlObserver.h>

#include <Pbk2MenuFilteringFlags.hrh>

#include <MPbk2ApplicationServices.h>

#include <MPbk2AppUi.h>

#include "TPbk2FindTextUtil.h"

#include <CPbk2AppViewBase.h>

#include "PmuCommands.hrh"  // For accessing EPmuCmdCascadingBackup

#include "Pbk2USimUI.hrh"   // For accessing EPsu2CmdCascadingSimMemory

#include <Pbk2InternalUID.h>

#include <pbk2doublelistboxcmditemextension.h>

// Virtual Phonebook

#include <MVPbkContactViewBase.h>

#include <MVPbkViewContact.h>

#include <MVPbkContactLink.h>

#include <MVPbkContactBookmark.h>

#include <CVPbkContactLinkArray.h>

#include <CVPbkContactFindPolicy.h>

#include <CVPbkContactManager.h>

// System includes

#include <akntoolbar.h>

#include <AknsDrawUtils.h>

#include <barsread.h>

#include <aknsfld.h>

#include <badesca.h>

#include <aknViewAppUi.h>

#include <aknappui.h>

#include <eikmenub.h>

#include <eikdialg.h>

// Debugging headers

#include <Pbk2Debug.h>

#include "CPbk2PredictiveSearchFilter.h"

#include "cpbk2predictiveviewstack.h"

/// Unnamed namespace for local definitions

namespace {

// LOCAL CONSTANTS AND MACROS

const TInt KNumberOfControls = 2;               // listbox and findbox

const TInt KFindDelayTime = 700000;             // microseconds

const TInt KFindDelayThresholdContacts = 1000;  // amount of contacts to

                                                // activate find delay

#ifdef _DEBUG

enum TPanicCode

    {

    EPanicLogic_ComponentControl = 1,

    EPanicLogic_FindTextL,

    EPanicLogic_PreConds_SetCurrentItemIndexAndDraw,

    EPanicLogic_Command_index_out_of_bounds

    };

void Panic(TPanicCode aReason)

    {

    _LIT(KPanicText, "CPbk2NamesListReadyState");

    User::Panic(KPanicText, aReason);

    }

#endif // _DEBUG

NONSHARABLE_CLASS(TCleanupEnableListBoxViewRedraw)

    {

    public: // Interface

        /**

         * Constructor.

         *

         * @param aListBoxView  The list box view

         */

        inline TCleanupEnableListBoxViewRedraw( CListBoxView& aListBoxView )

            : iCleanupItem( CleanupOp, &aListBoxView )

            {

            }

        /**

         * Returns the cleanup item.

         */

        inline operator TCleanupItem() const

            {

            return iCleanupItem;

            }

    private:  // Implementation

        static void CleanupOp(

                TAny* aPtr );

    private:  // Data

        /// Own: Cleanup item

        TCleanupItem iCleanupItem;

    };

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

// TCleanupEnableListBoxViewRedraw::CleanupOp

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

//

void TCleanupEnableListBoxViewRedraw::CleanupOp( TAny* aPtr )

    {

    static_cast<CListBoxView*>(aPtr)->SetDisableRedraw(EFalse);

    }

/**

 * Resolves the next index of the listbox according the key event.

 * If key event is UP, the index is decreased from current index.

 * If key event is DOWN, the index is increased from current index.

 * If current index is last & event is DOWN, the new index is set to first.

 * If current index is first & event is UP, the new index is set to last.

 *

 * @param aKeyEvent     Key event.

 * @param aListBox      List box.

 * @return  Next index of the list item.

 */

TInt NextFocusIndex

        ( const TKeyEvent& aKeyEvent, CEikListBox& aListBox )

    {

    TInt result( KErrNotFound );

    const TInt KFirstItemIndex( 0 );

    TInt itemCount( aListBox.Model()->NumberOfItems() );

    const TInt KLastItemIndex( itemCount - 1 );

    TInt currentItemIndex( aListBox.CurrentItemIndex() );

    if ( aKeyEvent.iCode == EKeyDownArrow )

        {

        result = currentItemIndex + 1;

        if ( result > KLastItemIndex )

            {

            // Set to first

            result = KFirstItemIndex;

            }

        }

    else if ( aKeyEvent.iCode == EKeyUpArrow )

        {

        result = currentItemIndex - 1;

        if ( result < KFirstItemIndex )

            {

            // Set to last

            result = KLastItemIndex;

            }

        }

    else

        {

        result = currentItemIndex;

        }

    return result;

    }

} /// namespace

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

// CPbk2NamesListReadyState::CPbk2NamesListReadyState

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

//

inline CPbk2NamesListReadyState::CPbk2NamesListReadyState(

        const CCoeControl& aParent,

        CPbk2ContactViewListBox& aListBox,

        MPbk2FilteredViewStack& aViewStack,

        CAknSearchField* aFindBox,

        CPbk2ThumbnailLoader& aThumbnailLoader,

        MPbk2UiControlEventSender& aEventSender,

        MPbk2ContactNameFormatter& aNameFormatter,

        RPointerArray<MPbk2UiControlCmdItem>& aCommandItems,

        CPbk2PredictiveSearchFilter& aSearchFilter ) :

    iParent( aParent ),

    iListBox( aListBox ),

    iViewStack( aViewStack ),

    iFindBox( aFindBox ),

    iThumbnailLoader( aThumbnailLoader ),

    iEventSender( aEventSender ),

    iNameFormatter( aNameFormatter ),

    iCommandItems( aCommandItems ),

    iSearchFilter(aSearchFilter)

    {

    }

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

// CPbk2NamesListReadyState::~CPbk2NamesListReadyState

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

//

CPbk2NamesListReadyState::~CPbk2NamesListReadyState()

    {

    UnsubscribeCmdItemsVisibility();

    iListBox.SetListCommands( NULL );

    delete iAdaptiveSearchGridFiller;

    delete iFindPolicy;

    delete iFindDelay;

    delete iFindTextBuf;

    iSelectedItems.Close();

    delete iStringArray;

    delete iStringSplitter;

    iIteratorIndexes.Close();

    }

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

// CPbk2NamesListReadyState::NewL

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

//

CPbk2NamesListReadyState* CPbk2NamesListReadyState::NewLC

        ( const CCoeControl* aParent, CPbk2ContactViewListBox& aListBox,

          MPbk2FilteredViewStack& aViewStack, CAknSearchField* aFindBox,

          CPbk2ThumbnailLoader& aThumbnailLoader,

          MPbk2UiControlEventSender& aEventSender,

          MPbk2ContactNameFormatter& aNameFormatter,

          RPointerArray<MPbk2UiControlCmdItem>& aCommandItems,

          CPbk2PredictiveSearchFilter& aSearchFilter )

    {

    CPbk2NamesListReadyState* self = new (ELeave) CPbk2NamesListReadyState(

        *aParent, aListBox, aViewStack, aFindBox, aThumbnailLoader,

        aEventSender, aNameFormatter, aCommandItems, aSearchFilter );

    CleanupStack::PushL(self);

    self->ConstructL();

    return self;

    }

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

// CPbk2NamesListReadyState::ConstructL

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

//

inline void CPbk2NamesListReadyState::ConstructL()

    {

    if ( iFindBox )

        {

        if (!iFindBox->IsFocused() && iParent.IsFocused() )

            {

            iFindBox->SetFocus(ETrue);

            }

        iFindBox->ResetL();

        }

    iFindDelay = CPbk2FindDelay::NewL( *this );

    // Create contact find policy

    CVPbkContactManager& manager =

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

    CVPbkContactFindPolicy::TParam param =

        CVPbkContactFindPolicy::TParam(

            manager.FieldTypes(),

            manager.FsSession() );

    iFindPolicy = CVPbkContactFindPolicy::NewL( param );

    if( iFindBox )

        {

        iFindBox->AddAdaptiveSearchTextObserverL( this );

        iAdaptiveSearchGridFiller = CPbk2AdaptiveSearchGridFiller::NewL( *iFindBox, iNameFormatter );

        }

    }

void CPbk2NamesListReadyState::UnsubscribeCmdItemsVisibility() const

    {

    for ( TInt i = 0; i < iCommandItems.Count(); ++i )

        {

        iCommandItems[i]->SetVisibilityObserver( NULL );

        }

    }

void CPbk2NamesListReadyState::SubscribeCmdItemsVisibility()

    {

    for ( TInt i = 0; i < iCommandItems.Count(); ++i )

        {

        iCommandItems[i]->SetVisibilityObserver( this );

        }

    }

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

// CPbk2NamesListReadyState::ActivateStateL

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

//

void CPbk2NamesListReadyState::ActivateStateL()

    {

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPbk2NamesListReadyState::ActivateStateL(0x%x)"), this );

    AllowCommandsToShowThemselves( ETrue );  

    UpdateAdaptiveSearchGridL( EFalse );

    }

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

// CPbk2NamesListReadyState::DeactivateState

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

//

void CPbk2NamesListReadyState::DeactivateState()

    {

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPbk2NamesListReadyState::DeactivateState(0x%x)"), this );

    AllowCommandsToShowThemselves( EFalse );  

    HideThumbnail();

    }

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

// CPbk2NamesListReadyState::CountComponentControls

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

//

TInt CPbk2NamesListReadyState::CountComponentControls() const

    {

    TInt numberOfControls( KNumberOfControls );

    if ( !iFindBox )

        {

        --numberOfControls;

        }

    return numberOfControls;

    }

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

// CPbk2NamesListReadyState::ComponentControl

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

//

CCoeControl* CPbk2NamesListReadyState::ComponentControl(TInt aIndex) const

    {

    switch (aIndex)

        {

        case 0:

            {

            return &iListBox;

            }

        case 1:

            {

            return iFindBox;

            }

        default:

            {

            // Illegal state

            __ASSERT_DEBUG(EFalse, Panic(EPanicLogic_ComponentControl));

            return NULL;

            }

        }

    }

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

// CPbk2NamesListReadyState::SizeChanged

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

//

void CPbk2NamesListReadyState::SizeChanged()

    {

    const TRect rect(iParent.Rect());

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPbk2NamesListReadyState::SizeChanged(0x%x), rect=(%d,%d,%d,%d)"),

        this, rect.iTl.iX, rect.iTl.iY, rect.iBr.iX, rect.iBr.iY);

    if ( iFindBox )

        {

        AknLayoutUtils::LayoutControl(&iListBox, rect,

        AKN_LAYOUT_WINDOW_list_gen_pane(1));

        AknLayoutUtils::LayoutControl( iFindBox, rect,

            AKN_LAYOUT_WINDOW_find_pane );

        if (iFindBox->IsVisible() && iListBox.IsVisible())

            {

            iFindBox->SetLinePos(EABColumn);

            }

        }

    else

        {

        AknLayoutUtils::LayoutControl(&iListBox, rect,

        AKN_LAYOUT_WINDOW_list_gen_pane(0));

        }

    }

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

// CPbk2NamesListReadyState::MakeComponentsVisible

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

//

void CPbk2NamesListReadyState::MakeComponentsVisible(TBool aVisible)

    {

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPbk2NamesListReadyState::MakeComponentsVisible(0x%x,%d)"),

        this, aVisible);

    iListBox.MakeVisible(aVisible);

    CEikScrollBar *scrollBar = iListBox.ScrollBarFrame()->GetScrollBarHandle

                                                           (CEikScrollBar::EVertical);

    if ( scrollBar )

       {

        scrollBar->MakeVisible(aVisible);

        }

    if ( iFindBox )

        {

        if ( (iFindBox->IsVisible()&&!aVisible) || (!iFindBox->IsVisible()&&aVisible) )

            {

            iFindBox->MakeVisible(aVisible);

            }

        }

    // Have to call to make sure that scrollbar is updated when state of

    // control is changing.

    TRAP_IGNORE( iListBox.UpdateScrollBarsL() );

    // Change visible state

    iVisible = aVisible;

    }

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

// CPbk2NamesListReadyState::ActivateL

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

//

void CPbk2NamesListReadyState::ActivateL()

    {

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING

        ("CPbk2NamesListReadyState::ActivateL(0x%x)"), this );

    if ( iFindBox )

        {

        // Adjust find box cursor

        CEikEdwin& findEditor = iFindBox->Editor();

        findEditor.SetCursorPosL(findEditor.TextLength(), EFalse);

        }

    }

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

// CPbk2NamesListReadyState::Draw

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

//

void CPbk2NamesListReadyState::Draw

        ( const TRect& aRect, CWindowGc& aGc ) const

    {

    PBK2_DEBUG_PRINT( PBK2_DEBUG_STRING(

        "CPbk2NamesListReadyState::Draw(0x%x, TRect(%d,%d,%d,%d))" ),

        this, aRect.iTl.iX, aRect.iTl.iY, aRect.iBr.iX, aRect.iBr.iY );

    if ( !iVisible )

        {

        // If control is not visible (blanked) draw a blank background

        MAknsSkinInstance* skin = AknsUtils::SkinInstance();

        MAknsControlContext* cc =

            AknsDrawUtils::ControlContext( &iListBox );

        if ( !AknsDrawUtils::Background( skin, cc, &iListBox, aGc, aRect ) )

            {

            // Blank background if no skin present

            aGc.SetPenStyle( CGraphicsContext::ENullPen );

            aGc.SetBrushStyle( CGraphicsContext::ESolidBrush );

            aGc.DrawRect( aRect );

            }

        }

    }

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

// CPbk2NamesListReadyState::DialogMenuBar

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

//

CEikMenuBar* CPbk2NamesListReadyState::DialogMenuBar(CAknAppUi* aAppUi)

    {

    CEikMenuBar* menuBar = NULL;

    // Check for an active dialog and fetch its menu bar

    if (aAppUi->IsDisplayingMenuOrDialog())

        {

        CCoeControl* ctrl = aAppUi->TopFocusedControl();

        if (ctrl)

            {

            CEikDialog* dialog = ctrl->MopGetObjectNoChaining(dialog);

            if (dialog)

                {

                dialog->MopGetObject(menuBar);

                }

            }

        }

    return menuBar;

    }

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

// CPbk2NamesListReadyState::ViewMenuBar

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

//

CEikMenuBar* CPbk2NamesListReadyState::ViewMenuBar(CAknAppUi* aAppUi)

    {

    CEikMenuBar* menuBar = NULL;

    // Check for an active view

    TVwsViewId uid;

    if (aAppUi->GetActiveViewId(uid) == KErrNone)

        {

        if ( uid.iAppUid != uid.iViewUid )

            {

            CAknView* view = 

                static_cast<CAknViewAppUi*> (aAppUi)->View(uid.iViewUid);

            if ( view )

                {

                menuBar = view->MenuBar();

                }

            }

        }

    return menuBar;

    }

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

// CPbk2NamesListReadyState::MenuBar

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

//

CEikMenuBar* CPbk2NamesListReadyState::MenuBar(CAknAppUi* aAppUi)

    {

    // Try fetching a menu bar from currently displayed dialog