/*

* Copyright (c) 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 __EIKDPOBS_H__

#define __EIKDPOBS_H__

#include <eikfctry.h>

/**

 * The MEikDialogPageObserver class specifies an interface through which the behaviour of the pages of

 * a dialog may be observed.

 *

 * @since ER5U

 */

class MEikDialogPageObserver

	{

/**

 * It is necessary to know from which base class a control has been derived from

 * in order to use the correct layout method.

 * These are all the known form control base types.

 */

	public:

		enum TFormControlTypes

		{

		EUnknownType,

		EEdwinDerived,

		EMfneDerived,

		EPopfieldDerived,

		ESecretEditorDerived,

		ESliderDerived,

		EColourSelectionGridDerived

		};

    public:

        enum TDialogPageObserverEvents

            {

            EDialogPageTapped

            };

public:

	/**

	 * Prepares for focus transition from the current line e.g. to validate the

	 * contents of the current control.

	 */

	virtual void PrepareForFocusTransitionL()=0;

	/**

	 * Takes any action required when the active dialog page is changed to aPageId.

	 */

	virtual void PageChangedL(TInt aPageId)=0;

	/**

	 * Takes any action required when the current line is changed to aControlId.

	 */

	virtual void LineChangedL(TInt aControlId)=0;

	/**

	 * Creates a custom control of type aControlType and returns the control information for the custom control

	 * which is created. Called when creating a line on the dialog page if the Eikon control factory does not

	 * recognise the type aControlType.

	 */

	virtual SEikControlInfo CreateCustomControlL(TInt aControlType)=0;

	/**

	 * ConvertCustomControlTypeToKnownControlType

	 * Used for custom control, to provide a mapping for forms between custom controls

	 * and the base types that the layout knows how to deal with.

	 * For example an edwin derived custom control could return EEikCtEdwin

	*/

	virtual TFormControlTypes ConvertCustomControlTypeToBaseControlType(TInt aControlType)const =0 ;

	/**

	 * Gets the custom auto value for the custom control aControl of type aControlType with return value

	 * aReturnValue. This method is included in the interface to support deprecated legacy code only.

	 */

	virtual void GetCustomAutoValue(TAny* aReturnValue,TInt aControlType,const CCoeControl* aControl)=0;

	/**

	 * Takes any action required when the dialog page event happens.

	 */

	virtual void HandleDialogPageEventL(TInt aEventID) = 0;

	};

#endif