epoc32/include/mw/fepplugin.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef __FEPPLUGIN_H__
    17 #define __FEPPLUGIN_H__
    18 
    19 #include <e32base.h>
    20 
    21 class CCoeEnv;
    22 class CCoeFep;
    23 class CCoeFepParameters;
    24 
    25 const TUid KUidFepPluginInterface = { 0x1020233F };
    26 
    27 /**
    28 CCoeFepPlugIn
    29 Abstract base class for FEP plug ins
    30 @publishedAll
    31 @released
    32 */
    33 class CCoeFepPlugIn : public CBase
    34 	{
    35 public:
    36 	inline static CCoeFepPlugIn* NewL(TUid aFepUid);
    37 	virtual ~CCoeFepPlugIn();
    38 public:
    39 	/** Creates a fully constructed object of CCoeFEP.
    40 
    41 	@param aConeEnvironment	A reference to the application's control environment.
    42 	@param aFepParameters FEP parameters.
    43 	@return A pointer to the newly created object.
    44 	*/
    45 	virtual CCoeFep* NewFepL(CCoeEnv& aConeEnvironment, const CCoeFepParameters& aFepParameters) = 0;
    46 
    47 	/** Runs the FEP settings dialog. 
    48 	
    49 	@param aConeEnvironment A reference to the application's control environment.
    50 	*/
    51 	virtual void SynchronouslyExecuteSettingsDialogL(CCoeEnv& aConeEnvironment) = 0;
    52 
    53 private:
    54 	TUid iDtorTag;
    55 	};
    56 
    57 #include <fepplugin.inl>
    58 
    59 #endif	// __FEPPLUGIN_H__