/*

* Copyright (c) 2002-2007 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 query dialogs.

*

*/

#ifndef AKNQUERYDIALOG_H

#define AKNQUERYDIALOG_H

//  INCLUDES

#include <eikdialg.h>

#include <AknForm.h>

#include <eiklbx.h>

#include <eiktxlbx.h>

#include <eikcmobs.h>

#include <aknpopuplayout.h>

#include <aknintermediate.h>

#include <aknQueryControl.h>

#include <aknpopuplayout.h>

#include <aknmultilinequerycontrol.h>

#include <aknlistquerycontrol.h>

#include <aknintermediate.h>

#include <aknquerydata.h>

#include <avkon.hrh>

class CAknKeySoundSystem;

class TInetAddr;

class CAknQueryDialogExtension;

class CAknMultilineQueryDialogExtension;

/**

 * General query dialog

 *

 * Use for confirmation queries

 */

class CAknQueryDialog : public CAknDialog , public MAknQueryControlObserver

    {

    friend class CAknQueryDialogExtension;

    public:

        /**

         * Enumeration for tones.

         *

         * The tone played before the dialog is shown. Application specific

         * tones may be played by casting the application defined Sound ID

         * (SID), to @c TTone

         **/

      enum TTone {

        /**

         * No tone is played

        */

        ENoTone = 0,

        /**

         * A confirmation tone is played.

        */

        EConfirmationTone = EAvkonSIDConfirmationTone,

        /**

         * A warning tone is played.

        */

        EWarningTone = EAvkonSIDWarningTone,

        /**

         * An error tone is played.

        */

        EErrorTone = EAvkonSIDErrorTone

        };

    public:

        /**

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

         *

         * @return pointer to CAknQueryDialog

        */

        IMPORT_C static CAknQueryDialog* NewL(const TTone& aTone = ENoTone);

        /**

         *

         * @return pointer to CAknTextQueryDialog

        */

        IMPORT_C static CAknQueryDialog* NewL(TDes& aText, const TTone& aTone = ENoTone);

        /**

         *

         * @return pointer to CAknNumberQueryDialog

        */

        IMPORT_C static CAknQueryDialog* NewL(TInt& aNumber, const TTone& aTone = ENoTone);

        /**

         *

         * @return pointer to CAknTimeQueryDialog

        */

        IMPORT_C static CAknQueryDialog* NewL(TTime& aTime, const TTone& aTone = ENoTone);

        /**

         *

         * @return pointer to CAknDurationQueryDialog

        */

        IMPORT_C static CAknQueryDialog* NewL(TTimeIntervalSeconds& aTime, const TTone& aTone = ENoTone);

        /**

         *

         * @return pointer to CAknFloatQueryDialog

        */

        IMPORT_C static CAknQueryDialog* NewL(TReal& aNumber, const TTone& aTone = ENoTone);

        /**

         *

         * @return pointer to CAknIpQueryDialog

        */

        IMPORT_C static CAknQueryDialog* NewL(TInetAddr& aInetAddr, const TTone& aTone = ENoTone);

        /**

         * Not yet totally implemented!

         *

         * @return pointer to CAknLocationQueryDialog

        */

        IMPORT_C static CAknQueryDialog* NewL(TPosition &aValue, const TTone &aTone = ENoTone);

    public:

        IMPORT_C virtual ~CAknQueryDialog();

        /**

         * Construction

         *

         * @deprecated: will be made protected - use NewL

        */

        IMPORT_C CAknQueryDialog(const TTone& aTone);

    public:

        /**

         * Return pointer to query heading or NULL

         *

        */

        IMPORT_C virtual CAknPopupHeadingPane* QueryHeading() const;

        /**

         * Deprecated method to return pointer to query heading or NULL (use QueryHeading())

         *

         * @deprecated - will be removed (use QueryHeading() method instead)

        */

        IMPORT_C CAknPopupHeadingPane* Heading() const;

        /**

         * Set prompt text for query. This this will override text given in constructor.

         *

         * @param aPrompt  Text for prompt

        */

        IMPORT_C void SetPromptL(const TDesC& aPrompt);

        /**

         * Set visibility of the left softkey. Softkey is hidden when data in the query is not acceptable.

         * @param aVisible EFalse hides softkey label, ETrue shows it.

        */

        IMPORT_C void MakeLeftSoftkeyVisible(TBool aVisible);

        /**

         * Enable or disable emergency call support.  This method is only valid in

         * numeric queries (secret or normal).

         *

         * Default is Off for both.

         *

         * @param aOnOff    Sets emergency call support active or inactive, if feature is available in

         *                  current type of control

         */

        IMPORT_C void SetEmergencyCallSupport( TBool aOnOff );

        /**

         * Removes the editor indicators for this dialog.

         * Used to ensure this dialog does not own any editor indicators.

         * before opening another dialog which outlasts this one.

        */

        IMPORT_C void RemoveEditorIndicator();

        /**

         * This method can be used to set predictive text entry permitted.  The default

         * Query behaviour is to supress predictive entry (over-riding editor resource

         * flags that may indicate otherwise.

         *

         * This may be called at any time prior to activation of the query.

         *

         * @param aPermitted    ETrue - allow predictive text entry

         *

         */

        IMPORT_C void SetPredictiveTextInputPermitted( TBool aPermitted );

        /**

         * Runs the querydialog and returns the ID of the button used to dismiss it.

         * The dialog is destroyed on exit.

         *

        */

        IMPORT_C TInt RunLD();

        /**

         * 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

         *

         * @param aResourceId    resource for query

        */

        IMPORT_C TInt ExecuteLD(TInt aResourceId);

        /**

         * Call PrepareLC and display dialog.

         *

         * @param aResourceId    resource for query

         * @param aPrompt    text for query prompt

        */

        IMPORT_C TInt ExecuteLD(TInt aResourceId, const TDesC& aPrompt);

    public:// from CCoeControl

        /**

         * From @c CCoeControl<p>

         * Handle key events. When a key event occurs,

         * until one of them returns EKeyWasConsumed to indicate that it processed the key event.

         * CONE calls this function for each control on the control stack,

         * @param aKeyEvent  The key event.

         * @param aType      The type of the event: EEventKey, EEventKeyUp or EEventKeyDown.

         * @return           Indicates whether or not the key event was used by this control.

        */

        IMPORT_C TKeyResponse OfferKeyEventL(const TKeyEvent& aKeyEvent, TEventCode aType);

        /**

         * Handles pointer events

        */

        IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);

    public:

        /**

         * Return the maximum possible length of the query text

         * This is (in order of precedence, and assuming they are valid

         * i.e. less than or equal to the length of the descriptor passed to

         * return the value) dependent on:<p>

         * 1) aApiValue<p>

         * 2) Resource set value held in aControl<p>

         * 3) The MaxLength of the descriptor

         * @return maximum text length

        */

        IMPORT_C static TInt MaxTextLength(const CAknQueryControl* aControl, const TDes& aDataText, TInt aApiValue) ;

    protected://from CEikdialog

        /**

         * From @c CEikdialog<p>

         * EIKON provides an implementation of this function,

         * which positions the dialog in the centre of the screen.

         * However, it can be overridden by derived classes.

         * @param aSize      The size for the dialog.

        */

        IMPORT_C void SetSizeAndPosition(const TSize& aSize);

        /**

         * From @c CEikdialog<p>

         * This function is called by the EIKON dialog framework just before the dialog is activated, but before it is sized,

         * and before PostLayoutDynInitL() is called.

        */

        IMPORT_C void PreLayoutDynInitL(void);

        /**

         * From @c CEikdialog<p>

         * This function is called by the EIKON dialog framework just before the dialog is activated,

         * after it has called PreLayoutDynInitL() and the dialog has been sized.

        */

        IMPORT_C void PostLayoutDynInitL();

        /**

         * From @c CEikdialog<p>

         * This function is called by the EIKON framework

         * if the user activates a button in the button panel.

         * It is not called if the Cancel button is activated,

         * unless the EEikDialogFlagNotifyEsc flag is set.

         * @param aButtonId  The ID of the button that was activated

         * @return           Should return ETrue if the dialog should exit, and EFalse if it should not.

        */

        IMPORT_C virtual TBool OkToExitL(TInt aButtonId);

    public://from MAknQueryControlObeserver

        /**

        * From @c MAknQueryControlObserver<p>

        * Gets called when editor sends size event.

        * @param aQueryControl  Pointer to query control which sent the event

        * @param aEventType     Type of the event

        */

        IMPORT_C TBool HandleQueryEditorSizeEventL(CAknQueryControl* aQueryControl, TQueryControlEvent aEventType);

        /**

        * From @c MAknQueryControlObserver<p>

        * Gets called when editor sends state event

        * @param aQueryControl  Pointer to query control which sent the event

        * @param aEventType     Type of the event

        * @param aStatus        Editor validation status

        */

        IMPORT_C TBool HandleQueryEditorStateEventL(CAknQueryControl* aQueryControl, TQueryControlEvent aEventType, TQueryValidationStatus aStatus);

        /**

        * Called by OfferkeyEventL(), gives a change to dismiss the query even with

        * keys different than Enter of Ok.

        */

        IMPORT_C virtual TBool NeedToDismissQueryL(const TKeyEvent& aKeyEvent);

        /**

        * Called by NeedToDismissQueryL(), gives a change to either accept or reject

        * the query. Default implementation is to accept the query if the Left soft

        * key is displayed and reject it otherwise. Left softkey is only displayed if

        * the query has valid data into it.

        */

        IMPORT_C virtual void DismissQueryL();

    protected:

        /**

        * If the query text is ok (retrieved form query control) then display the

        * left soft key, otherwise hide it.

        */

        IMPORT_C virtual void  UpdateLeftSoftKeyL();

        /**

        * Set the prompt inside the query control. If dialog is active redo

        * layout and draw.

        */

        IMPORT_C virtual void DoSetPromptL();

        /**

        * Return pointer to query control or NULL

        *

        */

        IMPORT_C virtual CAknQueryControl* QueryControl() const;

    protected: //implementation, intended to be used but not overwritten

        /**

        * Plays tone

        */

        void  PlayTone();

        /**

        * Resets system's inactivity timer

        */

        void  ReportUserActivity() const ;

        /**

        * Recreates layout and redraws the dialog

        */

        void  LayoutAndDraw();

        /**

        * Returns left CBA short key press

        * @return Id of the left CBA

        */

        TInt  GetLeftCBAShortKeyPress();

        /**

        * Returns right CBA short key press

        * @return Id of the right CBA

        */

        TInt  GetRightCBAShortKeyPress();

        /**

        * Returns whether the left softkey is visible

        * @return ETrue is the left softkey is visible

        */

        TBool IsLeftSoftkeyVisible();

    protected:

        /**

         * Prompt access for derived classes

         */

        IMPORT_C TPtrC Prompt() const;

        /**

         * @return query tone

        */

        TTone& Tone() { return iTone; }

        /**

         * @return query tone

        */

        const TTone& Tone() const { return iTone; }

        /**

         * @return query flags

        */

        TBitFlags16& Flags() { return iFlags; }

        /**

         * @return query flags

        */

        const TBitFlags16& Flags() const { return iFlags; }

        /**

         * @return query sound system

        */

        CAknKeySoundSystem* SoundSystem() const { return iSoundSystem; }

    protected: // collected code for accessing Dialog state.

        /**

         * To be used to go through every control in the dialog, on every page,

         * in Dialog-internal storage order, until a control with that type is found.

         * If such a control is not found, a null pointer will be returned.

         * @param aControlType - Enum used to identify the control type on that CEikCaptionedControl Line

         * @param aLineIndex - Optional argument, if used contains reference to an int which holds the initial

         *       line to start searching on, and on finding a control of that type, is

         *       assigned the next position to start searching.

         * @param aPageIndex - Optional argument, if used contains reference to an int which holds the initial

         *       dialog page to start searching on, and on finding a control of that type, is

         *       assigned the page that the control was found on.

         *

        */

        CCoeControl* FindControlOnAnyPageWithControlType(TInt aControlType, TInt* aLineIndex=0, TInt* aPageIndex=0) const;

    protected:

        /**

         * Tone which is played when the query is executed

         * These will be made private, use protected methods

         *

         * @deprecated.

        */

        TTone  iTone;

        /** Prompt text*/

        TDesC *iPrompt;

        /** Caption Retriever*/

        CAknQueryDialogExtension* iExtension;

        /**

        * Flags for emergency call support

        * Need these at least to store the ECS state until the control exists

        */

        TBitFlags16 iFlags;

        /** Spare variable for further development */

        TInt iSpare_1;

        /** Sound system*/

        CAknKeySoundSystem* iSoundSystem;

    public:

        /**

         * @deprecated do not use

         */

        IMPORT_C CAknQueryDialog();

        /**

         * @deprecated do not use

        */

        IMPORT_C CAknQueryDialog(TDesC& aPrompt,const TTone& aTone = ENoTone);

        /**

         * @deprecated - use QueryHeading() method instead

         */

        IMPORT_C void SetHeaderTextL(const TDesC& aHeader);

        /**

         * @deprecated - use QueryHeading() method instead

         */

        IMPORT_C void SetHeaderImageL(CEikImage* aImage);

        /**

         * @deprecated - use RunLD or ExecuteLD instead

         */

        IMPORT_C TInt RunDlgLD(TInt aResourceId);

        /**

         * @deprecated - use other version of MaxTextLength

         */

        IMPORT_C static TInt MaxTextLength(const CAknQueryControl* aControl, const TDes* aDataText, TInt aApiValue);

    private:

        //From CAknControl

        IMPORT_C void* ExtensionInterface( TUid aInterface );

    private:

        IMPORT_C virtual void CEikDialog_Reserved_1();

        IMPORT_C virtual void CEikDialog_Reserved_2();

    private:

        IMPORT_C virtual void CAknDialog_Reserved();

    private:// new function

        IMPORT_C virtual void CAknQueryDialog_Reserved();

    public:        

        /**       

         * From CCoeControl.       

         * Gets the control's input capabilities.       

         *       

         * @return The control's input capabilities.       

         */          

        IMPORT_C TCoeInputCapabilities InputCapabilities() const;

        /**

         * Enable or disable support to change the CBA labels of the query

         * according to the current ECS state. It's necessary to enable this

         * alongside with ECS for touch and full screen queries.

         *  

         * Note that if enabling this, then it's not necessary to call  

         * @c SetEmergencyCallSupport( ETrue ) additionally, as when

         * enabling this, @c CAknQueryControl::EEmergencyCallsEnabledByAPI

         * will also be set. To enable the ECS via this method, it must

         * be called prior to @c PreLayoutDynamicInitL.