/*

* Copyright (c) 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:  FreestyleEmailUi double line list visualiser definition

*

*/

#ifndef __FREESTYLEEMAILUI_MAILLISTVISUALISER_H__

#define __FREESTYLEEMAILUI_MAILLISTVISUALISER_H__

// SYSTEM INCLUDES

#include <eikmobs.h>

//<cmail>

#include "fscontrolbarobserver.h"

#include "fstreelistobserver.h"

#include "cfsmailcommon.h"

#include "mfsmaileventobserver.h"

#include "fsccontactactionmenudefines.h"

//</cmail>

#include "FSEmailBuildFlags.h"

#include <touchfeedback.h>

#include <touchlogicalfeedback.h>

// INTERNAL INCLUDES

#include "FreestyleEmailUiViewBase.h"

#include "FreestyleEmailUiListVisualiser.h"

#include "FreestyleEmailUiConstants.h"

#include "FreestyleEmailUiControlBarCallback.h"

#include "FreestyleEmailUiUtilities.h"

#include "FreestyleEmailUiContactHandlerObserver.h"

#include "cmailboxstateext.h"

// FORWARD DECLARATIONS

class CAlfTextVisual;

class CAlfGridLayout;

class CFSEmailUiList;

class CAlfImageVisual;

class CAlfDeckLayout;

class CAlfAnchorLayout;

class CFSEmailUiMailListModelItem;

class CFSEmailUiMailListModel;

class CListModeChanger;

class CFreestyleEmailUiTextureManager;

class CFSMailFolder;

class CFSMailClient;

class CFSMailAddress;

class CFsTreeList;

class CFsTreeVisualizerBase;

class MFsTreeItemData;

class MFsTreeItemVisualizer;

class CFreestyleEmailUiTextureManager;

class CFreestyleEmailUiMailListControl;

class CFreestyleEmailUiAppUi;

class CFsControlBar;

class CFSMailMessage;

class CFsMailFolder;

class CFsTreePlainOneLineNodeData;

class CFsTreePlainOneLineNodeVisualizer;

class MFsControlButtonInterface;

class CPbkxContactActionMenu;

class CMailListUpdater;

class CMsgMovedNoteTimer;

class CIdle;

class CESMRIcalViewer;

class CAknWaitDialog;

class CDateChangeTimer;

class CFsTreePlainTwoLineItemData;

class CFsTreePlainTwoLineItemVisualizer;

class CEUiEmailListTouchManager;

class MFSMailIterator;

class CAknStylusPopUpMenu;

class CFSEmailUiGenericTimer;

template <class T> struct TDeleteTask;

/**

 * CMailListModelUpdater

 *

 * Asynchronous mail list updater.

 *

 */

class CMailListModelUpdater : public CActive

    {

private:

    // Updater state

    enum TState

        {

        // Idle state. Updater is doing nothing.

        EIdle,

        // Initializing state. Get ready for the update.

        EInitialize,

        // Fetching state. Fetch the messages for the model.

        EFetch,

        // Finalizing state. Model update done.

        EFinalize

        };

public:

    // Updater observer

    class MObserver

        {

    public:

        /**

         * Called when an error has occured.

         */

        virtual void UpdateErrorL(TInt aError) = 0;

        /**

         * Called when update begins.

         */

        virtual void UpdateBeginL() = 0;

        /**

         * Called when new messages fetched.

         */

        virtual void UpdateProgressL(TFsTreeItemId& aParentId, RPointerArray<CFSMailMessage>& aMessages) = 0;

        /**

         * Called when update is completed.

         */

        virtual void UpdateCompleteL() = 0;

        /**

         * Update cancelled.

         * @param aForceRefresh If ETrue, model will be fully refreshed on next activation.

         */

        virtual void UpdateCancelled(const TBool aForceRefresh) = 0;

        };

public:

    /**

     * 

     */

    static CMailListModelUpdater* NewL();

    /**

     * Constructor

     */

    CMailListModelUpdater();

    /**

     * Destructor

     */

    ~CMailListModelUpdater();

public:

    /**

     * Reference to sorting criteria array.

     */

    RArray<TFSMailSortCriteria>& Sorting();

    /**

     * Update model.

     */

    void UpdateModelL(MObserver& aObserver, MFSMailIterator* aIterator, TInt aBlockSize);

    /**

     * Returns ETrue if updating.

     */

    TBool IsUpdating() const;

public: // from CActive

    /**

     * @see CActive::RunL

     */

    void RunL();

    /**

     * @see CActive::DoCancel

     */

    void DoCancel();

    /**

     * @see CActive::RunError

     */

    TInt RunError(TInt aError);

private:

    /**

     * Signal self with given error code and set a new state.

     */

    void Signal(TState aState, TInt aError = KErrNone);

    /**

     * Initialize update.

     */

    void InitializeL();

    /**

     * Fetch one step.

     */

    void FetchL();

    /**

     * Finalize update.

     */

    void FinalizeL();

    /**

     * Reset to uninitialized state.

     */

    void Reset();

private:

    void ConstructL();

private:

    RArray<TFSMailSortCriteria> iSorting;

    TFSMailMsgId iId;

    TState iState;

    TInt iItemsFetched;

    MObserver* iObserver;

    MFSMailIterator* iIterator;

    TFsTreeItemId iParentId;

    TInt iBlockSize;

    RTimer iTimer;

    };

struct SMailListItem

	{

	TFsTreeItemId iListItemId;

	MFsTreeItemData* iTreeItemData;

	MFsTreeItemVisualizer* iTreeItemVisualiser;

	};

struct STimeDateFormats

	{

	TDateFormat iDateFormat;

	TChar iDateSeparator;

	TTimeFormat iTimeFormat;

	TChar iTimeSeparator;

	TLocalePos iAmPmPosition;

	};

enum TMailListUiControls

	{

	EControlBarComponent=0,

	EMailListComponent

	};

enum TListControlType

	{

	EListControlTypeSingleLinePreviewOff=0,

	EListControlTypeSingleLinePreviewOn,

	EListControlTypeDoubleLinePreviewOff,

	EListControlTypeDoubleLinePreviewOn

	};

enum TListControlSeparatorValue

	{

	EListControlSeparatorDisabled=0,

	EListControlSeparatorEnabled

	};

// <cmail>

class CFSEmailUiMailListVisualiser : public CFsEmailUiViewBase,

									 public MFsControlBarObserver,

									 public MFSEmailUiFolderListCallback,

									 public MFSEmailUiSortListCallback,

									 public MFsTreeListObserver,

									 public MFSEmailUiContactHandlerObserver,

									 public CMailListModelUpdater::MObserver,

                                     public MEmailMailboxState,

                                     public MFSEmailUiGenericTimerCallback

// </cmail>

	{

friend class CMailListUpdater;

private:

	    // Refresh state

	    enum TRefreshState

	        {

            ERefreshNone,

	        // Full refresh needed. Update model and redraw entire list.

	        EFullRefreshNeeded,

	        // Partial refresh needed.

	        EPartialRefreshNeeded,

	        // Focus to the beginning.

	        EFocusChangeNeeded

	        };

	    // states for sorting timer

	    enum TSortState

	    	{

	    	ESortNone,

	    	ESortRequested,

	    	ESortStarted,

	    	ESortPostponed,

	    	ESortCompleted,

	    	ESortStartError

	    	};

public:

	static CFSEmailUiMailListVisualiser* NewL(CAlfEnv& aEnv, CFreestyleEmailUiAppUi* aAppUi, CAlfControlGroup& aMailListControlGroup);

	static CFSEmailUiMailListVisualiser* NewLC(CAlfEnv& aEnv, CFreestyleEmailUiAppUi* aAppUi, CAlfControlGroup& aMailListControlGroup);

    virtual ~CFSEmailUiMailListVisualiser();

    void PrepareForExit();

	void DynInitMenuPaneL(TInt aResourceId, CEikMenuPane* aMenuPane);

	// Refresh the whole list

	void RefreshL( TFSMailMsgId* aFocusToMessage = NULL );

	// From view

	TUid Id() const;

	// <cmail> Toolbar

	/*void DoActivateL(const TVwsViewId& aPrevViewId,

	                 TUid aCustomMessageId,

	                 const TDesC8& aCustomMessage);*/

    // </cmail> Toolbar

	TInt NewEmailsInModelL() const;

	TInt EmailsInModelL() const;

	CFSEmailUiMailListModel* Model();

	// Current active folder

	TFSMailMsgId FolderId();

	// Dynamic variant switch, called by appui

	void HandleDynamicVariantSwitchL( CFsEmailUiViewBase::TDynamicSwitchType aType );

	void HandleDynamicVariantSwitchOnBackgroundL( CFsEmailUiViewBase::TDynamicSwitchType aType );

	// Handle foregroundevent

	void HandleForegroundEventL( TBool aForeground );

	// Sets softkeys

	void SetViewSoftkeysL( TInt aResourceId );

	void SetMskL();

	// Highlighted index

	TInt HighlightedIndex() const;

	void SetHighlightedIndexL( TInt aWantedIndex );

	// Event handling forwarded from control

	TBool OfferEventL( const TAlfEvent& aEvent );

    // <cmail>

	/**

	 * Open highlighted mail or node.

	 * (Touchwork: Called from touch manager)

	 */

	void DoHandleListItemOpenL();

	/**

     * Open folderlist or shortlist.

     * (Touchwork: Called from touch manager)

     *

     * @param TInt button id. (shortlist or folderlist)

     */

	void DoHandleControlBarOpenL( TInt aControlBarButtonId );

    /**

     * Open action menu.

     * (Touchwork: Called from touch manager)

     */

	void DoHandleListItemLongTapL( const TPoint& aPoint );

    /**

     * Get control which is currently focused.

     * (Touchwork: Called from touch manager)

     *

     * @return TInt id of control

     */

	TInt GetFocusedControl() const;

    /**

     * Set control bar as focused control.

     * (Touchwork: Called from touch manager)

     */

	void SetControlBarFocusedL();

    /**

     * Set tree list as focused control.

     * (Touchwork: Called from touch manager)

     */

	void SetTreeListFocusedL();

    /**

     * Helper function for disable controls to send

     * any events.

     * (Touchwork)

     *

     * @param TBool state of controls.

     */

	void DisableMailList( TBool aValue );

	// </cmail>

	// Command handling

	void HandleCommandL(TInt aCommand);

	// Read status

	void ChangeReadStatusOfHighlightedL( TBool aRead );

	void ChangeReadStatusOfMarkedL( TBool aRead );

	void ChangeReadStatusOfIndexL( TBool aRead, TInt aIndex );

	// Delete messages

	void DeleteMessagesL();

	// Move to drafts

	void MoveMessagesToDraftsL();

	// From base class MFSEmailUiFolderListCallback

	// Handle folder list selection

	void FolderSelectedL( TFSMailMsgId aSelectedFolderId,

	 					 TFSEmailUiCtrlBarResponse aResponse );

	void MailboxSelectedL( TFSMailMsgId aSelectedFolderId );

	TRect FolderButtonRect();

	// From base class MFSEmailUiSortListCallback

	void SortOrderChangedL( TFSMailSortField aSortField,

	 					   TFSEmailUiCtrlBarResponse aResponse );

	TRect SortButtonRect();

	// Update theme colors

	void UpdateThemeL(const TBool aSystemUpdate = ETrue);

	// Navigation functions, used mainly from viewer

	TBool IsNextMsgAvailable( TFSMailMsgId aCurrentMsgId, TFSMailMsgId& aFoundNextMsgId, TFSMailMsgId& aFoundNextMsgFolder ) const;

	TBool IsPreviousMsgAvailable( TFSMailMsgId aCurrentMsgId, TFSMailMsgId& aFoundPreviousMsgId, TFSMailMsgId& aFoundPrevMsgFolder ) const;

	TInt MoveToNextMsgL( TFSMailMsgId aCurrentMsgId, TFSMailMsgId& aFoundNextMsgId );

	TInt MoveToPreviousMsgL( TFSMailMsgId aCurrentMsgId, TFSMailMsgId& aFoundPreviousMsgId );

	TInt MoveToPreviousMsgAfterDeleteL( TFSMailMsgId aFoundPreviousMsgId );

	/**

     * Sets the manual mailbox syncronisation flag if the user chose

     * to synchorise mail box from the menu

     */

    void ManualMailBoxSync( TBool aManualMailBoxSync );

    // Returns ETrue if mailbox is syncronizing and EFalse if not

    TBool GetLatestSyncState();

	void GetMarkedMessagesL( RArray<TFSMailMsgId>& aMessageIDs ) const;

	CFsTreeList& GetMailList();

	// Get message ID corresponding given list ID. If the list ID is for a node, its first child message ID is returned.

	TFSMailMsgId MsgIdFromListId( TFsTreeItemId aListId ) const;

    void HandleMailBoxEventL( TFSMailEvent aEvent, TFSMailMsgId aMailbox,

        TAny* aParam1, TAny* aParam2, TAny* aParam3 );

// from base class MFsTreeListObserver

    /** Handles tree list events. */

    // <cmail> Touch

    void TreeListEventL( const TFsTreeListEvent aEvent,

                         const TFsTreeItemId aId,

                         const TPoint& aPoint );

    // </cmail>

// from base class MFSEmailUiContactHandlerObserver

    /** Handles completed contact handler event. */

    void OperationCompleteL( TContactHandlerCmd aCmd,

        const RPointerArray<CFSEmailUiClsItem>& aContacts );

    void OperationErrorL( TContactHandlerCmd, TInt aError );

    /**

    * Called when CDateChangeTimer completes. This happens when either when date

    * changes or when user alters the system time. Redraws the list to ensure that

    * time stamp texts in emails and nodes are up-to-date.

    */

    void NotifyDateChangedL();

    // Sets aActiveMailboxId and aActiveFolderId from iMailFolder if available

    TInt GetActiveFolderId(TFSMailMsgId& aActiveMailboxId, TFSMailMsgId& aActiveFolderId) const;

    // Creates CMailboxStateExtension with this class set as dataprovider

    void CreateExtensionL();

    // check from settings if manual or auto sync

    TBool CheckAutoSyncSettingL();

public: // from MFSEmailUiGenericTimerCallback

    /**

     * From MFSEmailUiGenericTimerCallback.

     * Generic timer event callback.

     * Handles insertion of new mails into mail list.

     */

    void TimerEventL( CFSEmailUiGenericTimer* aTriggeredTimer );

private: // from

    /**

     * @see CFsEmailUiViewBase::ChildDoActivateL

     */

    void ChildDoActivateL( const TVwsViewId& aPrevViewId,

            TUid aCustomMessageId,

            const TDesC8& aCustomMessage );

    void ChildDoDeactivate();

    void GetParentLayoutsL( RPointerArray<CAlfVisual>& aLayoutArray ) const;

    TFSEmailUiTextures GetSortButtonTextureIndex();

	void FadeOut(TBool aDirectionOut);

    /**

	 * @see CFsEmailUiViewBase::SetStatusBarLayout

	 */

    void SetStatusBarLayout();

private: // Private functions

    CFSEmailUiMailListVisualiser( CAlfEnv& aEnv, CFreestyleEmailUiAppUi* aAppUi,

        CAlfControlGroup& aMailListControlGroup );

    void ConstructL();

	// Refresh funcions

    void InsertNewMessagesL( const RArray<TFSMailMsgId>& aMessages );

    void InsertNewMessageL( CFSMailMessage* aNewMessage, const TBool aAllowRefresh ); // ownership is transferred

    void RefreshListItemsL();

    void RefreshListItemsL(TFsTreeItemId& aLatestNodeId,

        const TInt aStartIndex, const TInt aEndIndex);

    // Refresh the list order only

    void RefreshOrderL();

    // To start refreshing asynchronously

    void RefreshDeferred( TFSMailMsgId* aFocusToMessage = NULL );

    static TInt DoRefresh( TAny* aSelfPtr );

    void CompletePendingRefresh();

    // Create and insert one list node item according to given model item.

    // Omitting the argument aChildIdx causes the new node to be appended at the end of the list.

    TFsTreeItemId InsertNodeItemL( TInt aModelIndex, TInt aChildIndex = KErrNotFound, const TBool aAllowRefresh = EFalse );

    // Create and insert one list item according the given model item. The item is added under the given node.

    // Omitting the argument aChildIdx causes the new item to be appended as last child of the node.

    TFsTreeItemId InsertListItemL( TInt aModelIndex, TFsTreeItemId aParentNodeId, TInt aChildIdx = KErrNotFound, TBool aAllowRefresh = ETrue );