epoc32/include/mw/coefepff.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 __COEFEPFF_H__
    17 #define __COEFEPFF_H__
    18 
    19 #include <e32std.h>
    20 
    21 class CCoeFepParameters;
    22 class CCoeFep;
    23 
    24 /** FEP factory function which must be exported by every FEP.
    25 
    26 The function is called by the UI Control Framework when it loads the
    27 FEP. It returns a fully constructed object of a CCoeFep-derived class, 
    28 and passes ownership of that object to the caller.
    29 
    30 The function can leave with any of the system-wide error codes,
    31 for instance KErrNoMemory.
    32 
    33 @publishedAll
    34 @released
    35 @param aConeEnvironment A reference to the application's control environment. 
    36 @param aFullFileNameOfDll The full file name of the FEP's top-level DLL, i.e. 
    37 something like "z:\system\fep\TFEP1.FEP". A FEP could use this parameter to 
    38 work out the location of its resource file.
    39 @param aFepParameters FEP parameters. These should simply be passed to 
    40 CCoeFep::BaseConstructL().
    41 @return A pointer to the newly created object belonging to a 
    42 CCoeFep-derived class. */
    43 IMPORT_C CCoeFep* NewFepL(CCoeEnv& aConeEnvironment, const TDesC& aFullFileNameOfDll, const CCoeFepParameters& aFepParameters);
    44 
    45 /** Runs the FEP settings dialog.
    46 
    47 The function is called by the FEPs control panel plug-in in order 
    48 to run the settings dialog for the FEP. It must be exported by 
    49 every FEP.
    50 
    51 The function can leave with any of the system-wide error codes,
    52 for instance KErrNoMemory.
    53 
    54 Note: the FEP may or may not be loaded when this function is called.
    55 
    56 @publishedAll
    57 @released
    58 @param aConeEnvironment A reference to the application's control environment.
    59 @param aFullFileNameOfDll The full file name of the FEP's top-level DLL, i.e.
    60 something like "z:\system\fep\TFEP1.FEP". */
    61 IMPORT_C void SynchronouslyExecuteSettingsDialogL(CCoeEnv& aConeEnvironment, const TDesC& aFullFileNameOfDll);
    62 IMPORT_C void Reserved_1();
    63 IMPORT_C void Reserved_2();
    64 IMPORT_C void Reserved_3();
    65 IMPORT_C void Reserved_4();
    66 IMPORT_C void Reserved_5();
    67 IMPORT_C void Reserved_6();
    68 IMPORT_C void Reserved_7();
    69 IMPORT_C void Reserved_8();
    70 
    71 #endif	// __COEFEPFF_H__
    72