epoc32/include/caf/metadata.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: 
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
/**
williamr@2
    20
 @file
williamr@4
    21
 @publishedAll
williamr@2
    22
 @released
williamr@2
    23
*/
williamr@2
    24
williamr@2
    25
williamr@2
    26
#ifndef __CAF_METADATA_H__
williamr@2
    27
#define __CAF_METADATA_H__
williamr@2
    28
williamr@2
    29
#include <e32base.h>
williamr@2
    30
#include <f32file.h>
williamr@2
    31
williamr@2
    32
class RReadStream;
williamr@2
    33
class RWriteStream;
williamr@2
    34
williamr@2
    35
namespace ContentAccess
williamr@2
    36
	{
williamr@2
    37
	/** Stores a field and data pair for use in a supplier import operation
williamr@2
    38
	
williamr@2
    39
	The field and data can be any values the application doing the import thinks 
williamr@2
    40
	the agent will find useful. Some information that could be included here are
williamr@2
    41
	headers, eg:
williamr@2
    42
williamr@2
    43
	"Content Type", "application/vnd.oma.drm.dm"
williamr@2
    44
williamr@2
    45
	The application can include anything it likes, if the agent doesn't understand
williamr@2
    46
	the header it can just ignore it, eg:
williamr@2
    47
williamr@2
    48
	"Colour", "Yellow"
williamr@2
    49
williamr@2
    50
williamr@2
    51
	CMetaData can be used with 8-bit or unicode data and automatically performs
williamr@2
    52
	conversions between the two. 
williamr@2
    53
	
williamr@2
    54
	Applications should use the unicode functions whenever possible because it 
williamr@2
    55
	removes the risk of losing information during the unicode to 8 bit conversion.
williamr@2
    56
williamr@2
    57
	*/
williamr@2
    58
	class CMetaData : public CBase
williamr@2
    59
		{
williamr@2
    60
	public:
williamr@2
    61
		/** Construct a new CMetaData with 8 bit data 
williamr@2
    62
		The 8-bit data will be stored in CMetaData as unicode 
williamr@2
    63
		
williamr@2
    64
		@param aField The name of the field
williamr@2
    65
		@param aData The data associated with the field
williamr@2
    66
		@return A CMetaData object populated with the given field and data		
williamr@2
    67
		*/
williamr@2
    68
		static CMetaData* NewL(const TDesC8& aField, const TDesC8& aData);
williamr@2
    69
		/** Construct a new CMetaData with unicode data 
williamr@2
    70
williamr@2
    71
		@param aField The name of the field
williamr@2
    72
		@param aData The data associated with the field
williamr@2
    73
		@return A CMetaData object populated with the given field and data		
williamr@2
    74
williamr@2
    75
		*/
williamr@2
    76
		static CMetaData* NewL(const TDesC16& aField, const TDesC16& aData);
williamr@2
    77
williamr@2
    78
		/** Construct a new CMetaData from a data stream
williamr@2
    79
williamr@2
    80
		@param aStream The stream to read the CMetaData object from
williamr@2
    81
		@return A CMetaData object read from the stream
williamr@2
    82
		
williamr@2
    83
		*/
williamr@2
    84
		static CMetaData* NewL(RReadStream& aStream);
williamr@2
    85
williamr@2
    86
		/** destructor 
williamr@2
    87
		*/
williamr@2
    88
		virtual ~CMetaData();
williamr@2
    89
williamr@2
    90
		/** The field name 
williamr@2
    91
		@return The field name
williamr@2
    92
		*/
williamr@2
    93
		IMPORT_C const TDesC& Field() const;
williamr@2
    94
		
williamr@2
    95
		/** The data value 
williamr@2
    96
		@return The data value
williamr@2
    97
		*/
williamr@2
    98
		IMPORT_C const TDesC& Data() const;
williamr@2
    99
williamr@2
   100
		/** The field name 
williamr@2
   101
		@return The field name
williamr@2
   102
		*/
williamr@2
   103
		IMPORT_C const TDesC8& Field8() const;
williamr@2
   104
		
williamr@2
   105
		/** The data value 
williamr@2
   106
		@return The data value
williamr@2
   107
		*/
williamr@2
   108
		IMPORT_C const TDesC8& Data8() const;
williamr@2
   109
williamr@2
   110
		/** Write the CMetaData to a data stream
williamr@2
   111
		
williamr@2
   112
		@param aStream The stream to write the CMetaData object to
williamr@2
   113
		*/
williamr@2
   114
		void ExternalizeL(RWriteStream& aStream) const;
williamr@2
   115
williamr@2
   116
	private:
williamr@2
   117
		CMetaData(TBool aUnicode);
williamr@2
   118
		void ConstructL(const TDesC8& aField, const TDesC8& aData);
williamr@2
   119
		void ConstructL(const TDesC16& aField, const TDesC16& aData);
williamr@2
   120
williamr@2
   121
		/** Read the CMetaData from a data stream
williamr@2
   122
		*/
williamr@2
   123
		void InternalizeL(RReadStream& aStream);
williamr@2
   124
williamr@2
   125
	private:
williamr@2
   126
		HBufC* iField;
williamr@2
   127
		HBufC* iData;
williamr@2
   128
		HBufC8* iField8;
williamr@2
   129
		HBufC8* iData8;
williamr@2
   130
		TBool iUnicode;
williamr@2
   131
		};
williamr@2
   132
	}
williamr@2
   133
williamr@2
   134
#endif