musicplayer_plat/music_content_publisher_plugin_api/inc/mcpplugin.h
changeset 0 ff3acec5bc43
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/musicplayer_plat/music_content_publisher_plugin_api/inc/mcpplugin.h	Thu Dec 17 08:45:05 2009 +0200
@@ -0,0 +1,59 @@
+/*
+* Copyright (c) 2008-2008 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Music Content Publisher Plugin interface definition
+*
+*/
+
+
+#ifndef C_MCPPLUGIN_H
+#define C_MCPPLUGIN_H
+
+#include <e32base.h>
+
+
+/**
+ * The interface class for all MCP plugins
+ * Plugins are responsible for updating data and actions to the Music Widget
+ * and Music Suite.
+ *
+ * The implementator of this interface should implement Deactivate function that 
+ * will be invoked when the plugin is preempted by another plugin.
+ *
+ * IMPORTANT NOTE: 
+ * It is recommended that the plugin does not publish data while not active.
+ * After calling Deactivate on the plugin it should change its state to
+ * not active.
+ *
+ */
+class CMCPPlugin : public CBase
+    {
+public:
+
+    /** 
+     * Triggers Deactivation Process.
+     * Note: This should return immediatelly.
+     *       Just a change of state variable is recommended.
+     */
+    virtual void Deactivate() = 0;
+    
+    /** 
+     * Announces a change on the skin.
+     * Note: Plugins should republish all the skinned icons.
+     *       Called only on the active plugin, plugins are responsible to
+     *       republish all the icons when they become active.
+     */
+    virtual void SkinChanged() {};
+    };
+
+#endif // C_MCPPLUGIN_H