/*

* Copyright (c) 2002-2008 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:  Implementation of AVKON query control.

*

*/

// INCLUDE FILES

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <uikon/eikdefmacros.h>

#endif

#include "aknQueryControl.h"    //This class

#include <barsread.h>           //For TResourceReader

#include <aknenv.h>

#include <AknBitmapAnimation.h>

#include <aknconsts.h>

#include <avkon.mbg>

#include <avkon.rsg>

#include <aknborders.h>

#include <AknEcs.h>

#include <aknedsts.h>

#include <AknLayoutDef.h>

#include <AknLayout.lag>

#include "akntextcontrol.h"

#include "aknqueryeditorindicator.h"

#include "aknEditStateIndicator.h"

#include "AknUtils.h"

#include "aknnoteattributes.h"

#include <AknsDrawUtils.h>

#include <AknsConstants.h>

#include <AknsFrameBackgroundControlContext.h>

#include <AknsPointerStore.h>

#include <in_sock.h>

#include <AknPictographInterface.h>

#include <AknPictographDrawerInterface.h>

#include "AknQueryExtension.h"

#include <skinlayout.cdl.h>

#include <AknIconUtils.h>

#include "aknappui.h"

#include <layoutmetadata.cdl.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <aknlayoutscalable_apps.cdl.h>

#include "aknkeypad.h"

#if defined( RD_SCALABLE_UI_V2)

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

#include "aknbutton.h"

// For MAknMfneCommandObserver

#include <aknmfnecommandobserver.h>

#endif //if defined( RD_SCALABLE_UI_V2)

#include <aknlocationed.h>

#include <eikdialg.h>

#include <eikdialogext.h>

#include <gulicon.h>

#include <StringLoader.h>

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

#include <tacticon.h>

const TInt KPinCodeTacticonInterval = 30000000; // 30s

const TInt KPinCodeMaxTacticons = 10;

/*******

 * CAknQueryControlExtension

 */

NONSHARABLE_CLASS(CAknQueryControlExtension) : public CBase

{

public:

    ~CAknQueryControlExtension();

	CAknLocationEditor *iLocationEd;

	// Saved animation ID for later updates due to skin change.

	// The value is saved in CAknQueryControl::ConstructQueryL().

	TInt iAnimationId;

	HBufC* iOriginalPrompt;

	CAknButton* iBackspaceButton;

	CAknKeypad* iKeypad;

	// Flag indicating whether or not the query CBA has been

	// changed to ECS softkeys (Call and Cancel).

	TBool iEcsCbaShown;

    // Timer for pincode query tacticon playback

    CPeriodic* iPinTacticonTimer;

    // Counter for tacticons played in a pincode query

    TInt iPinTacticonsPlayed;

};

CAknQueryControlExtension::~CAknQueryControlExtension()

    {

    delete iOriginalPrompt;

    delete iBackspaceButton;

    delete iKeypad;

    delete iPinTacticonTimer;

    iPinTacticonTimer = NULL;

    }

CAknLocationEditor *CAknQueryControl::LocationEd() const

{

   if (iExtension)

	return iExtension->iLocationEd;

   else

	return NULL;

}

CAknLocationEditor *&CAknQueryControl::LocationEd()

{

	return iExtension->iLocationEd;

}

/*****************************

 * CAknQueryExtension

 *****************************/

void CAknQueryExtension::CreateEditorContextL()

    {

    delete iEditorContext;

    iEditorContext = NULL;

    iEditorContext = CAknsFrameBackgroundControlContext::NewL(

        KAknsIIDQsnFrInput, TRect(0,0,1,1), TRect(0,0,1,1), EFalse );

    }

CAknsFrameBackgroundControlContext* CAknQueryExtension::EditorContext()

    {

    return iEditorContext;

    }

CAknQueryExtension* CAknQueryExtension::Instance(

    const CAknQueryControl* aQueryControl )

    {

    return static_cast<CAknQueryExtension*>(

        AknsPointerStore::RetrievePointer( 

        static_cast<const CBase*>(aQueryControl) ) );

    }

void CAknQueryExtension::CreateExtensionL(

    const CAknQueryControl* aQueryControl )

    {

    CAknQueryExtension* extension = CAknQueryExtension::NewL();

    CleanupStack::PushL( extension );

    AknsPointerStore::StorePointerL( 

        static_cast<const CBase*>(aQueryControl), extension );

    CleanupStack::Pop(); // extension

    }

void CAknQueryExtension::DestroyExtension(

    const CAknQueryControl* aQueryControl )

    {

    delete Instance( aQueryControl );

    AknsPointerStore::RemovePointer( 

        static_cast<const CBase*>(aQueryControl) );

    }

CAknQueryExtension* CAknQueryExtension::NewL()

    {

    return new (ELeave) CAknQueryExtension();

    }

CAknQueryExtension::~CAknQueryExtension()

    {

    delete iEditorContext;

    }

/*****************************

 * TAknQueryEcsObserver

 *****************************/

/**

*

* This class is local to this cpp file.  It is used to ensure that all reference to aknecs.h is 

* done within the CAknQueryControl class implementation and not in its header; that would cause

* the client of CAknQueryControl (probably via CAknQueryDialog) to have to have Shared data and 

* phone client .h files in the INCLUDE path 

*

*/

NONSHARABLE_CLASS(TAknQueryEcsObserver): public MAknEcsObserver

    {

    public:

        TAknQueryEcsObserver( CAknQueryControl* aParent );

        // May be called from a sub-class of CAknEcsDetector in another DLL

        IMPORT_C virtual void HandleEcsEvent(CAknEcsDetector* /*aDetector*/, CAknEcsDetector::TState aUpdatedState);

    private:

        CAknQueryControl* iParent; // Not owned; set by constructor initializaton

    };

TAknQueryEcsObserver::TAknQueryEcsObserver( CAknQueryControl* aParent ): iParent( aParent )

    {

    }

EXPORT_C void TAknQueryEcsObserver::HandleEcsEvent( CAknEcsDetector* /*aDetector*/,

                                                    CAknEcsDetector::TState aUpdatedState )

    {

    TRAP_IGNORE( iParent->SetEcsCbaVisibleL( aUpdatedState == CAknEcsDetector::ECompleteMatch ) );

    // Hide the emergency call number again.

    // Number should be visible only in Partial or Complete match state

    if ( aUpdatedState != CAknEcsDetector::EPartialMatch &&

         aUpdatedState != CAknEcsDetector::ECompleteMatch  )

        {

        if ( iParent->QueryType() == EPinLayout )

            {

            static_cast<CAknNumericSecretEditor*>

                ( iParent->ControlByLayoutOrNull( EPinLayout ) )->RevealSecretText( EFalse );

            }

        }

    // This check must be last action in the routine.  

    // If the query is cancelled, the iParent is deleted!

    if ( aUpdatedState == CAknEcsDetector::ECallAttempted )

        {

        TRAP_IGNORE( iParent->CancelQueryL() );

        }

    }

const TInt KMaxLinesInQuery=5;

/*****************************

 * CAknQueryControl

 *****************************/

/************************************************

 * KQueryTypeToLayout

 * 

 * The index into this table is the query type, 

 * according to the query constants enum in 

 * avkon.hrh. The values

 * are the layout methods according to the enum

 * TLayoutMethod. So this table maps a query type

 * as read from resource file to a lyout method

 ************************************************/

const CAknQueryControl::TLayoutMethod KQueryTypeToLayout[]= {

    CAknQueryControl::EDataQueryLayoutM,   // NOT USED  

    CAknQueryControl::EDataQueryLayoutM,   // EDataLayout=1,

    CAknQueryControl::EConfQueryLayoutM,   // EConfirmationQueryLayout and EConfirmationLayout

    CAknQueryControl::ECodeQueryLayoutM,   // ECodeLayout,

    CAknQueryControl::ETimeQueryLayoutM,   // ETimeLayout,

    CAknQueryControl::EDateQueryLayoutM,   // EDateLayout,

    CAknQueryControl::ECodeQueryLayoutM,   // EListLayout,

    CAknQueryControl::ECodeQueryLayoutM,   // EMultiListLayout,

    CAknQueryControl::ECodeQueryLayoutM,   // EMultiLineDataLayout,

    CAknQueryControl::ETimeQueryLayoutM,   // EDurationLayout,

    CAknQueryControl::ECodeQueryLayoutM,   // ETextSoftNotification, - THIS IS USED FOR NOTES

    CAknQueryControl::EDataQueryLayoutM,   // ENumberLayout,

    CAknQueryControl::ECodeQueryLayoutM,   // EPinLayout,

    CAknQueryControl::EDataQueryLayoutM,   // EPhoneLayout,

    CAknQueryControl::EDataQueryLayoutM,   // EMessageQueryLayout,

    CAknQueryControl::EDataQueryLayoutM,   // EStaticSizeDataLayout

    CAknQueryControl::EDataQueryLayoutM,   // EFloatingPointLayout

    CAknQueryControl::ETimeQueryLayoutM,   // EIpLayout

    CAknQueryControl::EDataQueryLayoutM,    // EFixedPointLayout

    CAknQueryControl::EDataQueryLayoutM    // EDataLayoutAllowEmptyInput - USED FOR EMPTY INPUT

    };

///

/// Construction and Destruction methods

///

/**

 *

 */

EXPORT_C CAknQueryControl::CAknQueryControl() :/* iQueryType(EConfirmationLayout),*/ iNumberOfEditorLines(-1), iHasEditor(EFalse)

    {

    AKNTASHOOK_ADD( this, "CAknQueryControl" );

    }

/**

 *

 */

EXPORT_C CAknQueryControl::~CAknQueryControl()

    {

    AKNTASHOOK_REMOVE();

	if (iEdwin)

        AknsUtils::DeregisterControlPosition(iEdwin);

    else if (iNumberEdwin)

        AknsUtils::DeregisterControlPosition(iNumberEdwin);

    else if (iFloatingPointEditor)

        AknsUtils::DeregisterControlPosition(iFloatingPointEditor);

    else if (iDateEdwin)

        AknsUtils::DeregisterControlPosition(iDateEdwin);

    else if (iTimeEdwin)

        AknsUtils::DeregisterControlPosition(iTimeEdwin);

    else if (iDurationEdwin)

        AknsUtils::DeregisterControlPosition(iDurationEdwin);

    else if (iSecretEd)

        AknsUtils::DeregisterControlPosition(iSecretEd);

    else if (iPinEdwin)

        AknsUtils::DeregisterControlPosition(iPinEdwin);

    else if (iExtension && LocationEd())

    	AknsUtils::DeregisterControlPosition(LocationEd());

    delete iLineWidths;

    delete iEcsDetector;

    delete iEcsObserver;

    delete iPrompt;

    delete iEditIndicator;

    if ( iImage && iImage->IsPictureOwnedExternally() )

        {

        delete ((CApaMaskedBitmap*) iImage->Bitmap());

        }

    delete iImage;

    delete iEdwin;

    delete iDateEdwin;

    delete iTimeEdwin;

    delete iDurationEdwin;

    delete iSecretEd;

    delete iNumberEdwin;

    delete iPinEdwin;

    delete iFloatingPointEditor;

    if (iExtension)

    delete LocationEd();

    delete iAnimation;

    if ( iQueryType ) // As we must maintain BC, we cannot add private members or change protected members. 

        {         // We have to use iQueryType to distinguish if the context was added to stack or not

              // This won't affect to normal usage of iQueryType any way, only a way to indicate if 

                          // construction was succesful until context was set. 

        CCoeBrushAndPenContext* brushAndPenContext = (CCoeBrushAndPenContext*)ControlContext();

        delete brushAndPenContext;

        }

    CAknQueryExtension::DestroyExtension( this );

	delete iExtension;

#if defined( RD_SCALABLE_UI_V2)

    delete iIncreaseValueButton;

    delete iDecreaseValueButton;

#endif //defined( RD_SCALABLE_UI_V2)

    }

/**

 * Construct from resource

 */

EXPORT_C void CAknQueryControl::ConstructFromResourceL(TResourceReader &aRes)

    {

    // Construct extension

    CAknQueryExtension::CreateExtensionL( this );

	iExtension = new (ELeave)CAknQueryControlExtension;

    iEcsObserver   = new (ELeave) TAknQueryEcsObserver(this);

    iEditIndicator = CAknQueryEditIndicator::NewL(this);

    iEditIndicator->SetObserver(this);

    iLineWidths = new(ELeave)CArrayFixFlat<TInt>(5);

    CCoeBrushAndPenContext* brushAndPenContext=CCoeBrushAndPenContext::NewL();

    brushAndPenContext->SetBrushStyle(CGraphicsContext::ENullBrush);

    SetControlContext(brushAndPenContext);

    // This must be straight after setting Graphics Context, it is the only way to indicate

    // brushAndPenContext is added to stack or not.

    iQueryType = aRes.ReadUint16();

    __ASSERT_DEBUG(iQueryType, Panic(EAknPanicLayoutResourceProblem));

    iEditIndicator->SetQueryType(iQueryType);

    SetLineWidthsL();

    ReadPromptL(aRes);

    ConstructQueryL(aRes);

    CEikDialog* dlg;

    MopGetObject( dlg );

    if ( dlg )

        {

        if ( CAknEnv::Static()->TransparencyEnabled() )

            {

            dlg->Extension()->iPublicFlags.Set( CEikDialogExtension::EClipChildControlRect );

            }

        // set dialog's window as button group's container window in case a fullscreen

        // virtual input dialog is requested

        if ( EmbeddedVirtualInput() )

            {   

            CEikCba* cba = static_cast<CEikCba*>( dlg->ButtonGroupContainer().ButtonGroup() );

            cba->SetContainerWindowL( *this );

            dlg->ButtonGroupContainer().SetContainerWindowL( *cba );

            dlg->ButtonGroupContainer().SetParent( NULL );

            cba->SetPosition( TPoint( 0, 0 ) );

            iExtension->iKeypad = CAknKeypad::NewL( *this, iQueryType );

            }

        }

    }

void CAknQueryControl::ConstructQueryL(TResourceReader& aRes)

    {

    switch(iQueryType)

        {

        case EConfirmationQueryLayout:

            {

            TPtrC bmpFile=aRes.ReadTPtrC();

            TInt bmpId=aRes.ReadInt16();

            TInt bmpMask=aRes.ReadInt16();

            TInt animationId = aRes.ReadUint32();

            // Animation overrides bitmap if it is set.

            if ( (animationId == 0) && (bmpFile.Length() != 0))

                {   

                iImage = new(ELeave) CEikImage;

                iImage->SetContainerWindowL(*this);

                TBool skinnedFound( EFalse );

                if ( bmpFile.CompareF(KAvkonBitmapFile) == 0 ) // Skinning is supported only avkon bitmaps

                    {

                    TAknsItemID id;

                    id.Set(0,0);

                    id = CAknNoteAttributes::GetSkinnedBitmapID(bmpId);

                    if ( id.iMajor && id.iMinor ) // skin id found, try loading

                        {

                        CApaMaskedBitmap* bitmap = NULL;

                        MAknsSkinInstance* skin = AknsUtils::SkinInstance();

                        TRAPD( err, bitmap = AknsUtils::CreateMaskedBitmapL(skin,id));

                        if ( !err ) 

                            {

                            CFbsBitmap* mask = bitmap->Mask();

                            iImage->SetPicture(bitmap,mask);

                            iImage->SetPictureOwnedExternally(ETrue);

                            skinnedFound = ETrue;

                            }

                        }

                    }

                if ( !skinnedFound) 

                    {

                    iImage->CreatePictureFromFileL(bmpFile,bmpId,bmpMask);

                    }

                }

            else

                {

                if (animationId == 0) 

                    {

                    // Default animation if neither bitmap nor animation is set.

                    animationId = R_QGN_NOTE_QUERY_ANIM;

                    }

                }

            if (animationId != 0)

                {

                if (!iAnimation)

                    {// no animation previously set

                    // Save animation ID for possible skin changes

                    //iExtension->iAnimationId = animationId; 

                    TRAPD( err, SetAnimationL( animationId ) );

                    if ( err != KErrNone )

                        {

                        iAnimation = NULL;

                        }

                    }

                }

            break;

            }

        case EDataLayoutAllowEmptyInput:

            {

            CAknQueryExtension* extension = QueryExtension();

            if( extension )

                {

                extension->iAllowEmptyInput = ETrue;

                }

            iQueryType = EDataLayout;    

            // fall through

            }

        case EDataLayout:

        case EStaticSizeDataLayout:

            {

            iEdwin = new(ELeave)CEikEdwin;

            iEdwin->SetContainerWindowL(*this);

            iEdwin->SetEdwinObserver(this);

            iEdwin->ConstructFromResourceL(aRes);

            iEdwin->SetObserver(this);

            iEdwin->SetEdwinSizeObserver(this);

#if defined( RD_SCALABLE_UI_V2)

            if ( AknLayoutUtils::PenEnabled() )

                {

                if ( EmbeddedVirtualInput() )

        			{

      				CreateBackspaceButtonL();