IPDFDPartMetadataUtils.h

//======================================================================================== 
// 
// $File$ 
// 
// Owner: Sameer Manuja
// 
// $Author$ 
// 
// $DateTime$ 
// 
// $Revision$ 
// 
// $Change$ 
// 
// ADOBE SYSTEMS INCORPORATED
// Copyright 2010 Adobe Systems Incorporated. All Rights Reserved.
//
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//======================================================================================== 

#ifndef __IPDFDPartMetadataUtils__
#define __IPDFDPartMetadataUtils__

#include "PDFID.h"

typedef uint32 CosObjID;
#define kInvalidCosObjID (0)

// opaque types
typedef struct OPAQUE_64_BITS CosObj;

typedef ConstCString NameType; /* utf-8 encoded name */

class IPDFDPartMetadataUtils : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IPDFDPARTMETADATAUTILS };

 virtual CosObjID CreateNewDict(int32 initialSize) = 0;

 virtual void PutBool(CosObjID dict, NameType key, bool16 value) = 0;

 virtual void PutInt(CosObjID dict, NameType key, int32 value) = 0;

 virtual void PutFloat(CosObjID dict, NameType key, float value) = 0;

 virtual void PutName(CosObjID dict, NameType key, NameType value) = 0;

 virtual void PutString(CosObjID dict, NameType key, const PMString& value) = 0;

 virtual void PutDict(CosObjID dict, NameType key, CosObjID value) = 0;

 virtual void PutArray(CosObjID dict, NameType key, CosObjID value) = 0;

 virtual CosObjID CreateNewArray(int32 initialSize) = 0;

 virtual int32 GetArraySize(CosObjID arry) const = 0;

 virtual void PutBool(CosObjID arry, int32 index, bool16 value) = 0;

 virtual void PutInt(CosObjID arry, int32 index, int32 value) = 0;

 virtual void PutFloat(CosObjID arry, int32 index, float value) = 0;

 virtual void PutName(CosObjID arry, int32 index, NameType value) = 0;

 virtual void PutString(CosObjID arry, int32 index, const PMString& value) = 0;

 virtual void PutDict(CosObjID arry, int32 index, CosObjID value) = 0;

 virtual void PutArray(CosObjID arry, int32 index, CosObjID value) = 0;

 virtual CosObj GetCosObjFromID(CosObjID objID) const = 0;
};

#endif