/*

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

*

*/

#ifndef __EIKDIALG_H__

#define __EIKDIALG_H__

#ifndef __COECOBS_H__

#include <coecobs.h>

#endif

#ifndef __COECCNTX_H__

#include <coeccntx.h>

#endif

#ifndef __EIKBCTRL_H__

#include <eikbctrl.h>

#endif

#ifndef __EIKDPOBS_H__

#include <eikdpobs.h>

#endif

#ifndef __BADESCA_H__

#include <badesca.h>

#endif 

#ifndef __GULFTFLG_HRH__

#include <gulftflg.hrh>

#endif

//

// Header files needed by deprecated interfaces.

//

#ifndef __EIKBUTB_H__

#include <eikbutb.h>

#endif

#ifndef __EIKBTGPC_H__

#include <eikbtgpc.h>

#endif

#include <AknPopupFader.h>

// constant definitions

const TInt KAknMediatorFacade(0x10275076);

class CEikMover;

class CEikCaptionedControl;

class CEikCapCArray;

class CEikDialogPageSelector;

class CEikButtonGroupContainer;

class CEikDialogButtonCommandObserver;

class MEikCommandObserver;

class CAknDialog;

class CAknNoteDialog;

struct SEikControlInfo;

class  CEikDialogExtension ;

// <SKIN>

class CAknsListBoxBackgroundControlContext ;

//

// Forward declarations needed by deprecated interfaces.

//

class CEikLabel;

class CGlobalText;

class MAknDialogMediatorObserver;

struct SEikRange;

struct SEikDegreesMinutesDirection;

/**

 * The @c CEikDialog class provides an instantiable base class for dialogs. 

 * Controls can be added directly to this class but it is normal to create

 * a subclass to handle the controls appearing on the dialog dynamically.

 */

class CEikDialog : public CEikBorderedControl,

                   public MCoeControlObserver,

                   public MEikDialogPageObserver,

                   public MCoeControlContext, 

                   public MAknFadedComponent

    { 

public:

    DECLARE_TYPE_ID(0x10282EA8)

	/**

     * C++ default constructor.

     */

    IMPORT_C CEikDialog(); 

    /**

     * Destructor.

     */

	IMPORT_C ~CEikDialog(); 

    /**

     * Loads, displays, and destroys the dialog.

     *

     * This function loads the specified dialog from a resource and displays

     * it. The method then destroys the dialog when it exits, therefore there

     * is no need for the application program to destroy the dialog.

     *

     * In the resource file, use the @c EEikBidOk dialog button ID for an 

     * OK/Done/Continue button and @c EEikBidCancel for a Cancel button.

     *

     * The function returns immediately unless @c EEikDialogFlagWait has been 

     * specified in the @c DIALOG resource. If @c EEikDialogFlagWait is 

     * specified, it returns when the dialog exits.

     * 

     * @param aResourceId The resource ID of the dialog to load.

     * @return Zero, unless it is a waiting dialog. For a waiting dialog, 

     *         the return value is the ID of the button that closed the dialog, 

     *         or zero if it was the cancel button (@c EEikBidCancel).

     */

	IMPORT_C virtual TInt ExecuteLD(TInt aResourceId);

    /**

     * Prepares the dialog, constructing it from the specified resource.

     * 

     * @param aResourceId The resource ID of the dialog.

     */

    IMPORT_C virtual void PrepareLC(TInt aResourceId);

    /**

     * Reads the dialog resources into the dialog, constructing it from the specified resource.

     * The function is only to help loading dialog resources and 

     * extracting dialog data, in other cases use (@c PrepareLC()).

     * Unlike PrepareLC(), it does not add the dialog to control stack.

     * @since 3.2

     * 

     * @param aResourceId The resource ID of the dialog.

     */

    IMPORT_C void ReadResourceLC(TInt aResourceId);

    /**

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

     *

     * The dialog is destroyed on exit.

     *

     * This function is called by the dialog framework (@c ExecuteLD()) to 

     * perform dynamic construction (layout) and to display/destroy the 

     * dialog. Static construction of the dialog must already be complete 

     * before this function is called, e.g. using @c PrepareLC().

     *

     * The function returns immediately unless @c EEikDialogFlagWait has 

     * been specified in the @c DIALOG resource. If @c EEikDialogFlagWait is    

     * specified it returns when the dialog exits.

     *

     * @return The ID of the button used to dismiss the dialog.

     */

    IMPORT_C virtual TInt RunLD();

    /**

     * Sets the dialog title text from a descriptor.

     *

     * @deprecated

     * @param aText The descriptor containing the new title text.

     */

    IMPORT_C void SetTitleL(const TDesC& aText);

    /**

     * Sets the dialog title text from a resource.

     *

     * @deprecated

     * @param aResourceId The ID of the resource containing the title text.

     */

    IMPORT_C void SetTitleL(TInt aResourceId);

    /**

     * Sets the specified page to be dimmed or undimmed. The page is redrawn

     * immediately.

     *

     * @param aPageId The ID of the page to be dimmed.

     * @param aDimmed @c ETrue to dim the page, @c EFalse to un-dim it.

     */

    IMPORT_C void SetPageDimmedNow(TInt aPageId,TBool aDimmed);

    /**

     * Sets the specified dialog line to a non-focusing state. After this

     * function is called, the line will never be given keyboard focus.

     * 

     * @param aControlId The ID of the control in the line which is to be 

     *        set as non-focusing.

     */

    IMPORT_C void SetLineNonFocusing(TInt aControlId);

    /**

     * Dims and deactivates, or un-dims and re-activates, the specified line.

     *

     * @param aControlId The ID of the line to dim or un-dim.

     * @param aDimmed @c ETrue to dim the line, @c EFalse to un-dim it.

     */

    IMPORT_C void SetLineDimmedNow(TInt aControlId,TBool aDimmed);

    /**

     * Makes the specified control visible or invisible. This function affects

     * the specified control, the visibility of the caption is not affected.

     *

     * @param aControlId The ID of the control to make visible or invisible.

     * @param aVisible @c ETrue to make the control visible. 

     *        @c EFalse to make the control invisible.

     */

    IMPORT_C void MakeLineVisible(TInt aControlId,TBool aVisible);

    /**

     * Makes the whole specified line visible and active or invisible and 

     * inactive. This function affects both the specified control and

     * the caption.

     *

     * @param aControlId The ID of the control on the line to make visible 

     *        or invisible.

     * @param aVisible @c ETrue to make the line visible. @c EFalse to make the 

     *        line invisible.

     */

    IMPORT_C void MakeWholeLineVisible(TInt aControlId,TBool aVisible);

    /**

     * Deletes the specified dialog line.

     *

     * @param aControlId The dialog line to delete.

     * @param aRedraw Whether to redraw the page. Default value is @c ETrue.

     */

    IMPORT_C void DeleteLine(TInt aControlId, TBool aRedraw=ETrue);

    /**

     * Inserts a line in the dialog. The function takes as arguments the page

     * and line index at which the line is to be inserted, and the resource used

     * to construct it.

     * 

     * @param aIndex The index at which the line is to be inserted.

     * @param aResourceId The ID of the resource which defines the line.

     * @param aPageId The page on which the line is to be added.

     */

    IMPORT_C void InsertLineL(TInt aIndex,TInt aResourceId,TInt aPageId=0);

    /**

     * Makes the specified panel button visible or invisible.

     *

     * @param aButtonId The ID of the panel button to make visible or invisible.

     * @param aVisible @c ETrue to make the panel visible. 

     *        @c EFalse to make it invisible.

     */

    IMPORT_C void MakePanelButtonVisible(TInt aButtonId,TBool aVisible);

    /**

     * Tries to change focus to the specified line. Fails if the line ID is not

     * valid. Calls @c PrepareForFocusTransitionL() before focus is given to

     * the line.

     *

     * @param aControlId The ID of the line to focus.

     */

    IMPORT_C void TryChangeFocusToL(TInt aControlId);

    /**

     * Switches the latent line. The latent line is switched from

     * @c aNoLongerLatent to @c aBecomesLatent. If dialog lines are latent they

     * are not visible and are not taken into account when laying out the

     * dialog. Latent lines can then be swapped around on the dialog later.

     *

     * @param aBecomesLatent The line ID of the line to become latent.

     * @param aNoLongerLatent The line ID of the line to that is no longer 

     *        latent.

     */

    IMPORT_C void SwitchLineLatency(TInt aBecomesLatent,TInt aNoLongerLatent);

    /**

     * Sets the specified page to be densely packed, or normally packed. This

     * reduces the spacing between the dialog's lines.

     *

     * @param aPageId The ID of the page to be densely packed.

     * @param aDensePacking @c ETrue for dense packing. @c EFalse for normal 

     *        packing.

     */

    IMPORT_C void SetPageDensePacking(TInt aPageId,TBool aDensePacking);

    /**

     * Dynamically constructs a dialog with the specified flags and buttons 

     * and with a single activated empty page with ID 0. The dialog is therefore

     * ready to dynamically add lines to.

     *

     * @param aFlags Dialog flags.

     * @param aButtonsId Dialog buttons.

     */

    IMPORT_C void ConstructAutoDialogLC(TInt aFlags,TInt aButtonsId);

    /**

     * Sets controllers return value.

     *

     * @param[in] aControlId Control identifier for wanted caption controller.

     * @param[in] aControlType Type of control.

     * @param[out] aReturnValue Controllers return value.

     * @deprecated

     */

    IMPORT_C void DeclareItemAuto(TInt aControlId,

                                  TInt aControlType,

                                  TAny* aReturnValue);

    /**

     * Lays out the dialog, setting it to take its preferred size and 

     * position for the screen.

     *

     * @since 5.1 

     */

    IMPORT_C void Layout();

    /**

     * Gets the preferred size of a dialog. The maximum size that the dialog

     * must fit within must be specified, e.g. the size of the physical screen.

     *

     * @param aMaxSize The maximum size of the area in which the dialog must

     *        fit.

     * @return The preferred size of the dialog.

     */

    IMPORT_C TSize PreferredSize(const TSize& aMaxSize) const;

    /**

     * Creates a control line on the page ID specified active page in 

     * the dialog. 

     * The line can thereafter be accessed through the identifier @c aControlId.

     * A control of type @c aControlType is created by the control factory and

     * the return value of the line set to @c aReturnValue. If the value of 

     * @c aControlType is not known to the control factory then the construction

     * of the control must be handled by @c CreateCustomControlL().

     *

     * @param aCaption The caption to appear in the dialog line.

     * @param aControlId The ID of the active page on which the control 

     *        line is to be created.

     * @param aControlType The type of control to create.

     * @param aReturnValue Deprecated. A random pointer.

     * @return A pointer to the newly created control.

     */

    IMPORT_C CCoeControl* CreateLineByTypeL(const TDesC& aCaption,

                                            TInt aControlId,

                                            TInt aControlType,

                                            TAny* aReturnValue);

    /**

     * Creates a control line on the caption specified active page 

     * in the dialog. 

     * The line can thereafter be accessed through the identifier 

     * @c aControlId.

     * A control of type @c aControlType is created by the control 

     * factory and the return value of the line set to @c aReturnValue.

     * If the value of @c aControlType is not known to the control factory

     * then the construction of the control must be handled by 

     * @c CreateCustomControlL().

     * 

     * @param aCaption The active page on which the control line is 

     *        to be created.

     * @param aPageId The ID of the active page on which the control line is

     *        to be created.

     * @param aControlId The ID of the control. After the line is created this

     *        can be used to access it.

     * @param aControlType The type of control to create.

     * @param aReturnValue Deprecated. A random pointer.

     * @return A pointer to the newly created control.

     */

    IMPORT_C CCoeControl* CreateLineByTypeL(const TDesC& aCaption,

                                            TInt aPageId,

                                            TInt aControlId,

                                            TInt aControlType,

                                            TAny* aReturnValue);

    /**

     * Sets the specified control's caption text from a descriptor.

     * 

     * @param aControlId The ID of the control for which the caption 

     *        text is being set.

     * @param aText The text for the caption.

     */

    IMPORT_C void SetControlCaptionL(TInt aControlId,const TDesC& aText);

    /**

     * Sets the specified control's caption text from a resource.

     *

     * @param aControlId The ID of the control for which the caption 

     *        text is being set.

     * @param aResourceId The ID of the resource containing the text for

     *        the caption.

     */

    IMPORT_C void SetControlCaptionL(TInt aControlId,TInt aResourceId);

    /**

     * Gets a pointer to the specified control's caption.

     *

     * @param aControlId The ID of the control for which the label is required.

     * @return A pointer to the caption.

     */

    IMPORT_C CEikLabel* ControlCaption(TInt aControlId) const;

    /**

     * Returns a pointer to the specified control. 

     * 

     * Panics if the control ID is invalid. Does not imply transfer 

     * of ownership. 

     *

     * @param aControlId The ID of the control for which a pointer is required.

     * @return A pointer to the control with ID aControlId.

     */ 

    IMPORT_C CCoeControl* Control(TInt aControlId) const;

    /**

     * Gets a pointer to the specified control. 

     * 

     * @param aControlId The ID of the control for which a pointer is required.

     * @return A pointer to the control with ID aControlId, or 

     *         NULL if it doesn't exist.

     */

    IMPORT_C CCoeControl* ControlOrNull(TInt aControlId) const;

    /**

     * Gets a reference to the dialog's command button container.

     *

     * @return The dialog's button group container.

     */

    IMPORT_C CEikButtonGroupContainer& ButtonGroupContainer() const;

    /**

     * Gets a reference to the dialog title bar.

     *

     * @return A reference to the dialog title bar.

     */ 

    IMPORT_C CEikMover& Title() const;

    /**

     * Gets a page id for the current page.

     * 

     * @return Page id.

     */

    IMPORT_C TInt ActivePageId() const;

    /**

     * Activates the first page on the dialog. At least one page must be active

     * before this method can be used.

     */

    IMPORT_C void ActivateFirstPageL() const;

// To Support Edit/View state switch for forms (Sapphire DFRD)

// This breaks Binary Compatibility

    /**

     * Sets the dialog to either editable or uneditable

     *

     * @param aEditable @c ETrue if dialog is editable.

     *        @c EFalse if dialog is uneditable.

     */

	IMPORT_C void SetEditableL( TBool aEditable ) ;

    /**

     * Checks if the dialog is editable.

     * 

     * @return @c ETrue if editable.

     */

    IMPORT_C TBool IsEditable() const ;

public: // from CCoeControl

    /**

     * From @c CCoeControl.

     *

     * Handles a key event. Overrides @c CCoeControl::OfferKeyEventL().

     *

     * @param aKeyEvent The key event.

     * @param aType The type of key event: @c EEventKey, @c EEventKeyUp 

     *        or @c EEventKeyDown.

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

     *         @c EKeyWasConsumed if the control takes action on the key event

     *         or @c EKeyWasNotConsumed otherwise.

     */

    IMPORT_C TKeyResponse OfferKeyEventL(const TKeyEvent& aKeyEvent,

                                         TEventCode aType);

    /**

     * From @c CCoeControl.

     *

     * Responds to a change in focus.

     *

     * This is called whenever the control gains or loses focus, as a result 

     * of a call to @c SetFocus(). A typical use of @c FocusChanged() is to 

     * change the appearance of the control, for example by drawing a focus 

     * rectangle around it.

     *

     * The default implementation is empty, and should be overridden by the 

     * @c CCoeControl-derived class.

     *

     * @param aDrawNow Contains the value that was passed to it by 

     *        @c SetFocus().

     */

    IMPORT_C void FocusChanged(TDrawNow aDrawNow);

    /**

     * From @c CCoeControl.

     *

     * Gets the list of logical colours used to draw the control.

     *

     * The list includes an explanation of how each colour is used. 

     * The default implementation is empty.

     *

     * If overriding @c GetColorUseListL(), the implementation must include 

     * a base call to @c CCoeControl's @c GetColorUseListL().

     * 

     * @since ER5U