musicplayer_plat/music_content_publisher_plugin_api/inc/mcpplugin.h
changeset 0 ff3acec5bc43
equal deleted inserted replaced
-1:000000000000 0:ff3acec5bc43
       
     1 /*
       
     2 * Copyright (c) 2008-2008 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Music Content Publisher Plugin interface definition
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_MCPPLUGIN_H
       
    20 #define C_MCPPLUGIN_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 
       
    25 /**
       
    26  * The interface class for all MCP plugins
       
    27  * Plugins are responsible for updating data and actions to the Music Widget
       
    28  * and Music Suite.
       
    29  *
       
    30  * The implementator of this interface should implement Deactivate function that 
       
    31  * will be invoked when the plugin is preempted by another plugin.
       
    32  *
       
    33  * IMPORTANT NOTE: 
       
    34  * It is recommended that the plugin does not publish data while not active.
       
    35  * After calling Deactivate on the plugin it should change its state to
       
    36  * not active.
       
    37  *
       
    38  */
       
    39 class CMCPPlugin : public CBase
       
    40     {
       
    41 public:
       
    42 
       
    43     /** 
       
    44      * Triggers Deactivation Process.
       
    45      * Note: This should return immediatelly.
       
    46      *       Just a change of state variable is recommended.
       
    47      */
       
    48     virtual void Deactivate() = 0;
       
    49     
       
    50     /** 
       
    51      * Announces a change on the skin.
       
    52      * Note: Plugins should republish all the skinned icons.
       
    53      *       Called only on the active plugin, plugins are responsible to
       
    54      *       republish all the icons when they become active.
       
    55      */
       
    56     virtual void SkinChanged() {};
       
    57     };
       
    58 
       
    59 #endif // C_MCPPLUGIN_H