homescreenpluginsrv/homescreen_settings_api/inc/pluginmap.h
changeset 0 79c6a41cd166
equal deleted inserted replaced
-1:000000000000 0:79c6a41cd166
       
     1 /*
       
     2 * Copyright (c) 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:  contains id and uid
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef C_CPLUGINMAP_H
       
    21 #define C_CPLUGINMAP_H
       
    22 
       
    23 
       
    24 #include <e32base.h>
       
    25 
       
    26 
       
    27 namespace HSPluginSettingsIf{
       
    28 
       
    29 /**
       
    30  *  Presents plugin map i.e id and uid
       
    31  *  
       
    32  *
       
    33  *  @code
       
    34  *  
       
    35  *  @endcode
       
    36  *
       
    37  *  @lib xnlayoutengine.lib
       
    38  *  @since S60 v5.0
       
    39  */
       
    40 class CPluginMap : public CBase
       
    41     {
       
    42 
       
    43 public:
       
    44 
       
    45     /**
       
    46      * Two-phased constructor.
       
    47      */
       
    48     IMPORT_C static CPluginMap* NewL();
       
    49     IMPORT_C static CPluginMap* NewLC();
       
    50 
       
    51     /**
       
    52     * Destructor.
       
    53     */
       
    54     IMPORT_C virtual ~CPluginMap();
       
    55 
       
    56     /**
       
    57      * Set plugin id
       
    58      *
       
    59      * @param aPluginId plugin id
       
    60      * @return Reference to this object
       
    61      */
       
    62     IMPORT_C CPluginMap& SetPluginIdL(const TDesC8& aPluginId);
       
    63     
       
    64     /**
       
    65      * Get plugin id
       
    66      *
       
    67      * @return Reference to plugin id or KNullDesC8
       
    68      */
       
    69     IMPORT_C const TDesC8& PluginId()const;
       
    70     
       
    71     /**
       
    72      * Set plugin uid
       
    73      *
       
    74      * @param aPluginId plugin uid
       
    75      * @return Reference to this object
       
    76      */
       
    77     IMPORT_C CPluginMap& SetPluginUidL(const TDesC8& aPluginUid);
       
    78     
       
    79     /**
       
    80      * Get plugin uid
       
    81      *
       
    82      * @return Reference to plugin uid or KNullDesC8
       
    83      */
       
    84     IMPORT_C const TDesC8& PluginUid()const;
       
    85 
       
    86 private:
       
    87 
       
    88     CPluginMap();
       
    89 
       
    90     void ConstructL();
       
    91 
       
    92 
       
    93 private: // data
       
    94 
       
    95     /**
       
    96      * Own. Plugin id.
       
    97      */
       
    98     HBufC8* iPluginId;
       
    99     
       
   100     /**
       
   101      * Own. Plugin uid.
       
   102      */
       
   103     HBufC8* iPluginUid;
       
   104     };
       
   105 
       
   106 }
       
   107 
       
   108 #endif // C_CPLUGINMAP_H