/*

* Copyright (c) 1997-2009 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:

*

*/

#include <eikcapc.h>

#include <coemain.h>

#include <barsread.h>

#include <eikenv.h>

#include <eikon.hrh>

#include <eikbctrl.h>

#include <eiksfont.h>

#include <gulcolor.h>

#include <eikimage.h>

#include <eikappui.h>

#include <eikbtgpc.h>

#include <eikedwin.h>

#include <frmtlay.h>

#include <eikdialg.pan>

#include <AknUtils.h>  // Avkon drawing utilities 

#include <aknenv.h>

#include <AknDef.h>

#include <aknconsts.h>

#include <avkon.hrh>

#include <avkon.rsg>

#include <AknPopupFieldText.h>

#include <aknslider.h> 

#include <eikseced.h>

#include <eikdpage.h>

#include <eikdialogext.h>

#include <eikcapca.h>

#include <eikmfne.h>

#include <eikform.pan>

#include <eikdpobs.h>

#include <eikdpsel.h>

#include <gulicon.h>

#include <gdi.h>  // for CEikCapCLabel

#include <biditext.h> // for TDirectionality

#include <AknBidiTextUtils.h>

#include <AknIconUtils.h>

#include <AknPanic.h>

#include <touchfeedback.h>

#include <AknTasHook.h> // for testability hooks

//<SKIN>

#include <AknsDrawUtils.h>

#include <AknsUtils.h>

#include <AknsListBoxBackgroundControlContext.h>

#include <AknsFrameBackgroundControlContext.h>

#include <skinlayout.cdl.h>

#include <aknappui.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <aknextendedinputcapabilities.h>

#include "EIKFANIM.H"

//#define BLACKBACKGROUND  // useful when debugging form layout.

#if defined( RD_SCALABLE_UI_V2)

//class CAknButton is available from week 20 version 5.0 onwards

#include "aknbutton.h"

#include <avkon.mbg>

// For MAknMfneCommandObserver

#include <aknmfnecommandobserver.h>

#endif //if defined( RD_SCALABLE_UI_V2)

GLREF_C void Panic(TEikDialogPanic aPanic);

const TInt KViewHighlightColor = 244 ;

// const TInt KViewHighlightShadowColor = 222 ; 

// const TInt KNormalBackgroundColor = 0 ;

// Do not reference these directly... Use MaximumNumberOfControlLinesOnVisiblePage() 

// const TInt KMaxControlLinesOnPageSingleLineFormat =6;

// const TInt KMaxControlLinesOnPageDoubleLineFormat =5;

enum

    {// must carry on from TSpaceSharingFlags

    EUsesEars       =0x10,

    ELeftEarDown    =0x20,

    ERightEarDown   =0x40,

    ELeftEarGrab    =0x80,

    ERightEarGrab   =0x100,

    ECurrent        =0x200,

    ESeparatorAfter =0x400,

    EExtraAscent    =0x800,

    ELatent         =0x1000,

    ELglf           =0x2000,

    ETakesEnterKey  =0x4000,

    EOfferAllHotKeys=0x8000,

    ETrailerAfterEar=0x10000,

    ENoBorder       = 0x20000

    };

const TInt KDynamicEarMask=(ELeftEarDown|ERightEarDown|ELeftEarGrab|ERightEarGrab);

const TInt KCapCDefaultHorzEdgeSpacing=0;

const TInt KCapCDefaultVertEdgeSpacing=0; 

const TInt KCapCCenterSpacing=0;

const TInt KControlTrailerSpacing=0;

// const TInt KCapCEarHeightTopHalf=0;

// const TInt KCapCEarHeightBottomHalf=0;

// const TInt KCapCEarHeight=KCapCEarHeightTopHalf+KCapCEarHeightBottomHalf;

const TInt KCapCEarWidth=0;

const TInt KCapCEarSpacing=0;

const TInt KCapCVertCaptionOffset=0;

const TInt KCapCExtraAscent=KCapCVertCaptionOffset+0;

const TInt KTrailCVertCaptionOffset=0;

const TInt KCapCSeparatorAfterSpace=0;

const TInt KCapCInitialEarRepeat=600000;    // 6 tenths of a second

const TInt KCapCEarRepeat=100000; // one tenth of a second

/*

 *  The following set of static functions return value which have been hard coded from the Series 60 Skins LAF v2.0

 *  If a layout DLL becomes available the hard-coded values may be replaced with equivalent Macros.

 *  NOTE THAT THERE ARE COPIES OF SOME OF THESE FUNCTIONS IN EIKDPAGE.CPP

 */

/*

* Note, that table numbers have changed, 5.24 is 5.26 in current (3.1) laf,

* and 5.17 seems to be 5.16

* Also, these original hard coded values mostly ignore l & t fields, as

* code only wants to know W & H, and it will break if l & t are used

* comments indicate overriden values

*/

LOCAL_D TRect EditFrameTopLeftRect( const TRect& aParentRect )

    {// Skins LAF table 5.24 Line 2

    TAknLayoutRect topLeft ;

    topLeft.LayoutRect( aParentRect, SkinLayout::Input_field_skin_placing__general__Line_2() ); 

    TRect rectTopLeft( topLeft.Rect() );

    return rectTopLeft;

    }

LOCAL_D TRect EditFrameTopRightRect( const TRect& aParentRect )

    {// Skins LAF table 5.24 Line 3

    TAknLayoutRect topRight ;  

    TAknWindowLineLayout l( SkinLayout::Input_field_skin_placing__general__Line_3() );

    // l field should be w - 3

    TAknLayoutRect layoutRect;

    layoutRect.LayoutRect( aParentRect, l );

    TRect rectLayout( layoutRect.Rect() );

	// COMPLETELY BROKEN -- SHOULD NEVER INVENT OWN COORDINATES FOR LAYOUTRECT().

    //topRight.LayoutRect( aParentRect, ELayoutEmpty, ELayoutEmpty, 0, 0, ELayoutEmpty, rectLayout.Width(), rectLayout.Height() ) ;

    //TRect rectTopRight( topRight.Rect() );

    return rectLayout /*rectTopRight*/;

    }

LOCAL_D TRect EditFrameBottomLeftRect( const TRect& aParentRect )

    {// Skins LAF table 5.24 Line 4

    TAknLayoutRect bottomLeft ;

    TAknWindowLineLayout l( SkinLayout::Input_field_skin_placing__general__Line_4() );

    // t should be h-3

    TAknLayoutRect layoutRect;

    layoutRect.LayoutRect( aParentRect, l );

    TRect rectLayout( layoutRect.Rect() );

	// COMPLETELY BROKEN -- SHOULD NEVER INVENT OWN COORDINATES FOR LAYOUTRECT().

    //bottomLeft.LayoutRect( aParentRect, ELayoutEmpty, 0, ELayoutEmpty, ELayoutEmpty, 0, rectLayout.Width(), rectLayout.Height() ) ;

    //TRect rectBottomLeft( bottomLeft.Rect() );

    return rectLayout /*rectBottomLeft*/;

    }

LOCAL_D TRect EditFrameBottomRightRect( const TRect& aParentRect )

    {// Skins LAF table 5.24 Line 5

    TAknLayoutRect bottomRight ;

    TAknWindowLineLayout l( SkinLayout::Input_field_skin_placing__general__Line_5() );

    // l should be w-3, t should be h-3

    TAknLayoutRect layoutRect;

    layoutRect.LayoutRect( aParentRect, l );

    TRect rectLayout( layoutRect.Rect() );

	// COMPLETELY BROKEN -- SHOULD NEVER INVENT OWN COORDINATES FOR LAYOUTRECT().

    //bottomRight.LayoutRect( aParentRect, ELayoutEmpty, ELayoutEmpty, ELayoutEmpty, 0, 0, rectLayout.Width(), rectLayout.Height() ) ;

    //TRect rectBottomRight( bottomRight.Rect() );

    return rectLayout /*rectBottomRight*/;

    }

LOCAL_D TRect EditFrameTopRect( const TRect& aParentRect )

    {// Skins LAF table 5.24 Line 6

    TAknLayoutRect top ;

    TAknWindowLineLayout l (SkinLayout::Input_field_skin_placing__general__Line_6() );

    TAknLayoutRect layoutRect;

    layoutRect.LayoutRect( aParentRect, l );

    TRect rectLayout( layoutRect.Rect() );

	// COMPLETELY BROKEN -- SHOULD NEVER INVENT OWN COORDINATES FOR LAYOUTRECT().

    //top.LayoutRect( aParentRect, ELayoutEmpty, rectLayout.iTl.iX, rectLayout.iTl.iY, ELayoutEmpty, ELayoutEmpty, aParentRect.Width()+rectLayout.Width(), rectLayout.Height() ) ;

    //TRect rectTop( top.Rect() );

    return rectLayout /*rectTop*/;

    }

LOCAL_D TRect EditFrameBottomRect( const TRect& aParentRect )

    {// Skins LAF table 5.24 Line 7

    TAknLayoutRect bottom ;

    TAknWindowLineLayout l (SkinLayout::Input_field_skin_placing__general__Line_7() );

    TAknLayoutRect layoutRect;

    layoutRect.LayoutRect( aParentRect, l );

    TRect rectLayout( layoutRect.Rect() );

	// COMPLETELY BROKEN -- SHOULD NEVER INVENT OWN COORDINATES FOR LAYOUTRECT().

    //bottom.LayoutRect( aParentRect, ELayoutEmpty, rectLayout.iTl.iX, 0, aParentRect.Height()+rectLayout.iTl.iY, ELayoutEmpty, aParentRect.Width()+rectLayout.Width(), rectLayout.Height() ) ;

    //TRect rectBottom( bottom.Rect() );

    return rectLayout /*rectBottom*/;

    }

LOCAL_D TRect ViewFrameTopLeftRect( const TRect& aParentRect )

    {// Skins LAF table 5.17 line 2

    TAknLayoutRect topLeft ;

    topLeft.LayoutRect( aParentRect, SkinLayout::List_highlight_skin_placing__general__Line_2() );

    TRect rectTopLeft( topLeft.Rect() );

    return rectTopLeft;

    }

LOCAL_D TRect ViewFrameBottomRightRect( const TRect& aParentRect )

    {// Skins LAF table 5.17 line 5

    TAknLayoutRect bottomRight ;

    TAknWindowLineLayout l ( SkinLayout::List_highlight_skin_placing__general__Line_5() );

    TAknLayoutRect layoutRect;

    layoutRect.LayoutRect( aParentRect, l );

    TRect rectLayout( layoutRect.Rect() );

	// COMPLETELY BROKEN -- SHOULD NEVER INVENT OWN COORDINATES FOR LAYOUTRECT().

    //bottomRight.LayoutRect( aParentRect, ELayoutEmpty, ELayoutEmpty, ELayoutEmpty, 0, 0, rectLayout.Width(), rectLayout.Height() ) ;

    //TRect rectBottomRight( bottomRight.Rect() );

    return rectLayout;

    }

LOCAL_D TInt ScaledSubLength(TInt aScaledTotal, TInt aSubLength, TInt aTotal)

    {

	if(aTotal)

		return ((aSubLength*aScaledTotal)+(aTotal/2))/aTotal;

	else

		return aScaledTotal;

    }

LOCAL_D TBool IsPopupField(const CEikCaptionedControl* aCC)

{

	TInt ctrlType = aCC->iControlType;

	if (ctrlType == EAknCtPopupField || ctrlType == EAknCtPopupFieldText)

	{

		CAknPopupField *field = (CAknPopupField*)aCC->iControl;

		if (field->SelectionMode() != CAknPopupField::EAknPopupFieldLabelMode)

			return ETrue;

		return EFalse;

	}

	return EFalse;

}

class CIdleCallbackData;

/**

* 

* Extension class for additional data members.

*

*/

NONSHARABLE_CLASS( CEikCapCExtension ): public MEikFormAnimObserver

    {

    friend class CEikCaptionedControl ;

private:

    CEikCapCExtension();

    ~CEikCapCExtension();

    TBool IsHighlightAnimated() const;

    void SkinChanged();

    void HandleLayoutSwitch( const TSize& aSize );

    // Implementation of MEikFormAnimObserver

    void AnimFrameReady();

    TBool AnimDrawHighlightBackground( CFbsBitGc& aGc );

    /**

     * Simulates pointer event to control if required.

     * 

     * @param aPointerEvent Received pointer event.

     */

    void SimulatePointerEventToControlL( const TPointerEvent& aPointerEvent );

    /**

     * Returns ETrue if control launches a virtual input when tapped.

     * 

     * @return ETrue if virtual input should be launched.

     */

    TBool LaunchInputType() const;

private:    //Data members.  None owned.

    CEikCaptionedControl* iSelf ; // pointer to full class

    CAknsFrameBackgroundControlContext* iEditModeHighlightControlContext ;

    CAknsFrameBackgroundControlContext* iViewModeHighlightControlContext ;

    CAknsFrameBackgroundControlContext* iEditModeHighlightControlContextPressed;

    CAknsFrameBackgroundControlContext* iViewModeHighlightControlContextPressed ;

    TRect iPreviousRect ;

    TBool iPreviousState ; // Editable state

    TBool iPressDownEffect; //Press Down Effect

    // Offset necessary because LAF instructs use of List Layout for Forms but the parent panes have different origins.

    TInt iXOffsetForDataPaneInEditMode ;

    TInt iYOffsetForDataPaneInEditMode ;

    TBool iDrawNoWhiteBackground;

    CEikFormAnim* iAnimation;

	CEikImage* iIndicator;

	CEikImage* iIndicator2;

	MPointerEventObserver *iObserver;

    /**

     * ETrue if to control is sent simulated down event.

     */

    TBool iSimulatedDownEvent;

    /**

     * Tactile feedback provider.

     * Not own.

     */

    MTouchFeedback* iFeedback;

public: // needs to be public because idle callback uses these members.

	CIdle *iIdle;

	CIdleCallbackData *iIdleData;

    /** iPartiallyVisible is used as a protection from changing subcontrol positions of 

      * partially-visible controls in PositionFormComponents(). This is needed only for

      * dynamic screen size change.

      */

    TBool iPartiallyVisible;

    /**

     * Boolean used to check if application is single touch compatible.

     */

    TBool iUsesSingleClick;

private:

    } ;

NONSHARABLE_CLASS(CIdleCallbackData) : public CBase

{

public:

	CEikCaptionedControl *iCtrl;

	CEikCapCExtension *iExt;

};

CEikCapCExtension::CEikCapCExtension() : 

    // Member initialisaction list - all values to NULL/0

    iSelf( NULL ), 

    iEditModeHighlightControlContext ( NULL ) ,

    iViewModeHighlightControlContext ( NULL ) ,

    iEditModeHighlightControlContextPressed( NULL ),

    iViewModeHighlightControlContextPressed( NULL ),

    iPreviousRect( TPoint(0, 0), TSize(0, 0) ) ,

    iPreviousState( EFalse ) ,

    iPressDownEffect( EFalse ),

    iXOffsetForDataPaneInEditMode( ELayoutEmpty ) ,

    iYOffsetForDataPaneInEditMode( ELayoutEmpty ) ,

    iDrawNoWhiteBackground( EFalse ),

    iAnimation( NULL )

	, iIndicator(NULL),

	iIndicator2(NULL),

	iObserver(NULL),

    iFeedback( MTouchFeedback::Instance() ),

	iIdle(NULL),

	iIdleData(NULL),

    iPartiallyVisible( EFalse )

    {

    if ( iAvkonAppUi )

        {

        iUsesSingleClick = iAvkonAppUi->IsSingleClickCompatible();

        }

    };

CEikCapCExtension::~CEikCapCExtension()

    {

    // Remember to unacquire animation

    if( iAnimation && iSelf )

        {

        if( iSelf->iDialogPage )

            iSelf->iDialogPage->AcquireAnim( EFalse, this );

        }

    }

TBool CEikCapCExtension::IsHighlightAnimated() const

    {

    if( iAnimation )

        {

        if( iAnimation->Animation() )

            return ETrue;

        }

    // No animation available at all...

    return EFalse;

    }

void CEikCapCExtension::SkinChanged()

    {

    iAnimation = NULL;

    if( iSelf->iDialogPage )

        iAnimation = iSelf->iDialogPage->AcquireAnim( ETrue, this );

    if( iAnimation )

        {

        iAnimation->SetHighlightSize( iSelf->Rect().Size() );

        }

    }

void CEikCapCExtension::HandleLayoutSwitch( const TSize& aSize )

    {

    if( iAnimation )

        {

        if( iAnimation->Size() == aSize )

            {

            // No need to resize, just change the background used

            // as animation input.

            iAnimation->ChangeHighlightBackground();

            }

        else

            {

            iAnimation->SetHighlightSize( aSize );

            }

        }

    }

void CEikCapCExtension::AnimFrameReady()

    {

    if( iSelf )

        iSelf->DrawNow();

    }

TBool CEikCapCExtension::AnimDrawHighlightBackground( CFbsBitGc& aGc )

    {

    if( !iSelf->iDialogPage )

        return EFalse;

    // Draw the background under the current highlight. This simplified

    // drawing, we only grab a piece from the list background bitmap.

    MAknsSkinInstance* skin = AknsUtils::SkinInstance();

    MAknsControlContext* cc = AknsDrawUtils::ControlContext( iSelf->iDialogPage );

    return AknsDrawUtils::DrawBackground( skin, cc, iSelf->iDialogPage, aGc, TPoint(0,0),

                                          iSelf->ViewRect(), KAknsDrawParamRGBOnly );

    }

void CEikCapCExtension::SimulatePointerEventToControlL(

        const TPointerEvent& aPointerEvent )

    {

    // Extend form item touch area to whole item area

    if ( iSelf->iIsEditable

         && ( aPointerEvent.iType == TPointerEvent::EButton1Down 

            || aPointerEvent.iType == TPointerEvent::EButton1Up ) )

        {

        // Check control type

        TBool edwinControl( LaunchInputType() );

        TBool simulate = EFalse;

        if ( aPointerEvent.iType == TPointerEvent::EButton1Down

                && iSelf->Rect().Contains( aPointerEvent.iPosition )

                && !iSelf->iControl->Rect().Contains(

                        aPointerEvent.iPosition ) )

            {

            iSimulatedDownEvent = ETrue;

            if ( !edwinControl )

                {

                simulate = ETrue;

                }

            }

        else if ( aPointerEvent.iType == TPointerEvent::EButton1Up

                && iSimulatedDownEvent )

            {

            simulate = ETrue;

            }

        // Simulate pointer event to control

        if ( simulate && !edwinControl )

            {

            TPointerEvent controlEvent( aPointerEvent );

            controlEvent.iPosition =

                iSelf->iControl->Rect().iTl + TPoint( 1, 1 );

            iSelf->iControl->HandlePointerEventL( controlEvent );

            }

        // With edwin do action directly (due to cursor problems)

        else if ( edwinControl && simulate

                && aPointerEvent.iType == TPointerEvent::EButton1Up )

            {

            CAknExtendedInputCapabilities* input( NULL );

            iSelf->iControl->InputCapabilities().ObjectProvider(