/*

* Copyright (c) 2006-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 members view.

*

*/

#include "CPguGroupMembersView.h"

// Phonebook 2

#include "CPguAddMembersCmd.h"

#include "CPguRemoveFromGroupCmd.h"

#include "Pbk2GroupUi.hrh"

#include <pbk2groupuires.rsg>

#include <CPbk2AppUiBase.h>

#include <pbk2commands.rsg>

#include <CPbk2UIExtensionView.h>

#include <CPbk2DocumentBase.h>

#include <CPbk2NamesListControl.h>

#include <CPbk2ViewState.h>

#include <CPbk2ControlContainer.h>

#include <MPbk2ViewActivationTransaction.h>

#include <MPbk2ViewExplorer.h>

#include <MPbk2CommandHandler.h>

#include <CPbk2SortOrderManager.h>

#include <MPbk2ContactNavigation.h>

#include <MPbk2ContactNavigationLoader.h>

#include <Pbk2NavigatorFactory.h>

#include <Pbk2Commands.hrh>

#include <MPbk2ContactNameFormatter.h>

#include <CPbk2ViewStateTransformer.h>

#include <csxhelp/phob.hlp.hrh>

#include <Pbk2UID.h>

#include <MPbk2StartupMonitor.h>

#include <MVPbkContactViewObserver.h>

#include <CPbk2ContactUiControlSubstitute.h>

#include <MPbk2StoreConfigurationObserver.h>

#include <MPbk2ControlObserver.h>

#include <MPbk2NavigationObserver.h>

#include <MPbk2MenuCommandObserver.h>

#include <pbk2commonui.rsg>

#include <pbk2uicontrols.rsg>

#include <MPbk2PointerEventInspector.h>

#include <MPbk2ApplicationServices.h>

#include <MPbk2ContactViewSupplier.h>

#include <CPbk2StoreConfiguration.h>

#include <MPbk2AppUi.h>

#include <Pbk2MenuFilteringFlags.hrh>

// Virtual Phonebook

#include <MVPbkContactViewBase.h>

#include <MVPbkViewContact.h>

#include <MVPbkExpandable.h>

#include <MVPbkContactLink.h>

#include <CVPbkContactStoreUriArray.h>

#include <CVPbkContactManager.h>

#include <MVPbkContactStoreList.h>

#include <MVPbkContactStore.h>

#include <MVPbkContactStoreProperties.h>

// System includes

#include <akntitle.h>

#include <eikbtgpc.h>

#include <avkon.rsg>

#include <aknnavide.h>

#include <akntabgrp.h>

#include <StringLoader.h>

#include <AknUtils.h>

#include <eiklbx.h>

#include <eiklbo.h>

#include <touchfeedback.h>

/// Unnamed namespace for local definitions

namespace {

const TInt KFirstItem = 0; // First item index

/**

 * Returns ETrue if shift is depressed in aKeyEvent.

 *

 * @param aKeyEvent     Key event.

 * @return  ETrue if shift is depressed.

 */

inline TBool ShiftDown( const TKeyEvent& aKeyEvent )

    {

    return ( ( aKeyEvent.iModifiers ) &

             ( EModifierShift|EModifierLeftShift|EModifierRightShift )

                ) != 0;

    }

/**

 * Returns ETrue if either Shift or Control key is depressed.

 *

 * @param aKeyEvent Key event.

 * @return  ETrue if shift or control is down.

 */

inline TBool IsShiftOrControlDown( const TKeyEvent& aKeyEvent )

    {

    return ( aKeyEvent.iModifiers &

        ( EModifierShift | EModifierLeftShift | EModifierRightShift |

          EModifierCtrl | EModifierLeftCtrl | EModifierRightCtrl ) ) != 0;

    }

/**

 * Phonebook 2 group members transaction.

 * Encapsulates the information that is needed

 * to switch from group to group viewing.

 */

class CGroupMembersViewTransaction : public CBase

    {

    public: // Construction and destruction

        /**

         * Creates new instance of this class.

         *

         * @return  A new instace of this class.

         */

        static CGroupMembersViewTransaction* NewLC();

        /**

         * Destructor

         */

        ~CGroupMembersViewTransaction();

    public: // Interface

        /**

         * Sets group members view.

         *

         * @param aGroupMembersView     Group members view to set.

         */

        void SetGroupMembersView(

                MVPbkContactViewBase* aGroupMembersView );

        /**

         * Set group's name.

         *

         * @param aGroupName        Group name to set.

         */

        void SetGroupName(

                HBufC* aGroupName );

        /**

         * Sets group link.

         *

         * @param aGroupLink Group link to set.

         */

        void SetGroupLink(

                MVPbkContactLink* aGroupLink );

        /**

         * Returns group link.

         *

         * @return  Group link.

         */

        MVPbkContactLink* GroupLink() const;

        /**

         * Returns group link, ownership is transferred.

         *

         * @return  Group link.

         */

        MVPbkContactLink* GetGroupLink();

        /**

         * Returns group name.

         *

         * @return  Group name.

         */

        HBufC* GetGroupName();

        /**

         * Returns group members view.

         *

         * @return  Group members view.

         */

        MVPbkContactViewBase* GroupMembersView() const;

        /**

         * Returns group members view, ownership is transferred.

         *

         * @return  Group members view.

         */

        MVPbkContactViewBase* GetGroupMembersView();

    private: // Implementation

        CGroupMembersViewTransaction();

    private: // Data

        /// Own: Group members view

        MVPbkContactViewBase* iGroupMembersView;

        /// Own: Group name

        HBufC* iGroupName;

        /// Own: Group link

        MVPbkContactLink* iGroupLink;

    };

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

// CGroupMembersViewTransaction::CGroupMembersViewTransaction

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

//

CGroupMembersViewTransaction::CGroupMembersViewTransaction()

    {

    }

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

// CGroupMembersViewTransaction::~CGroupMembersViewTransaction

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

//

CGroupMembersViewTransaction::~CGroupMembersViewTransaction()

    {

    delete iGroupMembersView;

    delete iGroupName;

    delete iGroupLink;

    }

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

// CGroupMembersViewTransaction::NewLC

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

//

CGroupMembersViewTransaction* CGroupMembersViewTransaction::NewLC()

    {

    CGroupMembersViewTransaction* self =

        new ( ELeave ) CGroupMembersViewTransaction;

    CleanupStack::PushL( self );

    return self;

    }

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

// CGroupMembersViewTransaction::SetGroupMembersView

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

//

void CGroupMembersViewTransaction::SetGroupMembersView

        ( MVPbkContactViewBase* aGroupMembersView )

    {

    delete iGroupMembersView;

    iGroupMembersView = aGroupMembersView;

    }

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

// CGroupMembersViewTransaction::SetGroupName

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

//

void CGroupMembersViewTransaction::SetGroupName

        ( HBufC* aGroupName )

    {

    delete iGroupName;

    iGroupName = aGroupName;

    }

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

// CGroupMembersViewTransaction::SetGroupLink

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

//

void CGroupMembersViewTransaction::SetGroupLink

        ( MVPbkContactLink* aGroupLink )

    {

    delete iGroupLink;

    iGroupLink = aGroupLink;

    }

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

// CGroupMembersViewTransaction::GroupLink

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

//

MVPbkContactLink* CGroupMembersViewTransaction::GroupLink() const

    {

    return iGroupLink;

    }

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

// CGroupMembersViewTransaction::GetGroupLink

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

//

MVPbkContactLink* CGroupMembersViewTransaction::GetGroupLink()

    {

    MVPbkContactLink* groupLink = iGroupLink;

    iGroupLink = NULL;

    return groupLink;

    }

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

// CGroupMembersViewTransaction::GetGroupName

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

//

HBufC* CGroupMembersViewTransaction::GetGroupName()

    {

    HBufC* groupName = iGroupName;

    iGroupName = NULL;

    return groupName;

    }

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

// CGroupMembersViewTransaction::GroupMembersView

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

//

MVPbkContactViewBase* CGroupMembersViewTransaction::GroupMembersView() const

    {

    return iGroupMembersView;

    }

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

// CGroupMembersViewTransaction::GetGroupMembersView

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

//

MVPbkContactViewBase* CGroupMembersViewTransaction::GetGroupMembersView()

    {

    MVPbkContactViewBase* groupMembersView = iGroupMembersView;

    iGroupMembersView = NULL;

    return groupMembersView;

    }

} /// namespace

/**

 * Phonebook 2 group members view implementation base class.

 */

class CPguGroupMembersView::CGroupMembersViewImpl :

        public CBase,

        protected MVPbkContactViewObserver

    {

    public: // Interface

        /**

         * Creates control.

         *

         * @param aClientRect   Client's rect.

         */

        virtual void CreateControlL(

                const TRect& aClientRect ) = 0;

        /**

         * Returns the control.

         *

         * @return  Control.

         */

        virtual MPbk2ContactUiControl* Control() = 0;

        /**

         * Return view's state.

         *

         * @return  View state.

         */

        virtual CPbk2ViewState* ViewStateLC() const = 0;

        /**

         * Handles command key

         *

         * @param aKeyEvent     Key event.

         * @param aType         Command type.

         * @return  ETrue if command handled in function, else EFalse.

         */

        virtual TBool HandleCommandKeyL(

                const TKeyEvent& aKeyEvent,

                TEventCode aType ) = 0;

        /**

         * Returns menu filtering flags.

         *

         * @return  The flags.

         */

        virtual TInt GetViewSpecificMenuFilteringFlagsL() const = 0;

        /**

         * Dynamically initialises a menu pane.

         *

         * @param aResourceId   Resource id of the menu.

         * @param aMenuPane     The in-memory representation of

         *                      the menu pane.

         */

        virtual void DynInitMenuPaneL(

                TInt aResourceId,

                CEikMenuPane* aMenuPane ) = 0;

        /**

         * Restores view's state.

         *

         * @param aState    The state to restore.

         */

        virtual void RestoreControlStateL(

                CPbk2ViewState* aState ) = 0;

        /**

         * Handles command,

         *

         * @param aCommand  Id of the command to respond to.

         */

        virtual void HandleCommandL(

                TInt aCommand ) = 0;

        /**

         * Handles a change in the position or size

         * of the screen area occupied by the status pane.

         */

        virtual void HandleStatusPaneSizeChange() = 0;

        /**

         * Handles listbox events in derived classes

         * Note that this is not derived from MEikListBoxObserver but defined here

         */

        virtual void HandleListBoxEventL( CEikListBox* aListBox, TListBoxEvent aEventType ) = 0;

        /**

         * Handles listbox events in derived classes

         * Note that this is not derived from MEikListBoxObserver but defined here

         */

        virtual void ShowContextMenuL() = 0;

        /**

         * Handles pointer events.

         *

         * @param aPointerEvent     The pointer event.

         */

        virtual void HandlePointerEventL(

                const TPointerEvent& aPointerEvent) = 0;

        /**

         * Updates Cba buttons.

         */

        virtual void UpdateCbasL() = 0;

        /**

         * Handles long tap event.

         *

         * @param aPenEventLocation         Pen location

         * @param aPenEventScreenLocation   Pen screen location.

         */

        virtual void HandleLongTapEventL(

                const TPoint& aPenEventLocation,

                const TPoint& aPenEventScreenLocation ) = 0;

    public: // From MVPbkContactViewObserver

        void ContactViewUnavailable(

                MVPbkContactViewBase& aView );

        void ContactAddedToView(

                MVPbkContactViewBase& aView,

                TInt aIndex,

                const MVPbkContactLink& aContactLink );

        void ContactRemovedFromView(

                MVPbkContactViewBase& aView,

                TInt aIndex,

                const MVPbkContactLink& aContactLink );

        void ContactViewError(

                MVPbkContactViewBase& aView,

                TInt aError,

                TBool aErrorNotified );

    public: // Base class interface

        /**

         * Destructor.

         */

        virtual ~CGroupMembersViewImpl()

            {}

    public:

        void SetMarkingModeOn( TBool aMarkingModeOn )

            {

            iMarkingModeOn = aMarkingModeOn;

            }

        TBool IsMarkingModeOn()

            {

            return iMarkingModeOn;

            }

    protected: // Implementation

        CGroupMembersViewImpl() : iMarkingModeOn( EFalse )

            {}

    protected:

        // Flag to indicate whether Marking mode is active

        TBool iMarkingModeOn;

    };

/**

 * Group members view implementation class. This class encapsulates

 * the view implementation when the group members view isnt ready, so

 * all the nesessary information needed to create the group members view

 * isnt ready. This class iniates the all groups view loading and waits

 * for its completion. Up on completion it switches to the next state.

 */

class CPguGroupMembersView::CGroupMembersAllGroupsNotReady :

        public CPguGroupMembersView::CGroupMembersViewImpl

    {

    public: // interface

        /**

         * Creates a new instance of this class.

         *

         * @param aViewParent           Parent view.

         * @param aView                 UI extension view.

         * @param aFocusedGroupLink     Focused groups.

         * @return  A new instance of this class.

         */

        static CGroupMembersAllGroupsNotReady* NewL(

                MPbk2GroupMembersViewActivationCallback& aViewParent,

                CPbk2UIExtensionView& aView,

                const MVPbkContactLink* aFocusedGroupLink );

        /**

         * Destructor.

         */

        ~CGroupMembersAllGroupsNotReady();

    public: // From CGroupMembersViewImpl

        void CreateControlL(

                const TRect& aClientRect );