/*

* 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 implementation*

*/

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

#include <eikenv.h>                        // for CEikonEnv

#include <eikappui.h>                      // for CEikAppUi

#include <barsread.h>                      // for TResourceReader

#include <eikrted.h>                       // for CEikRichTextEditor

#include <eikscrlb.h>

#include <AknUtils.h>                      // for AknUtils

#include <txtrich.h>                       // for automatic highlight

#include <aknappui.h>

#include <applayout.cdl.h>                  // LAF

#include <aknlayoutscalable_apps.cdl.h>

#include <bautils.h>                        // NearestLanguageFile

#include <data_caging_path_literals.hrh>

#include <aknnavi.h>

#include <aknnavide.h>

#include <AknStatuspaneUtils.h>

#include <AknsBasicBackgroundControlContext.h>  // for skins support    

#include <AknsDrawUtils.h>

#include <MsgEditorAppUi.rsg>

#include <StringLoader.h>

#include "MsgEditorCommon.h"               //

#include "MsgEditorView.h"                 // for CMsgEditorView

#include "MsgEditorObserver.h"             // for MMsgEditorObserver

#include "MsgHeader.h"                     // for CMsgHeader

#include "MsgBody.h"                       // for CMsgBody

#include "MsgExpandableControl.h"          // for MsgExpandableControl

#include "MsgBodyControl.h"                // for MsgBodyControl

#include "MsgAddressControl.h"             // for MsgAddressControl

#include "MsgAttachmentControl.h"          // for MsgAttachmentControl

#include "MsgAddressControlEditor.h"       // for MsgAddressControlEditor

#include "MsgEditorPanic.h"                // for MsgEditor panics

#include "MsgEditorLogging.h"

// ========== EXTERNAL DATA STRUCTURES =====================

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

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

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

// ========== LOCAL CONSTANTS AND MACROS ===================

const TInt KMsgControlIndexHeader = 0;

const TInt KMsgControlIndexBody = 1;

const TInt KMsgNumberOfControls = 2;

const TInt KMsgMaximumScrollPartLength = 64;

_LIT( KMsgEditorAppUiResourceFileName, "msgeditorappui.rsc" );

// ========== MODULE DATA STRUCTURES =======================

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

// ========== LOCAL FUNCTIONS ==============================

// ========== MEMBER FUNCTIONS =============================

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

// CMsgEditorView::CMsgEditorView

//

// Constructor.

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

//

CMsgEditorView::CMsgEditorView( MMsgEditorObserver& aObserver,

                                TUint32 aEditorModeFlags ): 

    iEditorObserver( aObserver ),

    iCurrentFocus( EMsgNoneFocused ),

    iEditorModeFlags( aEditorModeFlags ),

    iLineHeight( MsgEditorCommons::MsgBaseLineDelta() ),

    iBaseLineOffset( MsgEditorCommons::MsgBaseLineOffset() ),

    iResourceLoader( *iCoeEnv )

    {

    }

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

// CMsgEditorView::ConstructL

//

// Constructs the editor view by creating the window, the header and the body.

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

//

void CMsgEditorView::ConstructL()

    { 

    CreateWindowL();

    if ( AknStatuspaneUtils::FlatLayoutActive() )

        {

        CEikStatusPane* statusPane = iEikonEnv->AppUiFactory()->StatusPane();

        if ( statusPane )

            {

            CAknNavigationControlContainer* naviPane = 

                static_cast<CAknNavigationControlContainer*>( statusPane->ControlL( 

                                                              TUid::Uid( EEikStatusPaneUidNavi ) ) );

            if ( naviPane )

                {

                naviPane->SetPreferredNaviDecoratorLayoutStyle( 

                                CAknNavigationDecorator::ENaviControlLayoutNormal );

                }

            }

        }

    iBgContext = CAknsBasicBackgroundControlContext::NewL( KAknsIIDQsnBgAreaMainMessage, 

                                                           Rect(), 

                                                           EFalse );

    // T9: Add control to stack to make FEP work. View does not accept key

    //     events from CT9FepControl::HandleChangeInFocus(). Key events are

    //     handled first by editor app ui which routes them to view.

    iEikonEnv->EikAppUi()->AddToStackL( this, 

                                        ECoeStackPriorityDefault, 

                                        ECoeStackFlagRefusesAllKeys );

    Window().SetShadowDisabled( ETrue );

    // Disables automatic background color drawing

    // on window server.

    Window().SetBackgroundColor();    

    CreateScrollBarL();

    CreateHeaderL();

    CreateBodyL();

    }

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

// CMsgEditorView::~CMsgEditorView

//

// Destructor.

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

//

EXPORT_C CMsgEditorView::~CMsgEditorView()

    {

    iEikonEnv->EikAppUi()->RemoveFromStack( this );

    delete iHeader;

    delete iBody;

    delete iScrollBar;

    delete iBgContext;

    iResourceLoader.Close();

    delete iScrollPopText;

    }

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

// CMsgEditorView::NewL

//

// Factory method.

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

//

EXPORT_C CMsgEditorView* CMsgEditorView::NewL( MMsgEditorObserver& aObserver,

                                               TUint32 aEditorModeFlags )

    {

    CMsgEditorView* self = new( ELeave ) CMsgEditorView( aObserver, aEditorModeFlags );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

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

// CMsgEditorView::MopNext

//

// From MObjectProvider.

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

//

EXPORT_C MObjectProvider* CMsgEditorView::MopNext()

    {

    return iEikonEnv->EikAppUi();

    }

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

// CMsgEditorView::ExecuteL

//

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

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

//

EXPORT_C void CMsgEditorView::ExecuteL( const TRect& aRect,

                                        TInt aControlIdForFocus )

    {

    TRect rect( aRect );

    rect.iBr.iY = rect.iTl.iY + MsgEditorCommons::EditorViewHeigth();

    AdjustComponentDistances();

    SetViewRect( rect );

    iSize = rect.Size();

    // Set initial size for controls.

    TSize editorSize( rect.Size() );

    SetAndGetSizeL( editorSize, ETrue ); 

    // Enable here so that size affecting events are processed 

    // from header & body controls after this point.

    iStateFlags |= EMsgStateInitializing;

    SizeChanged();

    ActivateL();

    iScrollParts = 1;

    iEditorObserver.EditorObserver( MMsgEditorObserver::EMsgScrollParts,

                                    &iScrollParts,

                                    NULL,

                                    NULL );

    if ( aControlIdForFocus != EMsgComponentIdNull )

        {

        SetFocusByControlIdL( aControlIdForFocus );

        }

    if ( aControlIdForFocus == EMsgComponentIdNull ||

         iCurrentFocus == EMsgNoneFocused )

        {

        iCurrentFocus = EMsgHeaderFocused;

        TInt newFocus = iHeader->FirstFocusableControl( 0, EMsgFocusDown );

        if ( newFocus == KErrNotFound )

            {

            iCurrentFocus = EMsgBodyFocused;

            newFocus = iBody->FirstFocusableControl( 0, EMsgFocusDown );

            if ( newFocus == KErrNotFound )

                {

                iCurrentFocus = EMsgNoneFocused;

                }

            else

                {

                iBody->ChangeFocusTo( newFocus, ENoDrawNow );

                }

            }

        else

            {

            iHeader->ChangeFocusTo( newFocus, ENoDrawNow );

            }

        }

    UpdateScrollBarL();

    SetComponentsInitialized();

    iStateFlags &= ~EMsgStateInitializing;

    iStateFlags |= EMsgStateInitialized;

    // Has to be called after EMsgStateInitialized flag is set on since

    // otherwise control that have suppress text formatting are not 

    // resized correctly.

    NotifyControlsForEvent( EMsgViewEventPrepareForViewing, 0 );

    DrawNow();

    iCoeEnv->WsSession().Flush();

    }

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

// CMsgEditorView::ControlById

//

// Finds a control from the header and the body by id and returns a pointer to it.

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

//

EXPORT_C CMsgBaseControl* CMsgEditorView::ControlById( TInt aControlId ) const

    {

    __ASSERT_DEBUG( iHeader != NULL, Panic( EMsgHeaderNotExists ) );

    __ASSERT_DEBUG( iBody != NULL, Panic( EMsgBodyNotExists ) );

    CMsgBaseControl* component = iHeader->Component( aControlId );

    if ( !component )

        {

        component = iBody->Component( aControlId );

        }

    return component;

    }

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

// CMsgEditorView::FocusedControl

//

// Returns a pointer to a focused control. If no control is focused, returns NULL.

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

//

EXPORT_C CMsgBaseControl* CMsgEditorView::FocusedControl() const

    {

    __ASSERT_DEBUG( iHeader != NULL, Panic( EMsgHeaderNotExists ) );

    __ASSERT_DEBUG( iBody != NULL, Panic( EMsgBodyNotExists ) );

    if ( iCurrentFocus == EMsgHeaderFocused )

        {

        return iHeader->FocusedControl();

        }

    else if ( iCurrentFocus == EMsgBodyFocused )

        {

        return iBody->FocusedControl();

        }

    else

        {

        return NULL;

        }

    }

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

// CMsgEditorView::SetFocus

//

// Sets focus to a control aControlId.

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

//

EXPORT_C void CMsgEditorView::SetFocus( TInt aControlId )

    {

    __ASSERT_DEBUG( iStateFlags & EMsgStateInitialized,

                    Panic( EMsgFunctionCalledBeforeInitialization ) );

    TRAP_IGNORE( 

        {

        SetFocusByControlIdL( aControlId );

        UpdateScrollBarL();

        } );

    }

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

// CMsgEditorView::AddControlFromResourceL

//

// 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.

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

//

EXPORT_C TInt CMsgEditorView::AddControlFromResourceL( TInt aResourceId,

                                                       TInt aControlType,

                                                       TInt aIndex,

                                                       TMsgFormComponent aFormComponent )

    {

    CMsgBaseControl* control = NULL;

    switch (aControlType)

        {

        case EMsgExpandableControl:

            {

            control = new ( ELeave ) CMsgExpandableControl( *this );

            break;

            }

        case EMsgAddressControl:

            {

            control = new ( ELeave ) CMsgAddressControl( *this );

            break;

            }

        case EMsgAttachmentControl:

            {

            control = new ( ELeave ) CMsgAttachmentControl( *this, *this );

            break;

            }

        default:

            {

            control = iEditorObserver.CreateCustomControlL( aControlType );

            if ( control == NULL )

                {

                User::Leave( KErrNotSupported );

                }

            break;

            }

        }

    CleanupStack::PushL( control );

    control->SetControlType( aControlType );

    control->SetMopParent( this );

    control->ConstructFromResourceL( aResourceId );

    TInt controlId = control->ControlId();

    DoAddControlL( control, controlId, aIndex, aFormComponent );

    CleanupStack::Pop();  //control

    return controlId;

    }

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

// CMsgEditorView::AddControlL

//

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

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

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

//

EXPORT_C void CMsgEditorView::AddControlL( CMsgBaseControl* aControl,

                                           TInt aControlId,

                                           TInt aIndex,

                                           TMsgFormComponent aFormComponent )

    {

    DoAddControlL( aControl, aControlId, aIndex, aFormComponent );

    }

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

// CMsgEditorView::RemoveControlL

//

// Removes the control aControlId from the header or the body and returns pointer

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

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

//

EXPORT_C CMsgBaseControl* CMsgEditorView::RemoveControlL( TInt aControlId )

    {

    __ASSERT_DEBUG( iHeader != NULL, Panic( EMsgHeaderNotExists ) );

    __ASSERT_DEBUG( iBody != NULL, Panic( EMsgBodyNotExists ) );

    if ( iStateFlags & EMsgStateInitialized ) // Control is removed on run-time.

        {

        if ( FocusedControl() == ControlById( aControlId ) &&

             iHeader->CountMsgControls() + iBody->CountMsgControls() > 1 )

            {

            // Try to move focus to different control as focused control is removed and

            // there is more than one control loaded.

            MMsgEditorObserver::TMsgFocusEvent focusEvent = MMsgEditorObserver::EMsgFocusNone;

            if ( !RotateFocusL( EMsgFocusUp, focusEvent ) )

                {

                if ( !RotateFocusL( EMsgFocusDown, focusEvent ) )

                    {

                    //__ASSERT_DEBUG(EFalse, Panic(EMsgFocusLost));

                    // There are no focusing component left. Remove the focus from current control.

                    FocusedControl()->SetFocus( EFalse );

                    }

                }

            iCoeEnv->SyncNotifyFocusObserversOfChangeInFocus();

            }

        }

    // Remove a component from the header.

    CMsgBaseControl* control = iHeader->RemoveControlL( aControlId );

    if ( control == NULL )

        {

        // If a component could not be found in the header, remove it from the body.

        control = iBody->RemoveControlL( aControlId );

        }

    if ( iStateFlags & EMsgStateInitialized ) // Control is removed on run-time.

        {

        if ( control != NULL )

            {

            CleanupStack::PushL( control );

            RefreshViewL();

            EnsureCorrectViewPosition();

            CleanupStack::Pop();  // control

            }

        }

    else if ( iHeader->CountMsgControls() == 0 )

        {

        iFormOffset = 0;

        }

    if ( control )

        {

        // This is needed atleast for japanese pictographs to not

        // draw into current control area.

        control->MakeVisible( EFalse );

        }

    return control;

    }

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

// CMsgEditorView::DeleteControlL

//

// Removes the control aControlId from the header or the body and returns pointer

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

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

//

EXPORT_C void CMsgEditorView::DeleteControlL( TInt aControlId )

    {

    CMsgBaseControl* baseControl = RemoveControlL( aControlId );

    delete baseControl;

    }

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

// CMsgEditorView::FormComponent

//

// Returns a reference to a form component.

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

//

EXPORT_C CCoeControl& CMsgEditorView::FormComponent( TMsgFormComponent aFormComponent ) const

    {

    __ASSERT_DEBUG( iHeader != NULL, Panic( EMsgHeaderNotExists ) );

    __ASSERT_DEBUG( iBody != NULL, Panic( EMsgBodyNotExists ) );

    switch ( aFormComponent )

        {

        case EMsgHeader:

            {

            return *iHeader;

            }

        case EMsgBody:

            {

            return *iBody;

            }

        default:

            {

            __ASSERT_DEBUG( EFalse, Panic( EMsgIncorrectFormComponent ) );

            // Just to make compiler happy.

            return *iBody;

            }

        }

    }

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