epoc32/include/coefepff.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
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// 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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __COEFEPFF_H__
williamr@2
    17
#define __COEFEPFF_H__
williamr@2
    18
williamr@2
    19
#include <e32std.h>
williamr@2
    20
williamr@2
    21
class CCoeFepParameters;
williamr@2
    22
class CCoeFep;
williamr@2
    23
williamr@2
    24
/** FEP factory function which must be exported by every FEP.
williamr@2
    25
williamr@2
    26
The function is called by the UI Control Framework when it loads the
williamr@2
    27
FEP. It returns a fully constructed object of a CCoeFep-derived class, 
williamr@2
    28
and passes ownership of that object to the caller.
williamr@2
    29
williamr@2
    30
The function can leave with any of the system-wide error codes,
williamr@2
    31
for instance KErrNoMemory.
williamr@2
    32
williamr@2
    33
@publishedAll
williamr@2
    34
@released
williamr@2
    35
@param aConeEnvironment A reference to the application's control environment. 
williamr@2
    36
@param aFullFileNameOfDll The full file name of the FEP's top-level DLL, i.e. 
williamr@2
    37
something like "z:\system\fep\TFEP1.FEP". A FEP could use this parameter to 
williamr@2
    38
work out the location of its resource file.
williamr@2
    39
@param aFepParameters FEP parameters. These should simply be passed to 
williamr@2
    40
CCoeFep::BaseConstructL().
williamr@2
    41
@return A pointer to the newly created object belonging to a 
williamr@2
    42
CCoeFep-derived class. */
williamr@2
    43
IMPORT_C CCoeFep* NewFepL(CCoeEnv& aConeEnvironment, const TDesC& aFullFileNameOfDll, const CCoeFepParameters& aFepParameters);
williamr@2
    44
williamr@2
    45
/** Runs the FEP settings dialog.
williamr@2
    46
williamr@2
    47
The function is called by the FEPs control panel plug-in in order 
williamr@2
    48
to run the settings dialog for the FEP. It must be exported by 
williamr@2
    49
every FEP.
williamr@2
    50
williamr@2
    51
The function can leave with any of the system-wide error codes,
williamr@2
    52
for instance KErrNoMemory.
williamr@2
    53
williamr@2
    54
Note: the FEP may or may not be loaded when this function is called.
williamr@2
    55
williamr@2
    56
@publishedAll
williamr@2
    57
@released
williamr@2
    58
@param aConeEnvironment A reference to the application's control environment.
williamr@2
    59
@param aFullFileNameOfDll The full file name of the FEP's top-level DLL, i.e.
williamr@2
    60
something like "z:\system\fep\TFEP1.FEP". */
williamr@2
    61
IMPORT_C void SynchronouslyExecuteSettingsDialogL(CCoeEnv& aConeEnvironment, const TDesC& aFullFileNameOfDll);
williamr@2
    62
IMPORT_C void Reserved_1();
williamr@2
    63
IMPORT_C void Reserved_2();
williamr@2
    64
IMPORT_C void Reserved_3();
williamr@2
    65
IMPORT_C void Reserved_4();
williamr@2
    66
IMPORT_C void Reserved_5();
williamr@2
    67
IMPORT_C void Reserved_6();
williamr@2
    68
IMPORT_C void Reserved_7();
williamr@2
    69
IMPORT_C void Reserved_8();
williamr@2
    70
williamr@2
    71
#endif	// __COEFEPFF_H__