epoc32/include/caf/metadata.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
    14 * Description: 
    14 * Description: 
    15 *
    15 *
    16 */
    16 */
    17 
    17 
    18 
    18 
    19 
       
    20 
       
    21 /**
    19 /**
    22  @file
    20  @file
    23  @publishedPartner
    21  @publishedAll
    24  @released
    22  @released
    25 */
    23 */
    26 
    24 
    27 
    25 
    28 #ifndef __CAF_METADATA_H__
    26 #ifndef __CAF_METADATA_H__
    54 	conversions between the two. 
    52 	conversions between the two. 
    55 	
    53 	
    56 	Applications should use the unicode functions whenever possible because it 
    54 	Applications should use the unicode functions whenever possible because it 
    57 	removes the risk of losing information during the unicode to 8 bit conversion.
    55 	removes the risk of losing information during the unicode to 8 bit conversion.
    58 
    56 
    59 	@publishedPartner
       
    60 	@released
       
    61 	*/
    57 	*/
    62 	class CMetaData : public CBase
    58 	class CMetaData : public CBase
    63 		{
    59 		{
    64 	public:
    60 	public:
    65 		/** Construct a new CMetaData with 8 bit data 
    61 		/** Construct a new CMetaData with 8 bit data 
    66 		The 8-bit data will be stored in CMetaData as unicode 
    62 		The 8-bit data will be stored in CMetaData as unicode 
    67 		
    63 		
    68 		@param aField The name of the field
    64 		@param aField The name of the field
    69 		@param aData The data associated with the field
    65 		@param aData The data associated with the field
    70 		@return A CMetaData object populated with the given field and data		
    66 		@return A CMetaData object populated with the given field and data		
    71 		@internalComponent
       
    72 		@released
       
    73 		*/
    67 		*/
    74 		static CMetaData* NewL(const TDesC8& aField, const TDesC8& aData);
    68 		static CMetaData* NewL(const TDesC8& aField, const TDesC8& aData);
    75 		/** Construct a new CMetaData with unicode data 
    69 		/** Construct a new CMetaData with unicode data 
    76 
    70 
    77 		@param aField The name of the field
    71 		@param aField The name of the field
    78 		@param aData The data associated with the field
    72 		@param aData The data associated with the field
    79 		@return A CMetaData object populated with the given field and data		
    73 		@return A CMetaData object populated with the given field and data		
    80 
    74 
    81 		@internalComponent
       
    82 		@released
       
    83 		*/
    75 		*/
    84 		static CMetaData* NewL(const TDesC16& aField, const TDesC16& aData);
    76 		static CMetaData* NewL(const TDesC16& aField, const TDesC16& aData);
    85 
    77 
    86 		/** Construct a new CMetaData from a data stream
    78 		/** Construct a new CMetaData from a data stream
    87 
    79 
    88 		@param aStream The stream to read the CMetaData object from
    80 		@param aStream The stream to read the CMetaData object from
    89 		@return A CMetaData object read from the stream
    81 		@return A CMetaData object read from the stream
    90 		
    82 		
    91 		@internalComponent
       
    92 		@released
       
    93 		*/
    83 		*/
    94 		static CMetaData* NewL(RReadStream& aStream);
    84 		static CMetaData* NewL(RReadStream& aStream);
    95 
    85 
    96 		/** destructor 
    86 		/** destructor 
    97 		*/
    87 		*/
   118 		IMPORT_C const TDesC8& Data8() const;
   108 		IMPORT_C const TDesC8& Data8() const;
   119 
   109 
   120 		/** Write the CMetaData to a data stream
   110 		/** Write the CMetaData to a data stream
   121 		
   111 		
   122 		@param aStream The stream to write the CMetaData object to
   112 		@param aStream The stream to write the CMetaData object to
   123 		@internalComponent
       
   124 		@released
       
   125 		*/
   113 		*/
   126 		void ExternalizeL(RWriteStream& aStream) const;
   114 		void ExternalizeL(RWriteStream& aStream) const;
   127 
   115 
   128 	private:
   116 	private:
   129 		CMetaData(TBool aUnicode);
   117 		CMetaData(TBool aUnicode);