/*

* 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 dialogs.

*

*/

#include <barsread.h>

#include <eikbtgpc.h>

#include <eikcapc.h>

#include <eiktxlbm.h>

#include "avkon.hrh"

#include <avkon.rsg>

#include <avkon.mbg>

#include "AknQueryDialog.h" 

#include "aknQueryControl.h"

#include "aknmultilinequerycontrol.h"

#include "aknPopupHeadingPane.h"

#include "AknPanic.h"

#include "aknborders.h"

#include "aknpopuplayout.h"

#include "aknenv.h"

#include "aknconsts.h"

#include "aknsoundsystem.h"

#include <AknsDrawUtils.h>

#include <AknsFrameBackgroundControlContext.h>

#include "AknDebug.h"

#include <layoutmetadata.cdl.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <akntouchpane.h>

#ifdef RD_UI_TRANSITION_EFFECTS_POPUPS

#include <gfxtranseffect/gfxtranseffect.h>

#include <akntransitionutils.h>

#include <akntranseffect.h>

#endif

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

#include "akntrace.h"

/**

 *  CAknQueryDialogExtension  

 */

NONSHARABLE_CLASS(CAknQueryDialogExtension) : public CBase, public MCoeCaptionRetrieverForFep

{

public:

    /**

     * Destructor.

     */

    ~CAknQueryDialogExtension();

    /**

     * Constructor.

     */

    CAknQueryDialogExtension(CAknQueryDialog* aQueryDialog);

private:

    /**

     * from MCoeCaptionRetrieverForFep

     * fill aCaption with the target control's caption 

     */

  	IMPORT_C virtual void GetCaptionForFep(TDes& aCaption) const;

public:

    CAknQueryDialog* iParent;

};

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

// Destructor

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

//

CAknQueryDialogExtension::~CAknQueryDialogExtension()

    {

    _AKNTRACE( "[%s][%s] do nothing", "CAknQueryDialogExtension", "~CAknQueryDialogExtension" );

    }

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

// Constructor

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

//

CAknQueryDialogExtension::CAknQueryDialogExtension

    (CAknQueryDialog* aQueryDialog) : iParent(aQueryDialog)

    {

    _AKNTRACE( "[%s][%s] do nothing", "CAknQueryDialogExtension", "CAknQueryDialogExtension" );

    }

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

// GetCaptionForFep

// Overrides MCoeCaptionRetrieverForFep::GetCaptionForFep

// Responsible for retrieving the caption from query dialog to FEP

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

//

EXPORT_C void CAknQueryDialogExtension::GetCaptionForFep(TDes& aCaption) const

    {

    _AKNTRACE( "[%s][%s] enter aCaption:%s", "CAknQueryDialogExtension", "GetCaptionForFep" , &aCaption);

    aCaption = KNullDesC;

    CAknQueryControl* control = iParent->QueryControl();

    if ( control )

        {

        // Returns prompt of query control if it's available

        control->GetCaption(aCaption);

        }

    else

        {

        // Returns heading text if heading pane is available

        CAknPopupHeadingPane* controlHeading = iParent->QueryHeading();

        if ( controlHeading )

            {

            TPtr headTitle= controlHeading->PromptText();

            if ( headTitle != KNullDesC )

                {

                const TInt maximumLength = aCaption.MaxLength();

                if ( headTitle.Length() > maximumLength )

                    {

                    aCaption=headTitle.Left(maximumLength);

                    }

                else

                    {

                    aCaption= headTitle;

                    }

                }

            }

        }

    _AKNTRACE( "[%s][%s] exit aCaption:%s", "CAknQueryDialogExtension", "GetCaptionForFep" , &aCaption);

    }

/**

 *  CAknMultilineQueryDialogExtension  

 */

NONSHARABLE_CLASS(CAknMultilineQueryDialogExtension) : public CAknQueryDialogExtension

{

public:

    enum TQueryType

        {

        EMultDataQuery,

        EMultIPQuery

        };

    /**

     * Destructor.

     */

    ~CAknMultilineQueryDialogExtension();

    /**

     * Constructor.

     */

    CAknMultilineQueryDialogExtension(CAknQueryDialog* aQueryDialog, TInt aQueryType);

private:

    /**

     * from MCoeCaptionRetrieverForFep

     * fill aCaption with the target control's caption 

     */

  	IMPORT_C void GetCaptionForFep(TDes& aCaption) const;

public:

    TInt iQueryType;

};

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

// Destructor

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

//

CAknMultilineQueryDialogExtension::~CAknMultilineQueryDialogExtension()

    {

    _AKNTRACE( "[%s][%s] do nothing", "CAknMultilineQueryDialogExtension", "~CAknMultilineQueryDialogExtension" );

    }

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

// Constructor

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

//

CAknMultilineQueryDialogExtension::CAknMultilineQueryDialogExtension

    (CAknQueryDialog* aQueryDialog, TInt aQueryType):CAknQueryDialogExtension(aQueryDialog),iQueryType(aQueryType)

    {

    _AKNTRACE( "[%s][%s] do nothing", "CAknMultilineQueryDialogExtension", "CAknMultilineQueryDialogExtension" );

    }

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

// GetCaptionForFep

// Overrides MCoeCaptionRetrieverForFep::GetCaptionForFep

// Responsible for retrieving the caption from query dialog to FEP

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

//

EXPORT_C void CAknMultilineQueryDialogExtension::GetCaptionForFep(TDes& aCaption) const

    {

    switch(iQueryType)

        {

        case EMultDataQuery:

            {

            CAknMultiLineDataQueryDialog* dialog = static_cast<CAknMultiLineDataQueryDialog*>(iParent);

            if( dialog )

                {

                CAknMultilineQueryControl* control = NULL;

                if( dialog->CurrentLine() == 0 )

                    {

                    control = dialog->FirstControl();

                    }

                else if ( dialog->CurrentLine() == 1 )

                    {

                    control = dialog->SecondControl();

                    }

                if(control)

                    {

                    // Returns prompt of current focused control

                    control->GetCaption(aCaption);

                    }

                }

            }

            break;

        case EMultIPQuery:

            {

            CAknMultiLineIpQueryDialog* dialog = static_cast<CAknMultiLineIpQueryDialog*>(iParent);

            if( dialog )

                {

                CAknExtMultilineQueryControl* control = NULL;

                if( dialog->CurrentLine() == 0 )

                    {

                    control = dialog->FirstControl();

                    }

                else if( dialog->CurrentLine() == 1 )

                    {

                    control = dialog->SecondControl();

                    }

                if( control )

                    {

                    // returns prompt of current focused control

                    control->GetCaption(aCaption);

                    }

                }

            }

            break;

        default:

            break;

        }

    // if there's no prompt, then return heading text in heading pane

    if ( aCaption == KNullDesC )

        {

        // returns heading text if heading pane is available

        CAknPopupHeadingPane* controlHeading = iParent->QueryHeading();

        if ( controlHeading )

            {

            TPtr headTitle= controlHeading->PromptText();

            if ( headTitle != KNullDesC )

                {

                const TInt maximumLength = aCaption.MaxLength();

                if ( headTitle.Length() > maximumLength )

                    {

                    aCaption=headTitle.Left(maximumLength);

                    }

                else

                    {

                    aCaption= headTitle;

                    }

                }

            }

        }

    }

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

 * CAknQueryDialog

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

/**

 * Second phase construction required to align with multiline queries API

 * In future might use MAknQueryData mixin in the base class, hence requiring

 * second phase construction.

 */

EXPORT_C CAknQueryDialog* CAknQueryDialog::NewL(const TTone& aTone)

    {

    _AKNTRACE_FUNC_ENTER;

    CAknQueryDialog* self = new (ELeave) CAknQueryDialog(aTone);

    AKNTASHOOK_ADDL( self, "CAknQueryDialog" );

    _AKNTRACE_FUNC_EXIT;

    return self;

    }

/**

 * Return pointer to CAknTextQueryDialog

 */

EXPORT_C CAknQueryDialog* CAknQueryDialog::NewL(TDes& aText, const TTone& aTone)

    {

    return CAknTextQueryDialog::NewL(aText,aTone);

    }

/**

 * Return pointer to CAknNumberQueryDialog

 */

EXPORT_C CAknQueryDialog* CAknQueryDialog::NewL(TInt& aNumber, const TTone& aTone)

    {

    return CAknNumberQueryDialog::NewL(aNumber,aTone);

    }

/**

 * Return pointer to CAknTimeQueryDialog

 */

EXPORT_C CAknQueryDialog* CAknQueryDialog::NewL(TTime& aTime, const TTone& aTone)

    {

    return CAknTimeQueryDialog::NewL(aTime,aTone);

    }

/**

 * Return pointer to CAknDurationQueryDialog

 */

EXPORT_C CAknQueryDialog* CAknQueryDialog::NewL(TTimeIntervalSeconds& aDur, const TTone& aTone)

    {

    return CAknDurationQueryDialog::NewL(aDur,aTone);

    }

/**

 * Return pointer to CAknFloatQueryDialog

 */

EXPORT_C CAknQueryDialog* CAknQueryDialog::NewL(TReal& aNumber, const TTone& aTone)

    {

    return CAknFloatingPointQueryDialog::NewL(aNumber,aTone);

    }

/**

 * Return pointer to CAknIpQueryDialog

 */

EXPORT_C CAknQueryDialog* CAknQueryDialog::NewL(TInetAddr& aInetAddr, const TTone& aTone)

    {

    return CAknIpAddressQueryDialog::NewL(aInetAddr,aTone);

    }

EXPORT_C CAknQueryDialog* CAknQueryDialog::NewL(TPosition &/*aPosition*/, const TTone& /*aTone*/)

	{

	//return CAknLocationQueryDialog::NewL(aPosition, aTone);

	return NULL;

	}

EXPORT_C CAknQueryDialog::CAknQueryDialog(const TTone& aTone)

    {

    _AKNTRACE_FUNC_ENTER;

#ifdef RD_UI_TRANSITION_EFFECTS_POPUPS

    GfxTransEffect::Register( this, KGfxQueryControlUid );

#endif

    iTone = aTone;

    if (iEikonEnv->AppUi())

        {

         iSoundSystem = iAvkonAppUiBase->KeySounds();          

        }

    _AKNTRACE( "[%s][%s] iTone: %d", "CAknQueryDialog", __FUNCTION__, iTone );

    _AKNTRACE_FUNC_EXIT;

    } 

/**

 * deprecated

 */

EXPORT_C CAknQueryDialog::CAknQueryDialog()

    {

    iTone = ENoTone;

    if (iEikonEnv->AppUi())

        {

         iSoundSystem = iAvkonAppUiBase->KeySounds();          

        }

    } 

/**

 * deprecated

 */

EXPORT_C CAknQueryDialog::CAknQueryDialog(TDesC& aPrompt,const TTone& aTone)

    {

    iTone = aTone;

    if (iEikonEnv->AppUi())

        {

        iSoundSystem = iAvkonAppUiBase->KeySounds();          

        }

    TRAP_IGNORE(SetPromptL(aPrompt));

    }

EXPORT_C CAknQueryDialog::~CAknQueryDialog()

    {

    _AKNTRACE( "[%s][%s] Enter", "CAknQueryDialog", "~CAknQueryDialog" );

    AKNTASHOOK_REMOVE();

    delete iPrompt;

    delete iExtension;

#ifdef RD_UI_TRANSITION_EFFECTS_POPUPS

    CAknTransitionUtils::RemoveData( ( TInt )this );

#endif

    _AKNTRACE( "[%s][%s] Exit", "CAknQueryDialog", "~CAknQueryDialog" );

    }

EXPORT_C TInt CAknQueryDialog::RunLD()

    {

    _AKNTRACE_FUNC_ENTER;

    CAknDialog::ConstructL( R_AVKON_MENUPANE_EMPTY) ;

    ReportUserActivity();

    PlayTone();

    CAknKeySoundSystem* soundSystem = NULL;

    if (iSoundSystem)

        {

        iSoundSystem->PushContextL(R_AVKON_DEFAULT_SKEY_LIST);

        // Need to store local copy of iSoundSystem, since it will have been

        // destroyed when RunLD returns

        soundSystem = iSoundSystem;

        }

    CAknsFrameBackgroundControlContext* cc = (CAknsFrameBackgroundControlContext*)AknsDrawUtils::ControlContext( this );

    cc->SetCenter(KAknsIIDQsnFrPopupCenterQuery);

    SetGloballyCapturing(ETrue); 

    TInt ret = CAknDialog::RunLD();

    _AKNTRACE( "[%s][%s] ret: %d", "CAknQueryDialog", __FUNCTION__, ret );

    if (soundSystem)

        {

        soundSystem->PopContext();

        }

    _AKNTRACE_FUNC_EXIT;

    return ret;

    }

/**

 * deprecated

 */

EXPORT_C TInt CAknQueryDialog::RunDlgLD(TInt aResourceId)

    {

    return ExecuteLD(aResourceId);

    }

/**

 * Call PrepareLC and display dialog.

 *

 * Identical to version in CEikDialog but need to override 

 * this because of version with prompt,

 * compiler will complain if this is not implemented in

 * derived class as well

 */

EXPORT_C TInt CAknQueryDialog::ExecuteLD(TInt aResourceId)

    {

    _AKNTRACE_FUNC_ENTER;

    _AKNTRACE( "[%s][%s] aResourceId: %d", "CAknQueryDialog", __FUNCTION__, aResourceId );

    PrepareLC(aResourceId);

    TInt ret = RunLD();

    _AKNTRACE( "[%s][%s] ret:%d", "CAknQueryDialog", __FUNCTION__,ret );

    _AKNTRACE_FUNC_EXIT;

    return ret;

    }

/**

 * Call PrepareLC, set the prompt and display dialog.

 */

EXPORT_C TInt CAknQueryDialog::ExecuteLD(TInt aResourceId,const TDesC& aPrompt)

    {

    _AKNTRACE_FUNC_ENTER;

    PrepareLC(aResourceId);

    SetPromptL(aPrompt);

    _AKNTRACE( "[%s][%s] aResourceId: %d", "CAknQueryDialog", __FUNCTION__, aResourceId );

    TInt ret= RunLD();

    _AKNTRACE( "[%s][%s] ret:%d", "CAknQueryDialog", __FUNCTION__,ret );

    _AKNTRACE_FUNC_EXIT;

    return ret;

    }

/**

 * Get layout information from the control and use this layout

 * information to do layout. If there is a heading, add the 

 * heading height to the height returned by the control layout

 * as long as it still fits on the screen.

 *

 * Assume there is always a control panel present. If we used

 * iAvkonAppUi->ClientRect() this would return the correct size

 * available depending on whether the control pane is there or not.

 * However then global queries (drawn by eiksrv which has no control

 * pane) get confused because they appear on top of a focused apps

 * which does have a control pane.

 *

 * Therefore use iAvkonAppUi->ApplicationRect() minus the height 

 * of the control pane (KAknSoftkeyPaneHeight) instead of ClientRect().

 */

EXPORT_C void CAknQueryDialog::SetSizeAndPosition( const TSize& /*aSize*/ )

    {

    _AKNTRACE_FUNC_ENTER;

    CAknQueryControl* control = QueryControl();

    CAknPopupHeadingPane* controlHeading = QueryHeading();

    if(control)

        {

        //this is because prompt must be relayouted before setting dialog size

        //in case of a layout switch - adding HandleResourceChange to

        //dialog is not possible anymore

        control->HandleResourceChange(KEikDynamicLayoutVariantSwitch);