InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPDFDPartMetadataUtils Class Referenceabstract
Inheritance diagram for IPDFDPartMetadataUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPDFDPARTMETADATAUTILS }
 

Public Member Functions

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
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual CosObjID IPDFDPartMetadataUtils::CreateNewArray (int32 initialSize)
pure virtual

Creates a new array object.

Parameters
int32initialSize: initial size of the array. The array can grow dynamically as needed.
Returns
CosObjID: the array object identifier.
virtual CosObjID IPDFDPartMetadataUtils::CreateNewDict (int32 initialSize)
pure virtual

Creates a new dictionary object.

Parameters
int32initialSize: initial size of the dictionary. The dictionary can grow dynamically as needed.
Returns
CosObjID: the dictionary object identifier.
virtual int32 IPDFDPartMetadataUtils::GetArraySize (CosObjID arry) const
pure virtual

Gets the size of the array object.

Parameters
CosObjIDarry: the array object identifier.
Returns
int32: the size of the array object.
virtual CosObj IPDFDPartMetadataUtils::GetCosObjFromID (CosObjID objID) const
pure virtual

Adobe internal use only.

virtual void IPDFDPartMetadataUtils::PutArray (CosObjID dict,
NameType key,
CosObjID value 
)
pure virtual

Adds an array value to the dictionary object.

Parameters
CosObjIDdict: the dictionary object identifier.
NameTypekey: the name of the key.
CosObjIDvalue: the array object value to put.
virtual void IPDFDPartMetadataUtils::PutArray (CosObjID arry,
int32 index,
CosObjID value 
)
pure virtual

Puts an array value at the specified location in the array object.

Parameters
CosObjIDarry: the array object identifier.
int32index: location to put the value at, zero-based.
CosObjIDvalue: the array value to put.
virtual void IPDFDPartMetadataUtils::PutBool (CosObjID dict,
NameType key,
bool16 value 
)
pure virtual

Adds a boolean value to the dictionary object.

Parameters
CosObjIDdict: the dictionary object identifier.
NameTypekey: the name of the key.
bool16value: the boolean value to put.
virtual void IPDFDPartMetadataUtils::PutBool (CosObjID arry,
int32 index,
bool16 value 
)
pure virtual

Puts a boolean value at the specified location in the array object.

Parameters
CosObjIDarry: the array object identifier.
int32index: location to put the value at, zero-based.
bool16value: the boolean value to put.
virtual void IPDFDPartMetadataUtils::PutDict (CosObjID dict,
NameType key,
CosObjID value 
)
pure virtual

Adds a dictionary value to the dictionary object.

Parameters
CosObjIDdict: the dictionary object identifier.
NameTypekey: the name of the key.
CosObjIDvalue: the dictionary object value to put.
virtual void IPDFDPartMetadataUtils::PutDict (CosObjID arry,
int32 index,
CosObjID value 
)
pure virtual

Puts a dictionary value at the specified location in the array object.

Parameters
CosObjIDarry: the array object identifier.
int32index: location to put the value at, zero-based.
CosObjIDvalue: the dictionary value to put.
virtual void IPDFDPartMetadataUtils::PutFloat (CosObjID dict,
NameType key,
float value 
)
pure virtual

Adds a float value to the dictionary object.

Parameters
CosObjIDdict: the dictionary object identifier.
NameTypekey: the name of the key.
floatvalue: the float value to put.
virtual void IPDFDPartMetadataUtils::PutFloat (CosObjID arry,
int32 index,
float value 
)
pure virtual

Puts a float value at the specified location in the array object.

Parameters
CosObjIDarry: the array object identifier.
int32index: location to put the value at, zero-based.
floatvalue: the float value to put.
virtual void IPDFDPartMetadataUtils::PutInt (CosObjID dict,
NameType key,
int32 value 
)
pure virtual

Adds an integer value to the dictionary object.

Parameters
CosObjIDdict: the dictionary object identifier.
NameTypekey: the name of the key.
int32value: the integer value to put.
virtual void IPDFDPartMetadataUtils::PutInt (CosObjID arry,
int32 index,
int32 value 
)
pure virtual

Puts an integer value at the specified location in the array object.

Parameters
CosObjIDarry: the array object identifier.
int32index: location to put the value at, zero-based.
int32value: the integer value to put.
virtual void IPDFDPartMetadataUtils::PutName (CosObjID dict,
NameType key,
NameType value 
)
pure virtual

Adds a name value to the dictionary object.

Parameters
CosObjIDdict: the dictionary object identifier.
NameTypekey: the name of the key.
NameTypevalue: the name value to put.
virtual void IPDFDPartMetadataUtils::PutName (CosObjID arry,
int32 index,
NameType value 
)
pure virtual

Puts a name value at the specified location in the array object.

Parameters
CosObjIDarry: the array object identifier.
int32index: location to put the value at, zero-based.
NameTypevalue: the name value to put.
virtual void IPDFDPartMetadataUtils::PutString (CosObjID dict,
NameType key,
const PMStringvalue 
)
pure virtual

Adds a string value to the dictionary object.

Parameters
CosObjIDdict: the dictionary object identifier.
NameTypekey: the name of the key.
constPMString& value: the string value to put.
virtual void IPDFDPartMetadataUtils::PutString (CosObjID arry,
int32 index,
const PMStringvalue 
)
pure virtual

Puts a string value at the specified location in the array object.

Parameters
CosObjIDarry: the array object identifier.
int32index: location to put the value at, zero-based.
constPMString& value: the string value to put.