/*

* Copyright (c) 2006 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:  Implementation class for MCAMainViewArrayPC, to decide how to fill the

*				 single view array decorator

*

*/

#ifndef CCAMAINVIEWARRAYPC_H

#define CCAMAINVIEWARRAYPC_H

#include <e32base.h>

//Forward Declaration

class MCAContactListModel;

class MCAArrayItemPC;

class CCAEngine;

class MCAInvite;

class MCAInvitation;

class MCAServerContactsArrayPC;

class MCAStoredGroup;

class CCAGroupListArrayPC;

class MCASingleListViewCB;

class MCAStoredGroups;

#include "MCAMainViewObserverManagerPC.h"

#include "MCAMainViewObserverPC.h"

#include "MCAStoredContactsObserver.h"

#include "MCAMainViewArrayPC.h"

#include "MCAWatcherObserver.h"

#include "MCAStoredContacts.h"

#include "MCAChatInterface.h"

#include "ChatDefinitions.h"

#include "MCASettingsObserver.h"

#include "MCAInviteObserver.h"

#include "MCASettingsPC.h"

#include "MCAChatObserver.h"

#include "MWVSettingsObserverng.h"

#include "MCAStoredGroupsObserver.h"

#include "MCASyncObserverPC.h"

#include <MIMPSSAPObserver.h>

#include <CIMPSSAPSettingsStore.h>

#include <cimpspresenceconnectionuing.h>

#include "MCAListInitObserver.h"

class CCAMainViewArrayPC:   public CBase,

            public MCAMainViewArrayPC,  // this class own interface.

            public MCASettingsObserver,	// events from engine.

            public MCAStoredGroupsObserver, // events from engine.

            public MCAMainViewObserverManagerPC,

            public MCAWatcherObserver,

            public MCAInviteObserver,

            public MCAChatObserver,

            // This callback is required when ever the server is added or deleted

            // we get a callback and update the singlelist

            public MIMPSSAPObserver,

            public MCAListInitObserver,

            public MCAStoredContactsObserver

    {

    public:

        struct TArrayPairs // Struct to hold identification and buffer

            {

            TBuf<KMaxWVIDLength> iIdentification;

            MCAMessagesReadInterface* iReadInterface;

            };

        struct TInvitationArray // Struct to hold identification and buffer

            {

            TDesC* iUserID;

            TDesC* iMessage;

            };

    public: //Constructor and Destructors

        /**

        * construction

        */

        void ConstructL();

        /**

        * construction

        * @param aContactListModel : a reference to the contact list model object at the chat engine

        */

        static CCAMainViewArrayPC* NewL( CCAEngine& aEngine,

                                         MCAContactListModel& aContactListModel,

                                         MCAChatInterface& aChatInterface );

    private:

        /**

        * default constructor

        * @param aContactListModel : a reference to the contact

        * list model object at the chat engine

        */

        CCAMainViewArrayPC( CCAEngine& aEngine,

                            MCAContactListModel& aContactListModel,

                            MCAChatInterface& aChatInterface );

    public:

        /**

         * virtual destructor

         */

        virtual ~CCAMainViewArrayPC();

    public: // From MCAMainViewArrayPC

        /**

         * Gets the details of the given index

         * like aItemId, aListId,aItemType.

         * @return the structure filled with tha above details.

         */

        TCAItemDetails GetArrayItemIdDetails( TInt aIndex );

        /**

         * Gets the Index, given item details

         * like aItemId, aListId,aItemType.

         * @return the index

         */

        TInt GetArrayItemIdIndexL( const TCAItemDetails& aItemDetails );

        /**

         * @return returns ETrue if any contact is found in contactlists

         * else returns EFalse if no contact is found

         */

        TBool IsAnyContactFound();

        /**

         * Populate the group array iGroupArray with groups

         */

        void  PopulateGroupsListL();

        /**

        * SetSkipStorageEvents: Called by UI component to set flag for skipping storage events

        * @param aSkip : A flag to check whether to skip strage events or not

        * @return void

        */

        virtual void SetSkipStorageEvents( TBool aSkip );

        /**

        * GetSkipStorageEvents: Called by UI component to get the flag for skipping storage events

        * @return boolean

        */

        virtual TBool GetSkipStorageEvents();

        /**

        * Count: Called by UI components to get total count of array

        * @return integer: Count of array

        */

        virtual TInt Count() const;

        /**

        * GetType: Function to get the type of list item

        * @param aIndex: index of the list item

        * @return TEnumsPC::TItem: type of the list item as EContactItem, EOwnStatusItem etc

        */

        virtual TEnumsPC::TItem GetType( TInt aIndex ) const;

        /**

        * IsCollapsed: To find if the list box item is collapsed

        * @param aIndex: index of the list item

        * @return bool: True if the list item is collapsed else false.

        */

        virtual TBool IsCollapsed( TInt aIndex ) const;

        /**

        * IsMsgPending: To find if there are any pending messages to

        *				decide the icons for display

        * @param aIndex: index of the list item

        * @return bool: True if there are pending messages else false.

        */

        virtual TBool IsMsgPending( TInt aIndex ) ;

        /**

        * IsBlocked: To find if the list item is a blocked contact

        * @param aIndex: index of the list item

        * @return bool: True if the list item is a blocked contact else false

        */

        virtual TBool IsBlocked( TInt aIndex ) const;

        /**

        * ForceExpanded: To expand or collapse all the list items

        * @param aAllExpanded: True if all items have to be expanded else false

        * @return bool: True if there are pending messages else false.

        */

        virtual void ForceExpanded( TBool aAllExpanded );

        /**

        * IsForceExpanded: To find if all the list items have been force expanded

        * @return bool: True if all the list items are force expanded else false

        */

        virtual TBool IsForceExpanded() const;

        /**

        * GetOnlineStatus: To get the online status of the list item as Online, Away, Busy etc

        * @param aIndex: Index of the list item

        * @return TEnumsPC::TOnlineStatus

        */

        virtual TEnumsPC::TOnlineStatus GetOnlineStatus( TInt aIndex );

        /**

        * SetCollapsed: To set the list item to a collapsed or expanded state

        * @param aStatus: The collapsed or expanded state to be set for the list item

        * @param aIndex: Index of the list item whose state has to be set

        * @return void

        */

        virtual void SetCollapsed( TBool aStatus, TInt aIndex );

        /**

        * SetSelected:

        * @param aSelected: selected or not

        * @return aIndex ,given index

        */

        virtual void SetSelected( TBool aSelected, TInt aIndex );

        /**

        * GetSelectedL: get the selcetd

        * @param aSelectedContact: selected conatct

        * @param aSelectedIdentifications

        * @return aFilter

        */

        virtual void GetSelectedL( CDesCArray& aSelectedContact,

                                   CDesCArray* aSelectedIdentifications,

                                   TEnumsPC::TFilterType aFilter );

        /**

         * Sets the selectionmode

         * @param aSelectionMode to be set

         * @param aSelectedListIndex - selected contactlist index - used for

         * group creation using existing contact list to get all the contacts in that

         * contact list

         */

        void SetContactSelectionL( TEnumsPC::TListSelectionType aSelectionMode,

                                   TInt aSelectedListIndex );

        /**

         * Resets the selectionmode

         */

        void ResetContactSelectionL();

        /**

         * Returns index for given invitation

         * @param aIndex

         * @return index of invitation

         */

        TInt GetItemEngineIndex( TInt aIndex ) const;

        /**

         * Sets the focus to the owndata on logout.

         */

        virtual void SetCurrentItemIndexL( TBool aFreshLogin = EFalse  );

        /**

        * Find any contact which id is aContactId

        * @param aContactId Contactid to recognize contact.

        * @return ETrue if contact found else EFalse

        */

        TBool FindAnyContactL( const TDesC& aContactId );

        /**

         * Appends the received invitation to the top of the array

         * @param aInvitation

         */

        void AddInvitation( const MCAInvitation* aInvitation );

        /**

         * Returns index of invitation for given wvid and

         * Deletes item from array.

         * @since 3.2

         * @param Index of invitation

         * @return index at which the invite has been deleted.

         */

        virtual TInt FindInvitationAndDelete( const TDesC& aInviteID /*TInt aIndex*/ );

        virtual TInt FindInvitationAndDelete( TInt aIndex );

        /**

         * SetMsgPending: To set the pending messages for a list item

         * @param aPendingMsgs: The no. of pending messages to be set for the list item

         * @param aIndex: Index of the list item

         * @return void

         */

        virtual void SetMsgPending( TInt aPendingMsgs, TInt aIndex );

        /**

         * SetBlocked: To set the blocked status of a list item of type contact

         * @param aStatus: The blocked status  to be set for the list item

         * @param aIndex: Index of the list item whose status has to be set

         * @return void

         */

        virtual void SetBlocked( TBool aStatus, TInt aIndex );

        /**

         * SetOnlineStatus: To set the online status of a list item

         * @param aStatus: The online status to be set for the list item

         * @param aIndex: Index of the list item whose status has to be set

         * @return void

         */

        virtual void SetOnlineStatus( TEnumsPC::TOnlineStatus aStatus, TInt aIndex );

        /**

         * GetItemNameText: To get item name of each list item

         * @param aIndex: Index of the list item whose name is to be returned

         * @return TPtrC: Name of the list item

         */

        virtual TPtrC GetItemNameText( TInt aIndex );

        /**

         * GetFormattedItemNameTextL: To set/rename item name of each list item

         * @param aIndex: Index of the list item whose name is to be changed/set

         * @return TPtr: Error code to check if the name has been set

         */

        virtual TPtr GetFormattedItemNameTextL( TInt aIndex );

        /**

         * ClearArray: clear everything in the array

         * @return void

         */

        virtual void ClearArray( TBool aClearOpenChatsArray );

        /** ResetArray: reset the array,clear and fill with the new data in the array

         * @return void

         */

        virtual void ResetArray( TBool aClearOpenChatsArray );

        /**

         * SetDefaultFilter: To set the default filters of each item

         * @param aMyFilter: TEnumsPC::TFilterType to be set

         * @return void

         */

        virtual void SetDefaultFilter( TEnumsPC::TFilterType aMyFilter );

        /**

        * ResetDefaultFilter: To reset the default filters of each item

        * @return void

        */

        virtual void ResetDefaultFilter();

        /**

         * GetDefaultFilter: To get the default filters of list item

         * @return TEnumsPC::TFilterType: type of filter

         */

        virtual TEnumsPC::TFilterType GetDefaultFilter() const;

        /**

         * Should the model show "All" item in beginning

         * of each contact list.

         * @param aShow If ETrue, first item in every contact list is "All"

         */

        void ShowAll( TBool aShow );

        /**

        * ClientType: To get the client type of list item at given index

        * @return TEnumsPC::TClientType: type of client

        */

        virtual TEnumsPC::TClientType ClientType( TInt aIndex );

        /**

        * Selected: To know if the list item at given index is selected currently

        * @param aIndex: index of list item

        * @return bool: true if the list item at given index is selected currently else false

        */

        virtual TBool Selected( TInt aIndex );

        /**

        * IsWatched: To get the status on whether the list item at given index is

        * being watched for notifications on that contacts online status changes

        * @param aIndex: index of list item

        * @return bool: true if the contact is being watched else false

        */

        virtual TBool IsWatched( TInt aIndex );

        /**

        * AddWatcher: To add watcher to presence

           */

        virtual void AddWatcherL( TPtrC contact/*wvid*/ );

        /**

        * RemoveWatcher: To remove watcher from presence

        *

        */

        virtual void RemoveWatcherL( TPtrC contact/*wvid*/ );

        /**

        * Refreshes friends-storage presence data.

        */

        virtual void RefreshFriendsL();

        /**

         * Clears all selected-flags

         */

        virtual void ClearSelectedL( );

        /**

        * Places all friends to aUsers array

        */

        /* Places all friends (from aUserList) that are online to aOnlineList

        * and users that are offline to aOfflineList.

        * @param aUserList List of users, whose presence data is to be fetched.

        * @param aOnlineList List of users, that are online, can be NULL.

        * @param aOfflineList List of users, that are offline, can be NULL.

        * @param aUpdateStorage If ETrue, contact storage flags are updated

        */

        virtual void GetOnlineUsersL(

            const CDesCArray *aUsers,

            CDesCArray* aOnlineList,

            CDesCArray* aOfflineList,

            TBool aUpdateStorage = EFalse ) ;

        /**

        * Synchronised: To get the synchronised status for the list item

        * @param aIndex: index of list item

        * @return TEnumsPC::TSyncStatus: the synchronization status of the list item

        */

        virtual TEnumsPC::TSyncStatus Synchronised( TInt aIndex );

        /**

        * IsAllSynchronised: To get the synchronised status of all the list items

        * @return TEnumsPC::TSyncStatus: the synchronization status of all the items

        */

        virtual TEnumsPC::TSyncStatus IsAllSynchronised();

        /**

         * Changes client own presence status, and sets status message

         * @param aStatus Presence status -online,oflline etc

         * @param aStatusMessage Presence status message

         * @return Error code.

         */

        TInt ChangeStatusL( TEnumsPC::TOnlineStatus aStatus,

                            const TDesC& aStatusMessage ) ;

        /**

         * Changes presence status message

         * @param aStatusMessage Presence status message

         * @return Operation error.

         */

        TInt ChangeStatusMessageL( const TDesC& aStatusMessage ) ;

        /**

        * StatusL: To get the own status like Online, Away, Busy etc

        * @return TEnumsPC::TOnlineStatus

        */

        TEnumsPC::TOnlineStatus StatusL();

        /**

        * GetOwnStatusConverter: To get TEnumsPC:TOnlineStatus type of enum from

        * the presence side MCAPresence::TPresenceStatus enums for own status

        * @param aPresenceStatus: presence side MCAPresence::TPresenceStatus enums

        * @return TEnumsPC::TOnlineStatus

        */

        TEnumsPC::TOnlineStatus GetOwnStatusConverter(

            MCAPresence::TPresenceStatus  aPresenceStatus );

        /**

         * Fills aOnlineList with the user id's from friends-list that are

         * online.

         * @param aOnlineList List that will be populated with online friends.

         * @param aFetchFromNetwork Fetch presence information from network

         */

        void GetOnlineContactsL( CDesCArray& aOnlineList,

                                 TBool aFetchFromNetwork = EFalse );

        /**

         * RegisterObserverL: To add the UI component as an observer to listen to the

         * event from the MainViewArrayPC

         * @see MCAListInitObserver

         * @return void

         */

        void RegisterObserverL( MCAListInitObserver* aObserver ) ;

        /**

        * UnRegisterObserverL: To remove form the listener

        * @see MCAListInitObserver

        * @return void

        */

        void UnRegisterObserverL() ;

        /**

        * AIsListInitializationCompleteL:

        * @return Bool value

        */

        TBool IsListInitializationCompletedL() ;

        /**

         * Refresh the conversation item in openchats to

         * reflect the changes upon addation/chang/deletion of a contact

         * @param aContactId: userId whose nickname is changed.

         */

        void RefreshConversationItemText( const TDesC& aContactId );

        /**

         * Refresh the Invitation item in openchats to

         * reflect the changes upon addation/chang/deletion of a contact

         * @param aContactId: userId whose nickname is changed.

         */

        void RefreshInvitationItemTextL( const TDesC& aContactId );

    public: // From MCAMainViewObserverManagerPC

        /**

        * AddObserverL: To add the UI component as an observer to listen to the

        *               event from the MainViewArrayPC

        * @see MCAMainViewObserverManagerPC

        * @return void