/*

* Copyright (c) 2002 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:  MsgExpandableControlEditor implementation

*

*/

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

#include <eikappui.h>                      // for CEikAppUi

#include <eikenv.h>                        // for CEikonEnv

#include <txtrich.h>                       // for CRichText

#include <baclipb.h>                       // for CClipboard

#include <gulfont.h>                       // for TLogicalFont

#include <AknUtils.h>                      // for AknUtils

#include <barsread.h>                      // for TResourceReader

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

#include <AknUtils.h>

#include <AknsUtils.h>

#include <AknSettingCache.h>

#include <AknsConstants.h>

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

#include <aknlayoutscalable_apps.cdl.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <AknsFrameBackgroundControlContext.h> // FrameBackgroundControlContext

#include <AknsDrawUtils.h>

#include "MsgEditorCommon.h"               //

#include "MsgExpandableControlEditor.h"    // for CMsgExpandableControlEditor

#include "MsgExpandableControl.h"          // for CMsgExpandableControl

#include "MsgBaseControl.h"                // for TMsgEditPermissionFlags

#include "MsgBaseControlObserver.h"        // for MMsgBaseControlObserver

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

#include "MsgEditorLogging.h"

#include "MsgEditorCustomDraw.h"           // for CMsgEditorCustomDraw

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

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

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

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

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

// OPEN:

const TInt KEdwinTopMargin    = 0;

const TInt KEdwinBottomMargin = 0;

const TInt KEdwinLeftMargin   = 0;

const TInt KEdwinRightMargin  = 0;

const TInt KExpFullFormattingLength = 500;

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

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

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

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

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

// CMsgExpandableControlEditor::CMsgExpandableControlEditor

//

// Constructor.

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

//

EXPORT_C CMsgExpandableControlEditor::CMsgExpandableControlEditor(

    TUint32&                 aFlags,

    MMsgBaseControlObserver* aBaseControlObserver)

    :

    CEikRichTextEditor( TGulBorder::ENone ),

    iFlags( aFlags ),

    iBaseControlObserver( aBaseControlObserver )

    {

    }

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

// CMsgExpandableControlEditor::CMsgExpandableControlEditor

//

// Constructor.

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

//

EXPORT_C CMsgExpandableControlEditor::CMsgExpandableControlEditor(

    const CCoeControl*       aParent,

    TUint32&                 aFlags,

    MMsgBaseControlObserver* aBaseControlObserver )

    :

    CEikRichTextEditor( TGulBorder::ENone ),

    iParentControl( aParent ),

    iFlags( aFlags ),

    iBaseControlObserver( aBaseControlObserver )

    {

    }

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

// CMsgExpandableControlEditor::~CMsgExpandableControlEditor

//

// Destructor.

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

//

EXPORT_C CMsgExpandableControlEditor::~CMsgExpandableControlEditor()

    {

    delete iItemFinder;

    delete iFrameBgContext;

    delete iCustomDraw;

    }

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

// CMsgExpandableControlEditor::ConstructL

//

// Constructs and initializes this editor.

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

//

EXPORT_C void CMsgExpandableControlEditor::ConstructL()

    {

    TInt edwinFlags = ENoHorizScrolling | 

                      ENoAutoSelection | 

                      EWidthInPixels | 

                      EAllowUndo | 

                      EResizable | 

                      EPasteAsPlainText;

    iFlags = EMsgControlModeDoNotDrawFrameBgContext; 

    ResolveLayouts();

    /*if ( iBaseControlObserver &&

         !iBaseControlObserver->ViewInitialized() )

        {

        SetSuppressFormatting( ETrue );

        }*/

    TInt numberOfLines( 0 );

    if ( iFlags & EMsgControlModeSizeFixedToOneLine )

        {

        // make control fixed size and allow horizontal scrolling.

        edwinFlags &= ~EResizable;

        edwinFlags &= ~ENoHorizScrolling;

        numberOfLines = 1;

        }

    CEikRichTextEditor::ConstructL(

        iParentControl,

        numberOfLines,

        iMaxNumberOfChars,

        edwinFlags );

    // Emoticon support for MMS Subject field

    AddFlagToUserFlags(EAvkonEnableSmileySupport);

    // Both global text editor and edwin have it's own formatting layers.

    // CEikRichTextEditor::ConstructL call will set global formatting layers

    // into use for text. This is not correct as edwin formatting layers

    // will hold correct formatting values. Below calls will set edwin

    // formatting layers into use and prevent client based formatting from

    // being based on incorrect formatting layer.

    SetParaFormatLayer( iEikonEnv->SystemParaFormatLayerL()->CloneL() );

    SetCharFormatLayer( iEikonEnv->SystemCharFormatLayerL()->CloneL() );

    SetUpperFullFormattingLength( KExpFullFormattingLength );

    SetMaximumHeight( MsgEditorCommons::MaxBodyHeight() );

    // Set the wrap width to be that of the current header text pane. 

    // This will make the formatting of text safer if it is performed 

    // before the editor has ever had SetSize() called. WrapWidth is 

    // usually set in HandleSizeChanged()

    if ( iLayout )

        {

        iLayout->SetWrapWidth( iTextLayout.TextRect().Width() );

        }

    // TODO: Get from LAF or something... Currently 

    // all of these are zero. OK?!

    TMargins8 edwinMargins;

    edwinMargins.iTop = KEdwinTopMargin;

    edwinMargins.iBottom = KEdwinBottomMargin;

    edwinMargins.iLeft = KEdwinLeftMargin;

    edwinMargins.iRight = KEdwinRightMargin;

    SetBorderViewMargins( edwinMargins );

    iBgContext = AknsDrawUtils::ControlContext( this );

    // NOTE: iItemFinder can be created by derived class if needed.

    }

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

// CMsgExpandableControlEditor::ConstructFromResourceL

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

//

EXPORT_C void CMsgExpandableControlEditor::ConstructFromResourceL(

    TResourceReader& aReader )

    {

    // This used to be font id. Not used anymore. Have to read it, though.

    /*TInt fontId =*/ aReader.ReadInt32();

    ConstructL();

    if ( !IsReadOnly() )

        {

        ReadAknResourceL( aReader );

        }

    }

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

// CMsgExpandableControlEditor::SetAndGetSizeL

//

// Sets size for this editor. Height of given size aSize may change if the

// editor contains text.

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

//

EXPORT_C void CMsgExpandableControlEditor::SetAndGetSizeL( TSize& aSize )

    {

    TSize controlSize( aSize.iWidth, aSize.iHeight );

    if( TextLayout() && TextLayout()->IsFormattingBand() )

        { 

        // Partial formatting on-going -> needs whole body height

        //controlSize.iHeight = MaximumHeight();

        }   

    else

        {

        TInt position( 0 );

        AknLayoutUtils::GetEdwinVerticalPositionAndHeightFromLines( 

                                                controlSize.iHeight,

                                                AknLayoutScalable_Apps::msg_header_pane_t2( 0 ).LayoutLine(),

                                                MsgEditorCommons::MsgBaseLineDelta(),

                                                iNumberOfLines,

                                                position,

                                                controlSize.iHeight );

        }    

    controlSize.iHeight +=iEditortop;

    if ( controlSize != iSize )

        {

        // This may change the height if the content has changed.

        SetSize( controlSize );

        }

    aSize = controlSize;

    }

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

// CMsgExpandableControlEditor::CheckEditPermission

//

// Checks and returns control's edit permissions.

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

//

EXPORT_C TUint32 CMsgExpandableControlEditor::CheckEditPermission() const

    {

    TUint32 editPermission( CMsgBaseControl::EMsgEditNone );

    if ( CanUndo() )

        {

        editPermission |= CMsgBaseControl::EMsgEditUndo;

        }

    if ( Selection().Length() )

        {

        // Selection is on

        editPermission |= CMsgBaseControl::EMsgEditCopy;

        if ( !IsReadOnly() )

            {

            editPermission |= CMsgBaseControl::EMsgEditCut;

            }

        if ( Selection().Length() == TextLength() )

            {

            editPermission |= CMsgBaseControl::EMsgEditUnSelectAll;

            }

        }

    if ( TextLength() )

        {

        editPermission |= CMsgBaseControl::EMsgEditSelectAll;

        }

    editPermission |= CMsgBaseControl::EMsgEditPaste;

    return editPermission;

    }

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

// CMsgExpandableControlEditor::CursorInFirstLine

//

// Checks if the cursor is on the first line and return ETrue if it is.

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

//

EXPORT_C TBool CMsgExpandableControlEditor::CursorInFirstLine()

    {

    TBool cursorOnFirstLine = EFalse;

    TBool posFormatted = iLayout->PosIsFormatted( 0 );

    if ( iTextView && posFormatted )

        {

        TTmDocPos docPos;

        iTextView->GetCursorPos( docPos );

        TTmDocPosSpec docPosSpec( docPos );

        TTmPosInfo2 posInfo;

        TTmLineInfo lineInfo;

        if ( iLayout->FindDocPos( docPosSpec, posInfo, &lineInfo ) )

            {

            cursorOnFirstLine = ( lineInfo.iLineNumber == 0 );

            }

        }

    return cursorOnFirstLine;

    }

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

// CMsgExpandableControlEditor::CursorInLastLine

//

// Checks if the cursor is on the last line and return ETrue if it is.

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

//

EXPORT_C TBool CMsgExpandableControlEditor::CursorInLastLine()

    {

    TBool cursorOnLastLine = EFalse;

    TBool posFormatted = iLayout->PosIsFormatted( TextLength() );

    if ( iTextView && posFormatted )

        {

        TInt numOfLines = iLayout->NumFormattedLines();

        if ( numOfLines )

            {

            TTmDocPos docPos;

            iTextView->GetCursorPos( docPos );

            TTmDocPosSpec docPosSpec( docPos );

            TTmPosInfo2 posInfo;

            TTmLineInfo lineInfo;

            if ( iLayout->FindDocPos( docPosSpec, posInfo, &lineInfo ) )

                {

                cursorOnLastLine = ( lineInfo.iLineNumber == numOfLines - 1 );

                }

            }

        else

            {

            // Editor is empty.

            cursorOnLastLine = ETrue;

            }

        }

    return cursorOnLastLine;

    }

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

// CMsgExpandableControlEditor::IsFirstLineVisible

//

// Checks if first text line is visible.

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

//

EXPORT_C TBool CMsgExpandableControlEditor::IsFirstLineVisible()

    {

    if( TextLayout() )

        {

        TPoint dummy;

        if( TextLayout()->PosInBand( 0, dummy ) )

            {

            if( iTextView )

                {

                TTmDocPos docPos( 0, ETrue );

                TTmDocPosSpec docPosSpec( docPos );

                TTmPosInfo2 posInfo;

                TTmLineInfo lineInfo;

                if ( iLayout->FindDocPos( docPosSpec, posInfo, &lineInfo ) )

                    {

                    // posInfo.iEdge specifies coordinate position of

                    // intersection of the character edge with the baseline.

                    TInt fontTop = posInfo.iEdge.iY - TextFont()->AscentInPixels();

                    return ( fontTop >= 0 && fontTop <= MsgEditorCommons::EditorViewHeigth() );

                    }

                }

            else

                {

                return ETrue;

                }

            }

        return EFalse;

        }

    return ETrue;

    }

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

// CMsgExpandableControlEditor::IsLastLineVisible

//

// Checks if last text line is visible.

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

//

EXPORT_C TBool CMsgExpandableControlEditor::IsLastLineVisible()

    {

    if( TextLayout() )

        {

        TPoint dummy;

        if( TextLayout()->PosInBand( TextLength(),dummy ) )

            {

            if ( iTextView )

                {

                TTmDocPos docPos( TextLength(), EFalse );

                TTmDocPosSpec docPosSpec( docPos );

                TTmPosInfo2 posInfo;

                TTmLineInfo lineInfo;

                if ( iLayout->FindDocPos( docPosSpec, posInfo, &lineInfo ) )

                    {

                    return ( posInfo.iEdge.iY >= 0 && 

                             posInfo.iEdge.iY <= MsgEditorCommons::EditorViewHeigth() );

                    }

                }

            else

                {

                return ETrue;

                }

            }

        return EFalse;

        }

    return ETrue;

    }

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

// CMsgExpandableControlEditor::CurrentLineRect

//

// Returns the current control rect.

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

//

EXPORT_C TRect CMsgExpandableControlEditor::CurrentLineRectL()

    {

    if ( !iTextView )

        {

        User::Leave( KErrGeneral );

        }

    TTmDocPos docPos;

    iTextView->GetCursorPos( docPos );

    iTextView->FinishBackgroundFormattingL();

    TInt cursorPos = Min( docPos.iPos, TextLength() );

    if ( !iLayout->PosIsFormatted( cursorPos ) )

        {

        iTextView->SetDocPosL( cursorPos, Selection().Length() );  // after this cursorPos should be formatted

        ForceScrollBarUpdateL();

        }

    TRect cursorPosRect;

    if ( iTextView->IsPictureFrameSelected( cursorPosRect, cursorPos ) )

        {

        cursorPosRect.Move( TPoint( 0, -iTextView->ViewRect().iTl.iY ) );

        }

    else

        {

        TTmDocPosSpec docPosSpec( docPos );

        TTmPosInfo2 posInfo;

        TTmLineInfo lineInfo;

        if ( iLayout->FindDocPos( docPosSpec, posInfo, &lineInfo ) )

            {

            cursorPosRect = lineInfo.iInnerRect;

            }

        //TODO: else what?! We should never get to else branch...

        }

    return cursorPosRect;

    }

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

// CMsgExpandableControlEditor::DefaultHeight

//

// Returns a default one line height of the editor.

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

//

EXPORT_C TInt CMsgExpandableControlEditor::DefaultHeight() const

    {

    return DefaultHeight( EFalse );

    }

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

// CMsgExpandableControlEditor::ClipboardL

//

// Handles a clipboard operation.

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

//

void CMsgExpandableControlEditor::ClipboardL(

    CEikEdwin::TClipboardFunc aClipboardFunc )

    {

    __ASSERT_DEBUG( iTextView, Panic( EMsgNoTextView ) );

    CEikRichTextEditor::ClipboardL( aClipboardFunc );

    }

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

// CMsgExpandableControlEditor::CcpuCanCut

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

//

EXPORT_C TBool CMsgExpandableControlEditor::CcpuCanCut() const

    {

    TUint32 editPermission = CheckEditPermission();

    if ( iBaseControlObserver )

        {

        TRAP_IGNORE( 

            {

            if ( iBaseControlObserver->HandleEditObserverEventRequestL( this, EMsgDenyCut ) )

                {

                editPermission &= ~CMsgBaseControl::EMsgEditCut;

                }

            } );

        }

    return editPermission & CMsgBaseControl::EMsgEditCut;

    }

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

// CMsgExpandableControlEditor::CcpuCanCopy

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

//

EXPORT_C TBool CMsgExpandableControlEditor::CcpuCanCopy() const