DL Logo

PDSClassMap Typedefs

PDSClassMap

Header: PDSExpT.h:139

Description

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.

Note: The write functions in the PDSEdit API are not available in Adobe Reader.

Syntax

typedef CosObj PDSClassMap;

Used By

PDSClassMap Functions

PDSClassMapAddAttrObj

Header: PDSWriteProcs.h:684

Description

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.

Related Methods

PDSClassMapGetAttrObj PDSClassMapRemoveAttrObj

Syntax

void PDSClassMapAddAttrObj(IN PDSClassMap classMap, IN ASAtom classAtom, IN PDSAttrObj attrObj);

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.

Exceptions

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

PDSClassMapGetAttrObj

Header: PDSReadProcs.h:596

Description

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.

Related Methods

PDSClassMapAddAttrObj PDSClassMapGetNumAttrObjs

Syntax

void PDSClassMapGetAttrObj(IN PDSClassMap classMap, IN ASAtom classAtom, IN ASInt32 index, OUT PDSAttrObj *attrObj);

Parameters

classMap
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.

PDSClassMapGetNumAttrObjs

Header: PDSReadProcs.h:573

Description

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

This may throw various exceptions.

Related Methods

Syntax

ASInt32 PDSClassMapGetNumAttrObjs(IN PDSClassMap classMap, IN ASAtom classAtom);

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.

PDSClassMapRemoveAttrObj

Header: PDSWriteProcs.h:716

Description

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

Related Methods

PDSClassMapAddAttrObj PDSClassMapRemoveClass

Syntax

void PDSClassMapRemoveAttrObj(IN PDSClassMap classMap, IN ASAtom classAtom, IN PDSAttrObj attrObj);

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.

Exceptions

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

PDSClassMapRemoveClass

Header: PDSWriteProcs.h:699

Description

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

This may raise various exceptions.

Related Methods

Syntax

void PDSClassMapRemoveClass(IN PDSClassMap classMap, IN ASAtom classAtom);

Parameters

classMap
IN/OUT The PDSClassMap from which a class is removed.
classAtom
IN/OUT The ASAtom representing the class to remove from classMap.