|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description: Interface for plugin classes implementing custom interface
|
|
sl@0
|
15 |
* factory interface.
|
|
sl@0
|
16 |
*
|
|
sl@0
|
17 |
*/
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
#ifndef CIFACTORYINTFC_H
|
|
sl@0
|
22 |
#define CIFACTORYINTFC_H
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
// Include files
|
|
sl@0
|
25 |
#include <mmf/common/mcustomcommand.h>
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
/**
|
|
sl@0
|
28 |
* Mixin class for plugins creating Custom Interface objects.
|
|
sl@0
|
29 |
*
|
|
sl@0
|
30 |
* Instance of plugins implementing this interface will be used by
|
|
sl@0
|
31 |
* CCIExtnClientPlugin.
|
|
sl@0
|
32 |
*
|
|
sl@0
|
33 |
* @since S60 v3.2
|
|
sl@0
|
34 |
*
|
|
sl@0
|
35 |
*/
|
|
sl@0
|
36 |
class MCIFactoryIntfc
|
|
sl@0
|
37 |
{
|
|
sl@0
|
38 |
public:
|
|
sl@0
|
39 |
/**
|
|
sl@0
|
40 |
* Called by framework after plugin construction.
|
|
sl@0
|
41 |
* The passed UID must be retained for the lifetime of the plugin and, on a
|
|
sl@0
|
42 |
* subsequent call to Close(), REComSession::DestroyedImplementation() must
|
|
sl@0
|
43 |
* be called by the plugin, using the stored UID.
|
|
sl@0
|
44 |
* The implementation should return KErrNone upon successful initialization.
|
|
sl@0
|
45 |
* Otherwise the plugin will be immediately destroyed.
|
|
sl@0
|
46 |
*
|
|
sl@0
|
47 |
* @param aCustomCommand Reference to implementation of MCustomCommand.
|
|
sl@0
|
48 |
* @param aDestructorKey The Uid returned by
|
|
sl@0
|
49 |
* REComSession::CreateImplementationL() or similar.
|
|
sl@0
|
50 |
*/
|
|
sl@0
|
51 |
virtual TInt Initialize( MCustomCommand& aCustomCommand, TUid aDestructorKey ) = 0;
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
/**
|
|
sl@0
|
54 |
* Returns implementation UID of this plugin.
|
|
sl@0
|
55 |
*
|
|
sl@0
|
56 |
* @return aUid implementation UID of the plugin
|
|
sl@0
|
57 |
*/
|
|
sl@0
|
58 |
virtual TUid ImplementationUid() = 0;
|
|
sl@0
|
59 |
|
|
sl@0
|
60 |
/**
|
|
sl@0
|
61 |
* Called by the framework to obtain a pointer to the Custom Interface.
|
|
sl@0
|
62 |
*
|
|
sl@0
|
63 |
* Note that ownership of the interface will be transferred to the caller.
|
|
sl@0
|
64 |
*
|
|
sl@0
|
65 |
* @param aUid UID of the required interface.
|
|
sl@0
|
66 |
* @param aInterface Used to return pointer to the interface. Must be set
|
|
sl@0
|
67 |
* to NULL if no matching interface.
|
|
sl@0
|
68 |
* @return an error code KErrNotFound if requested custom inteface is not
|
|
sl@0
|
69 |
* supported by this plugin. KErrNone when custom interface object is
|
|
sl@0
|
70 |
* successfully created and returned. Any other error code returned
|
|
sl@0
|
71 |
* implies that custom interface is supported but the plugin was
|
|
sl@0
|
72 |
* unable to instantiate it when requested.
|
|
sl@0
|
73 |
*/
|
|
sl@0
|
74 |
virtual TInt CreateInterface( TUid aUid, TAny*& aInterface ) = 0;
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
/**
|
|
sl@0
|
77 |
* Called by the framework when plugin is to be destroyed.
|
|
sl@0
|
78 |
* Equivalent to destructor. Called to destroy plugin.
|
|
sl@0
|
79 |
*/
|
|
sl@0
|
80 |
virtual void Close() = 0;
|
|
sl@0
|
81 |
};
|
|
sl@0
|
82 |
|
|
sl@0
|
83 |
#endif // CIFACTORYINTFC_H
|