1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/mm/devsoundextensions/ciextnfactoryplugins/ciextnclientplugin/inc/cifactoryintfc.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,83 @@
     1.4 +/*
     1.5 +* Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:   Interface for plugin classes implementing custom interface
    1.18 +*                factory interface.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +#ifndef CIFACTORYINTFC_H
    1.25 +#define CIFACTORYINTFC_H
    1.26 +
    1.27 +// Include files
    1.28 +#include <mmf/common/mcustomcommand.h>
    1.29 +
    1.30 +/**
    1.31 + * Mixin class for plugins creating Custom Interface objects.
    1.32 + *
    1.33 + * Instance of plugins implementing this interface will be used by
    1.34 + * CCIExtnClientPlugin.
    1.35 + *
    1.36 + *  @since S60 v3.2
    1.37 + *
    1.38 + */
    1.39 +class MCIFactoryIntfc
    1.40 +    {
    1.41 +public:
    1.42 +    /**
    1.43 +     * Called by framework after plugin construction.
    1.44 +     * The passed UID must be retained for the lifetime of the plugin and, on a
    1.45 +     * subsequent call to Close(), REComSession::DestroyedImplementation() must
    1.46 +     * be called by the plugin, using the stored UID.
    1.47 +     * The implementation should return KErrNone upon successful initialization.
    1.48 +     * Otherwise the plugin will be immediately destroyed.
    1.49 +     *
    1.50 +     * @param aCustomCommand  Reference to implementation of MCustomCommand.
    1.51 +     * @param aDestructorKey The Uid returned by
    1.52 +     *        REComSession::CreateImplementationL() or similar.
    1.53 +     */
    1.54 +    virtual TInt Initialize( MCustomCommand& aCustomCommand, TUid aDestructorKey ) = 0;
    1.55 +
    1.56 +    /**
    1.57 +     * Returns implementation UID of this plugin.
    1.58 +     *
    1.59 +     * @return aUid implementation UID of the plugin
    1.60 +     */
    1.61 +    virtual TUid ImplementationUid() = 0;
    1.62 +
    1.63 +    /**
    1.64 +     * Called by the framework to obtain a pointer to the Custom Interface.
    1.65 +     *
    1.66 +     * Note that ownership of the interface will be transferred to the caller.
    1.67 +     *
    1.68 +     * @param aUid UID of the required interface.
    1.69 +     * @param aInterface Used to return pointer to the interface. Must be set
    1.70 +     *        to NULL if no matching interface.
    1.71 +     * @return an error code KErrNotFound if requested custom inteface is not
    1.72 +     *         supported by this plugin. KErrNone when custom interface object is
    1.73 +     *         successfully created and returned. Any other error code returned
    1.74 +     *         implies that custom interface is supported but the plugin was
    1.75 +     *         unable to instantiate it when requested.
    1.76 +     */
    1.77 +    virtual TInt CreateInterface( TUid aUid, TAny*& aInterface ) = 0;
    1.78 +
    1.79 +    /**
    1.80 +     * Called by the framework when plugin is to be destroyed.
    1.81 +     * Equivalent to destructor. Called to destroy plugin.
    1.82 +     */
    1.83 +    virtual void Close() = 0;
    1.84 +    };
    1.85 +
    1.86 +#endif // CIFACTORYINTFC_H