epoc32/include/fepplugin.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files

// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#ifndef __FEPPLUGIN_H__
#define __FEPPLUGIN_H__

#include <e32base.h>

class CCoeEnv;
class CCoeFep;
class CCoeFepParameters;

const TUid KUidFepPluginInterface = { 0x1020233F };

/**
CCoeFepPlugIn
Abstract base class for FEP plug ins
@publishedAll
@released
*/
class CCoeFepPlugIn : public CBase
	{
public:
	inline static CCoeFepPlugIn* NewL(TUid aFepUid);
	virtual ~CCoeFepPlugIn();
public:
	/** Creates a fully constructed object of CCoeFEP.

	@param aConeEnvironment	A reference to the application's control environment.
	@param aFepParameters FEP parameters.
	@return A pointer to the newly created object.
	*/
	virtual CCoeFep* NewFepL(CCoeEnv& aConeEnvironment, const CCoeFepParameters& aFepParameters) = 0;

	/** Runs the FEP settings dialog. 
	
	@param aConeEnvironment A reference to the application's control environment.
	*/
	virtual void SynchronouslyExecuteSettingsDialogL(CCoeEnv& aConeEnvironment) = 0;

private:
	TUid iDtorTag;
	};

#include <fepplugin.inl>

#endif	// __FEPPLUGIN_H__