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.
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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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 __FEPPLUGIN_H__
williamr@2
    17
#define __FEPPLUGIN_H__
williamr@2
    18
williamr@2
    19
#include <e32base.h>
williamr@2
    20
williamr@2
    21
class CCoeEnv;
williamr@2
    22
class CCoeFep;
williamr@2
    23
class CCoeFepParameters;
williamr@2
    24
williamr@2
    25
const TUid KUidFepPluginInterface = { 0x1020233F };
williamr@2
    26
williamr@2
    27
/**
williamr@2
    28
CCoeFepPlugIn
williamr@2
    29
Abstract base class for FEP plug ins
williamr@2
    30
@publishedAll
williamr@2
    31
@released
williamr@2
    32
*/
williamr@2
    33
class CCoeFepPlugIn : public CBase
williamr@2
    34
	{
williamr@2
    35
public:
williamr@2
    36
	inline static CCoeFepPlugIn* NewL(TUid aFepUid);
williamr@2
    37
	virtual ~CCoeFepPlugIn();
williamr@2
    38
public:
williamr@2
    39
	/** Creates a fully constructed object of CCoeFEP.
williamr@2
    40
williamr@2
    41
	@param aConeEnvironment	A reference to the application's control environment.
williamr@2
    42
	@param aFepParameters FEP parameters.
williamr@2
    43
	@return A pointer to the newly created object.
williamr@2
    44
	*/
williamr@2
    45
	virtual CCoeFep* NewFepL(CCoeEnv& aConeEnvironment, const CCoeFepParameters& aFepParameters) = 0;
williamr@2
    46
williamr@2
    47
	/** Runs the FEP settings dialog. 
williamr@2
    48
	
williamr@2
    49
	@param aConeEnvironment A reference to the application's control environment.
williamr@2
    50
	*/
williamr@2
    51
	virtual void SynchronouslyExecuteSettingsDialogL(CCoeEnv& aConeEnvironment) = 0;
williamr@2
    52
williamr@2
    53
private:
williamr@2
    54
	TUid iDtorTag;
williamr@2
    55
	};
williamr@2
    56
williamr@2
    57
#include <fepplugin.inl>
williamr@2
    58
williamr@2
    59
#endif	// __FEPPLUGIN_H__