LayerPDSEdit_Layer
ObjectPDSClassMap

The PDSClassMap (or class map) associates class names with a set of attribute objects. A structural element may have a list of names identifying the classes to which it belongs. Associated attributes are shared by all structural elements belonging to a given class. There is only one class map per document, associated with the PDSTreeRoot.


Typedef Summary
 Typedef
 PDSClassMap
Associates class identifiers, which are names, with objects of type PDSAttrObj. Structural elements maintain a list of names identifying classes to which they belong. The associated attributes are thus shared by all structural elements belonging to a given class. There is one class map per document, associated with the PDSTreeRoot.
Method Summary
 Method
 
void PDSClassMapAddAttrObj(INPDSClassMap classMap, INASAtom classAtom, INPDSAttrObj attrObj)
Adds the specified attribute object to the specified PDSClassMap for the given class name. If the attribute object is already present, it is not added a second time.
 
void PDSClassMapGetAttrObj(INPDSClassMap classMap, INASAtom classAtom, INASInt32 index, OUTPDSAttrObj* attrObj)
Gets the attribute object associated with the specified class name at an index in the class.
 
ASInt32 PDSClassMapGetNumAttrObjs(INPDSClassMap classMap, INASAtom classAtom)
Gets the number of attribute objects associated with a class name.
 
void PDSClassMapRemoveAttrObj(INPDSClassMap classMap, INASAtom classAtom, INPDSAttrObj attrObj)
Removes the specified attribute object from the specified PDSClassMap. If classAtom is ASAtomNull, it removes all occurrences of attrObj in the entire classMap.
 
void PDSClassMapRemoveClass(INPDSClassMap classMap, INASAtom classAtom)
Removes the specified class from the specified PDSClassMap, if it exists.

Typedefs Detail
PDSClassMap 
Product availability: All
Platform availability: All

Syntax

typedef CosObj PDSClassMap;

Associates class identifiers, which are names, with objects of type PDSAttrObj. Structural elements maintain a list of names identifying classes to which they belong. The associated attributes are thus shared by all structural elements belonging to a given class. There is one class map per document, associated with the PDSTreeRoot.


File: PDSExpT.h
Line: 148



Method Detail
PDSClassMapAddAttrObj()
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDSClassMapAddAttrObj(INPDSClassMap classMap, INASAtom classAtom, INPDSAttrObj attrObj)

Adds the specified attribute object to the specified PDSClassMap for the given class name. If the attribute object is already present, it is not added a second time.

Parameters

classMap — 

The PDSClassMap to which the specified attribute object is added.

 
classAtom — 

The ASAtom representing the class name.
 
attrObj — 

The attribute object to add to the class in classAtom.

See Also

PDSClassMapGetAttrObj
PDSClassMapRemoveAttrObj

Exceptions

pdsErrBadPDF is raised if an error is found in the PDF file.

Since

PI_PDS_WRITE_VERSION >= 0x00040000

File: PDSWriteProcs.h
Line: 711
PDSClassMapGetAttrObj() 
Product availability: All
Platform availability: All

Syntax

void PDSClassMapGetAttrObj(INPDSClassMap classMap, INASAtom classAtom, INASInt32 index, OUTPDSAttrObj* attrObj)

Gets the attribute object associated with the specified class name at an index in the class.

If there is only one object and index is zero, that object is retrieved.

This may throw various exceptions.

Parameters

classMap — 

The PDSClassMap.

 
classAtom — 

The ASAtom of a class name for which an associated attribute objects is found.

 
index — 

The index of the desired attribute object in the class.

 
attrObj — 

(Filled by the method) The attribute object at index. Set it to CosNull if there is no attribute object at the specified location.

See Also

PDSClassMapAddAttrObj
PDSClassMapGetNumAttrObjs

Since

PI_PDS_READ_VERSION >= 0x00040000

File: PDSReadProcs.h
Line: 632
PDSClassMapGetNumAttrObjs() 
Product availability: All
Platform availability: All

Syntax

ASInt32 PDSClassMapGetNumAttrObjs(INPDSClassMap classMap, INASAtom classAtom)

Gets the number of attribute objects associated with a class name.

This may throw various exceptions.

Parameters

classMap — 

IN/OUT The PDSClassMap.

 
classAtom — 

IN/OUT The ASAtom of a class name for which the number of associated attribute objects is found.

Returns

The number of attribute objects associated with the class in classAtom.

See Also

PDSClassMapGetAttrObj

Since

PI_PDS_READ_VERSION >= 0x00040000

File: PDSReadProcs.h
Line: 606
PDSClassMapRemoveAttrObj() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDSClassMapRemoveAttrObj(INPDSClassMap classMap, INASAtom classAtom, INPDSAttrObj attrObj)

Removes the specified attribute object from the specified PDSClassMap. If classAtom is ASAtomNull, it removes all occurrences of attrObj in the entire classMap.

Parameters

classMap — 

The PDSClassMap from which the specified attribute object is removed.

 
classAtom — 

The ASAtom of a class name for which the associated attribute object is found.

 
attrObj — 

The attribute object to remove from classMap.

See Also

PDSClassMapAddAttrObj
PDSClassMapRemoveClass

Exceptions

pdsErrBadPDF is raised if an error is found in the PDF file.

Since

PI_PDS_WRITE_VERSION >= 0x00040000

File: PDSWriteProcs.h
Line: 745
PDSClassMapRemoveClass() 
Product availability: Acrobat, PDFL
Platform availability: Macintosh, Windows, UNIX

Syntax

void PDSClassMapRemoveClass(INPDSClassMap classMap, INASAtom classAtom)

Removes the specified class from the specified PDSClassMap, if it exists.

This may raise various exceptions.

Parameters

classMap — 

IN/OUT The PDSClassMap from which a class is removed.
 
classAtom — 

IN/OUT The ASAtom representing the class to remove from classMap.

See Also

PDSClassMapRemoveAttrObj

Since

PI_PDS_WRITE_VERSION >= 0x00040000

File: PDSWriteProcs.h
Line: 726



© 2004-2013 Adobe Systems Incorporated. All rights reserved.
Thu Jan 21 2016, 11:19 AM IST