/*

* Copyright (c) 2002-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:  MsgEditorView  declaration

*

*/

#ifndef CMSGEDITORVIEW_H

#define CMSGEDITORVIEW_H

// ========== INCLUDE FILES ================================

#include <coecntrl.h>      // for CCoeControl

#include <aknenv.h>        // for CAknEnv

#include <ItemFinder.h>

#include <ConeResLoader.h>

#include "MsgBaseControlObserver.h"        // for MMsgBaseControlObserver

#include "MsgEditorObserver.h"             // for MMsgEditorObserver

#include "MsgEditor.hrh"                   // for typedefs

// ========== CONSTANTS ====================================

// ========== MACROS =======================================

// ========== DATA TYPES ===================================

// ========== FUNCTION PROTOTYPES ==========================

// ========== FORWARD DECLARATIONS =========================

class MMsgEditorObserver;

class CMsgBaseControl;

class CMsgHeader;

class CMsgBody;

class CMsgFormComponent;

class CEikScrollBarFrame;

class CAknsBasicBackgroundControlContext;

// ========== CLASS DECLARATION ============================

/**

* Defines an API for message editor/viewer view.

*

* @lib MsgEditor.lib

* @since S60 v2.0

*/

class CMsgEditorView : public CCoeControl,

                       public MMsgBaseControlObserver,

                       public MCoeControlObserver,

                       public MEikScrollBarObserver

    {   

    public:

        enum TMsgEditorMode

            {

            EMsgEditorModeNone             = 0x00,

            EMsgEditorModeNormal           = 0x01,

            EMsgReadOnly                   = 0x02,

            EMsgDoNotUseDefaultBodyControl = 0x04

            };

    public:

        /**

        * Factory method.

        * @param aObserver

        * @param aEditorModeFlags

        * @return

        */

        IMPORT_C static CMsgEditorView* NewL( MMsgEditorObserver& aObserver,

                                              TUint32 aEditorModeFlags );

        /**

        * from MObjectProvider

        */

        IMPORT_C MObjectProvider* MopNext();

        /**

        * Destructor.

        */

        IMPORT_C ~CMsgEditorView();

        /**

        * Prepares the editor view for showing it on the screen.

        * @param aRect

        * @param aControlIdForFocus

        */

        IMPORT_C void ExecuteL( const TRect& aRect, TInt aControlIdForFocus );

        /**

        * Finds a control from the header and the body by id and returns a

        * pointer to it. If a control cannot be found, returns NULL.

        * @param aControlId

        * @return

        */

        IMPORT_C CMsgBaseControl* ControlById( TInt aControlId ) const;

        /**

        * Returns a pointer to a focused control. If no control is focused,

        * returns NULL.

        * @return

        */

        IMPORT_C CMsgBaseControl* FocusedControl() const;

        /**

        * Sets focus to a control aControlId.

        * @param aControlId

        */

        IMPORT_C void SetFocus( TInt aControlId );

        /**

        * Constructs a control of type aControlType from resource and adds it

        * to a form component aFormComponent. The control is added to a

        * position aIndex.

        *

        * Leaves with KErrNotFound if aControlType is incorrect.

        *

        * @param aResourceId

        * @param aControlType

        * @param aIndex

        * @param aFormComponent

        * @return

        */

        IMPORT_C TInt AddControlFromResourceL( TInt aResourceId,

                                               TInt aControlType,

                                               TInt aIndex,

                                               TMsgFormComponent aFormComponent );

        /**

        * Adds a control given by aControl to a form component aFormComponent.

        * The control is added to a position aIndex with control id aControlId.

        *

        * @param aControl

        * @param aControlId

        * @param aIndex

        * @param aFormComponent

        */

        IMPORT_C void AddControlL( CMsgBaseControl* aControl,

                                   TInt aControlId,

                                   TInt aIndex,

                                   TMsgFormComponent aFormComponent );

        /**

        * Removes the control aControlId from the header or the body and returns

        * pointer to it. If a control cannot be found, returns NULL.

        *

        * @param aControlId

        * @return

        */

        IMPORT_C CMsgBaseControl* RemoveControlL( TInt aControlId );

        /**

        * Removes and deletes the control aControlId from the header or the body if found.

        *

        * @param aControlId Control ID of the deleted control.

        */

        IMPORT_C void DeleteControlL( TInt aControlId );

        /**

        * Returns a reference to a form component.

        * @param aFormComponent

        * @return

        */

        IMPORT_C CCoeControl& FormComponent( TMsgFormComponent aFormComponent ) const;

        /**

        * Prepares the editor view for viewing it on the screen after screen

        * size change.

        * @param aRect

        */

        IMPORT_C void HandleScreenSizeChangeL( const TRect& aRect );

        /**

        * Resets (= clears) all controls.

        */

        IMPORT_C void ResetControls();

        /**

        * Resets (= clears) controls from header or body.

        * @param aFormComponent EMsgHeader or EMsgBody

        */

        IMPORT_C void ResetControls( TMsgFormComponent aFormComponent );

        /**

        * Checks if any control owned by view is modified.

        * @return ETrue if modified, EFalse if not.

        */

        IMPORT_C TBool IsAnyControlModified() const;

        /**

        * Updates modified flag of controls owned by view.

        * Call this with EFalse when you have populated controls to reset the

        * modifed flag.

        * @param aFlag ETrue or EFalse

        */

        IMPORT_C void SetControlsModified( TBool aFlag );

        inline void SetScrollParts( TInt aScrollParts );

        inline void SetCurrentPart( TInt aCurrentPart );

        /**

        * Returns used item finder pointer if any.

        *

        * @return CItemFinder pointer if item finder is used.

        *         NULL otherwise

        */        

        IMPORT_C CItemFinder* ItemFinder();

        /**

        * Sets edwin observer.

        * Edwin observer is added to every text editor control that currently exists

        * or is added after this call to the view.

        * 

        * aObserver IN Edwin observer. 

        *              Setting observer to NULL will remove the edwin observer.

        */

        IMPORT_C void SetEdwinObserverL( MEikEdwinObserver* aObserver );

    public:   // from CCoeControl

        /**

        * Handles key events.

        * @param aKeyEvent

        * @param aType

        * @return

        */

        IMPORT_C TKeyResponse OfferKeyEventL(

            const TKeyEvent& aKeyEvent,

            TEventCode       aType);

        /**

        * For handling dynamic layout switch.

        */

        void HandleResourceChange( TInt aType );

        /**

        * From CCoeControl. See coecntrl.h

        */

        void HandlePointerEventL( const TPointerEvent& aPointerEvent );

    public:  // from MMsgBaseControlObserver

        /**

        * Returns whether view is intialized.

        */

        TBool ViewInitialized() const;

        /**

        * Returns the current view rectangle.

        * @return

        */

        TRect ViewRect() const;

        /**

        * Handles an event from a control.

        * @param aControl

        * @param aRequest

        * @param aDelta

        * @return

        */

        TBool HandleBaseControlEventRequestL( CMsgBaseControl* aControl,

                                              TMsgControlEventRequest aRequest,

                                              TInt aDelta );

        /**

        * Handles an event from a control.

        * @param aControl

        * @param aRequest

        * @return

        */

        TBool HandleBaseControlEventRequestL( CMsgBaseControl* aControl,

                                              TMsgControlEventRequest aRequest );

        /**

        * Handles an event from a control.

        * @param aControl

        * @param aRequest

        * @param aArg1

        * @param aArg2

        * @param aArg3

        * @return

        */

        TInt HandleEditObserverEventRequestL( const CCoeControl* aControl,

                                              TMsgControlEventRequest aRequest,

                                              TAny* aArg1 = 0,

                                              TAny* aArg2 = 0,

                                              TAny* aArg3 = 0 );

     public: // New methods, from MObjectProvider

    	IMPORT_C TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

    public: // from MEikScrollBarObserver

	    /**

	    * Handles scroll events

	    * 

	    * @param aScrollBar Pointer to the originating scroll bar object.

	    * @param aEventType A scroll event

	    */

	    void HandleScrollEventL( CEikScrollBar* aScrollBar, TEikScrollEvent aEventType );

    protected:   // from CCoeControl

        /**

        * Returns a number of controls.

        * @return

        */

        TInt CountComponentControls() const;

        /**

        * Returns a control of index aIndex.

        * @param aIndex

        * @return

        */

        CCoeControl* ComponentControl( TInt aIndex ) const;

        /**

        * Sets new position for all the controls.

        */

        void SizeChanged();

        /**

        * This is called when the focus of the control is changed.

        * @param aDrawNow

        */

        void FocusChanged( TDrawNow aDrawNow );

        /**

        * Draw

        */

    	void Draw( const TRect& aRect ) const;

    protected:  // from MCoeControlObserver

        /**

        * Handle control event.

        * @param aControl

        * @param aEventType

        */

        void HandleControlEventL( CCoeControl* aControl, TCoeEvent aEventType );

    private:

        enum TMsgFocus

            {

            EMsgNoneFocused,

            EMsgHeaderFocused,

            EMsgBodyFocused

            };

    private:

        /**

        * Constructor.

        * @param aObserver

        * @param aEditorModeFlags

        */

        CMsgEditorView( MMsgEditorObserver& aObserver, TUint32 aEditorModeFlags );

        /**

        * 2nd phase constructor.

        */

        void ConstructL();

        /**

        * Creates the header.

        */

        void CreateHeaderL();

        /**

        * Creates the body. Creates also the default body control if requested

        * in editor mode flags in constructor.

        */

        void CreateBodyL();

        /**

        * Creates the scroll bar.

        */

        void CreateScrollBarL();

        /**

        * Updates the scroll bar.

        */

        void UpdateScrollBarL();

        /**

        * Return virtual height and virtual Y position of the form.

        * @param aHeight

        * @param aPos

        */

        void GetVirtualFormHeightAndPos( TInt& aHeight, TInt& aPos );

        /**

        * Sets sizes for the header and the body and returns their total size

        * aSize as a reference. The function does not set new sizes for the

        * controls if the aInit argument is EFalse. If aInit == ETrue, this

        * function sets the size so that only a total height can change.

        *

        * @param aSize

        * @param aInit

        */

        void SetAndGetSizeL( TSize& aSize, TBool aInit );

        /**

        * Sets the positions for the controls and re-draws the view.

        */

        void RefreshViewL();

        /**

        * Prepares controls for viewing.

        * @param aEvent

        * @param aParam

        */

        void NotifyControlsForEvent( TMsgViewEvent aEvent, TInt aParam );

        /**

        * Sets focus to a control aControlId.

        * @param aControlId

        */

        void SetFocusByControlIdL( TInt aControlId,  

                                   TBool aCorrectFormPosition = ETrue,

                                   TBool aSetCursorPos = ETrue );

        /**

        * Does an actual add operation for the control by setting all the

        * necessary observers etc.

        *

        * @param aControl

        * @param aControlId

        * @param aIndex

        * @param aFormComponent

        */

        void DoAddControlL( CMsgBaseControl* aControl,

                            TInt aControlId,

                            TInt aIndex,

                            TMsgFormComponent aFormComponent);

        /**

        * Rotates focus up or down depending aDirection argument.

        * Returns ETrue if operation can be done.

        *

        * @param aDirection

        * @param aFocusEvent

        * @return

        */

        TBool RotateFocusL( TMsgFocusDirection aDirection,

                            MMsgEditorObserver::TMsgFocusEvent& aFocusEvent );

        /**

        * Ensures that the cursor is visible on the view and that the form

        * position is correct.

        *

        */

        TBool EnsureCorrectFormPosition( TBool aScrollDown, TBool aScrollUp = EFalse );

        /**

        * Handles the form's height change. Gets pointer aControl to a control

        * which height is changing. If aDeltaHeight > 0 the height is increasing.

        *

        * @param aControl

        * @param aDeltaHeight

        * @return

        */

        TBool HandleHeightChangedL( CMsgBaseControl* aControl, TInt aDeltaHeight );

        /**

        * Scrolls the form up or down depending given amount of pixels. 

        *

        * @param aDelta              Delta of pixels to move. If aDelta > 0,

        *                            the form is scrolled downward.

        * @param aUpdateScrollBarPos Indicates whether scroll bar focus position 

        *                            should be updated inside this function.

        *

        * @return ETrue if requested pixels where scrolled. Otherwise EFalse.

        */

        TBool ScrollForm( TInt aDelta, TBool aUpdateScrollBarPos );

        /**

        * Sets view rect.

        * @param aRect

        */

        void SetViewRect( const TRect& aRect );

        /**

        * Sets proper distances between controls to obey LAF coordinates.

        */

        void AdjustComponentDistances();

        /**

        * Sets all controls initialized.

        */

        void SetComponentsInitialized();

        /**

        *

        */

        TBool SetAfterFocusL( MMsgEditorObserver::TMsgAfterFocusEventFunc aAfterFocus );

        /**

        * Determines whether given control is fully visible on the screen.

        *

        * @return ETrue if fully visible.

        *         EFalse if not fully visible.

        */

        TBool ControlFullyVisible( CMsgBaseControl* aControl ) const;

        /**

        * Resolves next focusable control when given form is navigated to 

        * certain direction. 

        *

        * @param aFormComponent Form component that is navigated 

        *                       (i.e. either header or body)

        * @param aStart         Control ID of control where search should be started.

        * @param aDirection     Navigation direction.