idlehomescreen/sapiwrapper/hspswrapper/inc/objectmap.h
changeset 0 f72a12da539e
equal deleted inserted replaced
-1:000000000000 0:f72a12da539e
       
     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:  Presents object map as name, path and mediatype data  
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef C_COBJECTMAP_H
       
    21 #define C_COBJECTMAP_H
       
    22 
       
    23 
       
    24 #include <e32base.h>
       
    25 
       
    26 namespace hspswrapper{
       
    27 
       
    28 
       
    29 /**
       
    30  *  Presents object map as name, path and mediatype data 
       
    31  *  
       
    32  *
       
    33  *  @code
       
    34  *  @endcode
       
    35  *
       
    36  *  @lib xnlayoutengine.lib
       
    37  *  @since S60 v5.0
       
    38  */
       
    39 class CObjectMap : public CBase
       
    40     {
       
    41 public:    
       
    42     /**
       
    43      * Two-phased constructor.
       
    44      */
       
    45     IMPORT_C static CObjectMap* NewL();
       
    46     IMPORT_C static CObjectMap* NewLC();
       
    47     
       
    48 
       
    49     /**
       
    50     * Destructor.
       
    51     */
       
    52     IMPORT_C virtual ~CObjectMap();
       
    53 
       
    54     /**
       
    55      * Set object name
       
    56      *
       
    57      * @param aName object name
       
    58      * @return Reference to this object
       
    59      */
       
    60     IMPORT_C CObjectMap& SetNameL( const TDesC8& aName );
       
    61     
       
    62     /**
       
    63      * Get object name
       
    64      *
       
    65      * @return Reference to name or KNullDesC8
       
    66      */
       
    67     IMPORT_C const TDesC8& NameL()const;
       
    68     
       
    69     /**
       
    70      * Set object path
       
    71      *
       
    72      * @param aPath object path
       
    73      * @return Reference to this object
       
    74      */
       
    75     IMPORT_C CObjectMap& SetPathL( const TDesC8& aPath );
       
    76     
       
    77     /**
       
    78      * Get object path
       
    79      *
       
    80      * @return Reference to path or KNullDesC8
       
    81      */
       
    82     IMPORT_C const TDesC8& Path()const;
       
    83     
       
    84     /**
       
    85      * Set object media type
       
    86      *
       
    87      * @param aMediaType object media type
       
    88      * @return Reference to this object
       
    89      */
       
    90     IMPORT_C CObjectMap& SetMediaTypeL( const TDesC8& aMediaType );
       
    91     
       
    92     /**
       
    93      * Get object media type
       
    94      *
       
    95      * @return Reference to media type or KNullDesC8
       
    96      */
       
    97     IMPORT_C const TDesC8& MediaType()const;
       
    98     
       
    99     /**
       
   100      * Set object tag
       
   101      *
       
   102      * @param aTag object tag
       
   103      * @return Reference to this object
       
   104      */
       
   105     IMPORT_C CObjectMap& SetTagL( const TDesC8& aTag );
       
   106     
       
   107     /**
       
   108      * Get object tag
       
   109      *
       
   110      * @return Reference to tag or KNullDesC8
       
   111      */
       
   112     IMPORT_C const TDesC8& Tag()const; 
       
   113 
       
   114 private:
       
   115     CObjectMap();
       
   116 
       
   117     void ConstructL();
       
   118 
       
   119 private: // data
       
   120 
       
   121     /**
       
   122      * Own. Object name
       
   123      */
       
   124     HBufC8* iName;
       
   125     
       
   126     /**
       
   127      * Own. Object path
       
   128      */
       
   129     HBufC8* iPath;
       
   130     
       
   131     /**
       
   132      * Own. Object mediatype
       
   133      */
       
   134     HBufC8* iMediaType;
       
   135     
       
   136     /**
       
   137      * Own. Object tag
       
   138      */
       
   139     HBufC8* iTag;
       
   140     };
       
   141 
       
   142 }
       
   143 #endif // C_COBJECTMAP_H