homescreensrv_plat/hs_settings_api/inc/mhomescreensettingsif.h
changeset 0 79c6a41cd166
equal deleted inserted replaced
-1:000000000000 0:79c6a41cd166
       
     1 /*
       
     2 * Copyright (c) 2008-2009 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:  Encapsulates name and value
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef MHOMESCREENSETTINGSIF_H_
       
    19 #define MHOMESCREENSETTINGSIF_H_
       
    20 
       
    21 #include <e32base.h>
       
    22 
       
    23 namespace HSPluginSettingsIf{
       
    24 
       
    25 class CItemMap;
       
    26 
       
    27 class MHomescreenSettingsIf
       
    28     {
       
    29 public:
       
    30     /**
       
    31      * Stores defined plugin’s settings. 
       
    32      * Plugin is identified with unique plugin ID used in application’s
       
    33      * configuration 
       
    34      *
       
    35      * @param aPluginId Pluging’s ID which settings are stored
       
    36      * @param aSettings List of item maps
       
    37      * @return Operation status. KErrNone (success), KErrNotFound
       
    38      */  
       
    39     virtual TInt GetSettingsL(const TDesC8& aPluginId, RPointerArray< CItemMap >& aSettings) = 0;
       
    40     
       
    41     /**
       
    42      * From MHomescreenSettingsIf
       
    43      * Stores defined plugin’s settings. 
       
    44      * Plugin is identified with unique plugin ID used in application’s 
       
    45      * configuration 
       
    46      *
       
    47      * @param aPluginId Pluging’s ID which settings are stored
       
    48      * @param aSettings List of item maps
       
    49      * @param aStoringParam parameter to tell whether plugin configuration need to be saved,if parameter is ETrue.
       
    50      * @return Operation status. KErrNone (success), KErrNotFound
       
    51      */
       
    52     virtual TInt SetSettingsL(const TDesC8& aPluginId, const RPointerArray< CItemMap >& aSettings, const TBool aStoringParam) = 0;
       
    53     };
       
    54 }
       
    55 #endif /*MHOMESCREENSETTINGSIF_H_*/