sl@0: /*
sl@0: * Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:   Interface for plugin classes implementing custom interface
sl@0: *                factory interface.
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: 
sl@0: #ifndef CIFACTORYINTFC_H
sl@0: #define CIFACTORYINTFC_H
sl@0: 
sl@0: // Include files
sl@0: #include <mmf/common/mcustomcommand.h>
sl@0: 
sl@0: /**
sl@0:  * Mixin class for plugins creating Custom Interface objects.
sl@0:  *
sl@0:  * Instance of plugins implementing this interface will be used by
sl@0:  * CCIExtnClientPlugin.
sl@0:  *
sl@0:  *  @since S60 v3.2
sl@0:  *
sl@0:  */
sl@0: class MCIFactoryIntfc
sl@0:     {
sl@0: public:
sl@0:     /**
sl@0:      * Called by framework after plugin construction.
sl@0:      * The passed UID must be retained for the lifetime of the plugin and, on a
sl@0:      * subsequent call to Close(), REComSession::DestroyedImplementation() must
sl@0:      * be called by the plugin, using the stored UID.
sl@0:      * The implementation should return KErrNone upon successful initialization.
sl@0:      * Otherwise the plugin will be immediately destroyed.
sl@0:      *
sl@0:      * @param aCustomCommand  Reference to implementation of MCustomCommand.
sl@0:      * @param aDestructorKey The Uid returned by
sl@0:      *        REComSession::CreateImplementationL() or similar.
sl@0:      */
sl@0:     virtual TInt Initialize( MCustomCommand& aCustomCommand, TUid aDestructorKey ) = 0;
sl@0: 
sl@0:     /**
sl@0:      * Returns implementation UID of this plugin.
sl@0:      *
sl@0:      * @return aUid implementation UID of the plugin
sl@0:      */
sl@0:     virtual TUid ImplementationUid() = 0;
sl@0: 
sl@0:     /**
sl@0:      * Called by the framework to obtain a pointer to the Custom Interface.
sl@0:      *
sl@0:      * Note that ownership of the interface will be transferred to the caller.
sl@0:      *
sl@0:      * @param aUid UID of the required interface.
sl@0:      * @param aInterface Used to return pointer to the interface. Must be set
sl@0:      *        to NULL if no matching interface.
sl@0:      * @return an error code KErrNotFound if requested custom inteface is not
sl@0:      *         supported by this plugin. KErrNone when custom interface object is
sl@0:      *         successfully created and returned. Any other error code returned
sl@0:      *         implies that custom interface is supported but the plugin was
sl@0:      *         unable to instantiate it when requested.
sl@0:      */
sl@0:     virtual TInt CreateInterface( TUid aUid, TAny*& aInterface ) = 0;
sl@0: 
sl@0:     /**
sl@0:      * Called by the framework when plugin is to be destroyed.
sl@0:      * Equivalent to destructor. Called to destroy plugin.
sl@0:      */
sl@0:     virtual void Close() = 0;
sl@0:     };
sl@0: 
sl@0: #endif // CIFACTORYINTFC_H