/*

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

*

*/

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

#include <barsread.h>                      // for TResourceReader

#include <txtrich.h>                       // for CRichText

#include <eikenv.h>                        // for CEikonEnv

#include <eikappui.h>                      // for CEikAppUi

#include <eikedwin.h>                      // for TClipboardFunc

#include <eiklabel.h>

#include <AknUtils.h>                      // for AknUtils

#include <aknbutton.h>                     // for CAknButton

#include <MsgAttachmentModel.h>

#include <MsgAttachmentInfo.h>

#include <gulicon.h>

#include <AknsUtils.h>

#include <AknsConstants.h>

#include <aknlayoutscalable_apps.cdl.h>

#include <data_caging_path_literals.hrh>

#include <msgeditor.mbg>

#ifdef RD_TACTILE_FEEDBACK

#include <touchfeedback.h>

#endif 

#include "MsgAttachmentControl.h"             // for CMsgAttachmentControl

#include "MsgExpandableControlEditor.h"       // for CMsgExpandableControlEditor

#include "MsgBaseControlObserver.h"        // for MMsgBaseControlObserver

#include "MsgEditorView.h"

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

#include "MsgEditorCommon.h"               // for KArabicSemicolon

#include "MsgEditorCustomDraw.h"           // for CMsgEditorCustomDraw

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

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

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

// Default color for EAknsCIQsnIconColorsCG13 group icons

const TInt KDefaultAttachmentColor = 215; 

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

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

const TInt KAttachmentArrayGranularity = 10;

_LIT( KAttachmentListSeparator, ", " );

_LIT( KIconMbmFile, "msgeditor.mbm" );

_LIT( KStripList, "\x000A\x000D\x2029\x2028\x0085" );

const TText KZeroWidthJoiner = 0x200D;

const TText KLRMarker = 0x200E;

const TText KRLMarker = 0x200F;

const TInt KScrollStartDelay = 1500000; // 1,5 s

const TInt KScrollEndDelay = 500000;    // 0,5 s

const TInt KScrollRestartDelay = 3000000; // 3 s.

const TInt KScrollTickDelay = 135000; // 0,135s

const TInt KScrollJumpAreaDivider = 15;

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

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

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

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

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

// CMsgAttachmentControl::CMsgAttachmentControl

//

// Constructor.

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

//

CMsgAttachmentControl::CMsgAttachmentControl( 

                                    MMsgBaseControlObserver& aBaseControlObserver,

                                    CMsgEditorView& aView ) : 

    CMsgExpandableControl( aBaseControlObserver ),

    iScrollPos( EScrollPosBeginning )

    {

    iControlType = EMsgAttachmentControl;

    iControlId = EMsgComponentIdAttachment;

    SetMopParent( &aView );

    }

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

// CMsgAttachmentControl::ConstructL

//

// 2nd phase constructor. After base class initialization creates

// attachment array that holds the attachment name strings. Empty

// caption control is also created for base class purposes. NOTE! This is 

// something that would be good to get rid off. Initializes editor control

// and sets itself as it's edwin event, edwin size event and

// control event observer. Creates editor is set as readonly and cursor is

// hidden. Focus must stop to this control when navigating. No formatting

// is allowed. Label icon and if pen input (i.e. touch screen) is enabled

// then also button are created. Initializes marquee scroll timer and

// layout related parameters.

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

//

void CMsgAttachmentControl::ConstructL()

    {

    BaseConstructL();  // Sets margins only.

    iAttachmentArray = new( ELeave ) CDesCArrayFlat( KAttachmentArrayGranularity );

    // Create empty caption. (Needed by base class.)

    iCaption = new( ELeave ) CEikLabel;

    // Create editor.

    iEditor = new( ELeave ) CMsgExpandableControlEditor( this, 

                                                         iControlModeFlags, 

                                                         iBaseControlObserver );

    iEditor->SetControlType(iControlType);   

    iEditor->ConstructL();

    iEditor->SetObserver( this );

    iEditor->SetEdwinSizeObserver( this );

    iEditor->AddEdwinObserverL( this );

    iEditor->SetReadOnly( ETrue );

    iEditor->AddFlagToUserFlags( CEikEdwin::EAvkonDisableCursor );

    iControlModeFlags |= EMsgControlModeForceFocusStop;

    SetPlainTextMode( ETrue );

    iLabelIcon = CreateAttachmentIconsL();

#ifdef RD_SCALABLE_UI_V2

    if ( AknLayoutUtils::PenEnabled() )

        {

        CreateButtonL();

        }

#endif // RD_SCALABLE_UI_V2

    iScrollTimer = CPeriodic::NewL( EPriorityNormal );

    ResolveLayoutsL();

    }

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

// CMsgAttachmentControl::NewL

// Symbian two phased constructor

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

//

EXPORT_C CMsgAttachmentControl* CMsgAttachmentControl::NewL( 

                                                MMsgBaseControlObserver& aBaseControlObserver,

                                                CMsgEditorView& aView )

    {

    CMsgAttachmentControl* self = new( ELeave ) CMsgAttachmentControl( aBaseControlObserver,

                                                                       aView );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

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

// CMsgAttachmentControl::~CMsgAttachmentControl

//

// Destructor.

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

//

CMsgAttachmentControl::~CMsgAttachmentControl()

    {

    if ( iAttachmentArray )

        {

        iAttachmentArray->Reset();

        }

    delete iAttachmentArray;

    delete iLabelIcon;

    delete iScrollTimer;

    }

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

// CMsgAttachmentControl::AppendAttachmentL

//

//

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

//

EXPORT_C void CMsgAttachmentControl::AppendAttachmentL( const TDesC& aName )

    {

    InsertAttachmentL( aName, Count() );

    }

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

// CMsgAttachmentControl::InsertAttachmentL

//

//

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

//

EXPORT_C void CMsgAttachmentControl::InsertAttachmentL( const TDesC& aName, TInt aIndex )

    {

    AddToAttachmentArrayL( aName, aIndex );

    UpdateControlL();

    }

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

// CMsgAttachmentControl::AddAttachmentL

//

//

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

//

EXPORT_C void CMsgAttachmentControl::AddAttachmentsL( const MDesCArray& aNames )

    {

    Reset();

    for ( TInt i = 0; i < aNames.MdcaCount(); i++ )

        {

        AddToAttachmentArrayL( aNames.MdcaPoint( i ), Count() );

        }

    UpdateControlL();

    }

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

// CMsgAttachmentControl::AddAttachmentL

//

//

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

//

EXPORT_C void CMsgAttachmentControl::AddAttachmentsL( const CMsgAttachmentModel& aModel )

    {

    Reset();

    TParse* parser = new( ELeave ) TParse ;

    CleanupStack::PushL( parser );

    for ( TInt i = 0; i < aModel.NumberOfItems(); i++ )

        {

        parser->Set( aModel.AttachmentInfoAt( i ).FileName(),NULL, NULL );

        AddToAttachmentArrayL( parser->NameAndExt(), Count() );

        }

    CleanupStack::PopAndDestroy( parser ); 

    UpdateControlL();

    }

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

// CMsgAttachmentControl::RemoveAttachmentL

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

//

EXPORT_C void CMsgAttachmentControl::RemoveAttachmentL( const TDesC& aName )

    {

    HBufC* convertedFileName = AknTextUtils::ConvertFileNameL( aName );

    CleanupStack::PushL( convertedFileName );

    TPtr convertedFileNamePtr = convertedFileName->Des();

    AknTextUtils::StripCharacters( convertedFileNamePtr, KAknStripListControlChars );

    TInt pos( KErrNotFound );

    if ( iAttachmentArray->Find( *convertedFileName, pos ) == 0 )

        {

        RemoveAttachmentL( pos );

        }

    CleanupStack::PopAndDestroy( convertedFileName );

    }

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

// CMsgAttachmentControl::RemoveAttachmentL

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

//

EXPORT_C void CMsgAttachmentControl::RemoveAttachmentL( TInt aIndex )

    {

    iAttachmentArray->Delete( aIndex );

    UpdateControlL();

    }

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

// CMsgAttachmentControl::Reset

//

// from CMsgBaseControl.

// Same as above but non-leaving version.

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

//

EXPORT_C void CMsgAttachmentControl::Reset()

    {

    if ( iAttachmentArray )

        {

        iAttachmentArray->Reset();

        }

    if ( iEditor )

        {

        iEditor->Reset();

        }

    }

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

// CMsgAttachmentControl::Count

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

//

EXPORT_C TInt CMsgAttachmentControl::Count() const

    {

    return iAttachmentArray->MdcaCount();

    }

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

// CMsgAttachmentControl::Attachment

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

//

EXPORT_C TPtrC CMsgAttachmentControl::Attachment( TInt aIndex ) const

    {

    return iAttachmentArray->MdcaPoint( aIndex );

    }

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

// CMsgAttachmentControl::ConstructFromResourceL

//

// Creates this control from resource.

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

//

void CMsgAttachmentControl::ConstructFromResourceL( TInt aResourceId )

    {

    TResourceReader reader;

    iCoeEnv->CreateResourceReaderLC( reader, aResourceId );

    // Read some information about control from resource.

    ReadControlPropertiesFromResourceL( reader );

    ConstructL();

    CleanupStack::PopAndDestroy();  // reader

    }

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

// CMsgAttachmentControl::EditPermission

//

// Checks and returns control's edit permissions. Edit permissions are needed

// to check in order to know whether some key press is allowed to pass

// to the control or not.

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

//

TUint32 CMsgAttachmentControl::EditPermission() const

    {

    return CMsgBaseControl::EMsgEditNone;

    }

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

// CMsgAttachmentControl::NotifyViewEvent

//

// Builds up text fields for the control i.e. reads verified recipients and

// creates corresponding text fields for them.

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

//

void CMsgAttachmentControl::NotifyViewEvent( TMsgViewEvent aEvent, TInt aParam )

    {

    if ( IsReadOnly() )

        {

        aParam |= EMsgViewEventAutoHighlight;

        }

    if ( aEvent != EMsgViewEventSetCursorFirstPos &&

         aEvent != EMsgViewEventSetCursorLastPos )

        {

        CMsgExpandableControl::NotifyViewEvent( aEvent, aParam );

        }

    }

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

// CMsgAttachmentControl::PrepareForReadOnly

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

//

void CMsgAttachmentControl::PrepareForReadOnly( TBool aReadOnly )

    {

    if ( aReadOnly )

        {

        TRAP_IGNORE( iEditor->SetHighlightStyleL( EEikEdwinHighlightLink ) );

        }

    }

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

// CMsgAttachmentControl::CountComponentControls

//

// Returns a number of controls.

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

//

TInt CMsgAttachmentControl::CountComponentControls() const

    {

    TInt result( 1 );

    if ( iButton )

        {

        result++;

        }

    return result;

    }

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

// CMsgAttachmentControl::ComponentControl

//

// Returns a control of index aIndex.

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

//

CCoeControl* CMsgAttachmentControl::ComponentControl( TInt aIndex ) const

    {

    CCoeControl* result = NULL;

    switch ( aIndex )

        {

        case 0:

            {

            result = iEditor;

            break;

            }

        case 1:

            {

            result = iButton;

            break;

            }

        default:

            {

            break;

            }

        }

    return result;

    }

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

// CMsgAttachmentControl::OfferKeyEventL

//

// Handles key events. The most of the keys are passed to the control editor.

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

//

TKeyResponse CMsgAttachmentControl::OfferKeyEventL(

    const TKeyEvent& /*aKeyEvent*/, TEventCode /*aType*/ )

    {

    return EKeyWasNotConsumed;

    }

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

// CMsgAttachmentControl::HandleResourceChange

//

// Handles resouce change events. Event are passed to the base

// class and if layout has been switched new layouts are resolved

// from LAF.

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

//

void CMsgAttachmentControl::HandleResourceChange( TInt aType )

    {

    TRAP_IGNORE( 

        {

        DoHandleResourceChangeBeforeL( aType );

        CMsgExpandableControl::HandleResourceChange( aType );

        DoHandleResourceChangeAfterL( aType );

        } );    

    }

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

// CMsgAttachmentControl::HandlePointerEventL

//

// Pointer event handling is disabled on editor

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

//

void CMsgAttachmentControl::HandlePointerEventL( const TPointerEvent& aPointerEvent )

    {

    if ( !iEditor->Rect().Contains( aPointerEvent.iPosition ) )

        {

        CMsgExpandableControl::HandlePointerEventL( aPointerEvent );

        }

#ifdef RD_TACTILE_FEEDBACK 

    else if ( aPointerEvent.iType == TPointerEvent::EButton1Down )

        {

        MTouchFeedback* feedback = MTouchFeedback::Instance();

        if ( feedback )

            {

            feedback->InstantFeedback( this, ETouchFeedbackBasic );                        

            }                                     

        }

#endif

    }

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

// CMsgAttachmentControl::FocusChanged

//

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

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

//

void CMsgAttachmentControl::FocusChanged( TDrawNow aDrawNow )

    {

    CMsgExpandableControl::FocusChanged( aDrawNow );

    if ( IsReadOnly() )

        {

        TRAP_IGNORE( UpdateFocusL() );

        }

    if ( iAutomaticScrolling )

        {

        StopAutomaticScrolling();

        if ( IsFocused() )