epoc32/include/mw/coefepff.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/coefepff.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,71 @@
     1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __COEFEPFF_H__
    1.20 +#define __COEFEPFF_H__
    1.21 +
    1.22 +#include <e32std.h>
    1.23 +
    1.24 +class CCoeFepParameters;
    1.25 +class CCoeFep;
    1.26 +
    1.27 +/** FEP factory function which must be exported by every FEP.
    1.28 +
    1.29 +The function is called by the UI Control Framework when it loads the
    1.30 +FEP. It returns a fully constructed object of a CCoeFep-derived class, 
    1.31 +and passes ownership of that object to the caller.
    1.32 +
    1.33 +The function can leave with any of the system-wide error codes,
    1.34 +for instance KErrNoMemory.
    1.35 +
    1.36 +@publishedAll
    1.37 +@released
    1.38 +@param aConeEnvironment A reference to the application's control environment. 
    1.39 +@param aFullFileNameOfDll The full file name of the FEP's top-level DLL, i.e. 
    1.40 +something like "z:\system\fep\TFEP1.FEP". A FEP could use this parameter to 
    1.41 +work out the location of its resource file.
    1.42 +@param aFepParameters FEP parameters. These should simply be passed to 
    1.43 +CCoeFep::BaseConstructL().
    1.44 +@return A pointer to the newly created object belonging to a 
    1.45 +CCoeFep-derived class. */
    1.46 +IMPORT_C CCoeFep* NewFepL(CCoeEnv& aConeEnvironment, const TDesC& aFullFileNameOfDll, const CCoeFepParameters& aFepParameters);
    1.47 +
    1.48 +/** Runs the FEP settings dialog.
    1.49 +
    1.50 +The function is called by the FEPs control panel plug-in in order 
    1.51 +to run the settings dialog for the FEP. It must be exported by 
    1.52 +every FEP.
    1.53 +
    1.54 +The function can leave with any of the system-wide error codes,
    1.55 +for instance KErrNoMemory.
    1.56 +
    1.57 +Note: the FEP may or may not be loaded when this function is called.
    1.58 +
    1.59 +@publishedAll
    1.60 +@released
    1.61 +@param aConeEnvironment A reference to the application's control environment.
    1.62 +@param aFullFileNameOfDll The full file name of the FEP's top-level DLL, i.e.
    1.63 +something like "z:\system\fep\TFEP1.FEP". */
    1.64 +IMPORT_C void SynchronouslyExecuteSettingsDialogL(CCoeEnv& aConeEnvironment, const TDesC& aFullFileNameOfDll);
    1.65 +IMPORT_C void Reserved_1();
    1.66 +IMPORT_C void Reserved_2();
    1.67 +IMPORT_C void Reserved_3();
    1.68 +IMPORT_C void Reserved_4();
    1.69 +IMPORT_C void Reserved_5();
    1.70 +IMPORT_C void Reserved_6();
    1.71 +IMPORT_C void Reserved_7();
    1.72 +IMPORT_C void Reserved_8();
    1.73 +
    1.74 +#endif	// __COEFEPFF_H__