InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IPDFDPartHierarchy Class Referenceabstract
Inheritance diagram for IPDFDPartHierarchy:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPDFDPARTHIERARCHY }
 
enum  DPartNodeType { kNonLeafNode = 0, kLeafNode }
 

Public Member Functions

virtual void SetNodeNameList (const NodeNameList &nodeNames)=0
 
virtual void SetRecordLevel (int32 recordLevel)=0
 
virtual DPartNode * CreateDPartRootNode (DPartNodeType nodeType)=0
 
virtual DPartNode * CreateChildDPart (DPartNode *parentNode, DPartNodeType nodeType)=0
 
virtual void AddPage (DPartNode *leafNode, int32 pageNum, bool16 lastPage)=0
 
virtual void SetMetadata (DPartNode *dpartNode, CosObjID dpmDict)=0
 
virtual CosObj GetDPartRootCosObj ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Enumeration Documentation

enum IPDFDPartHierarchy::DPartNodeType

Enumerates the types of DPart nodes.
Enumerator
kNonLeafNode 

Non-leaf DPart node contains other DPart nodes as its children

kLeafNode 

Leaf DPart node contains a range of PDF pages.

Member Function Documentation

virtual void IPDFDPartHierarchy::AddPage (DPartNode * leafNode,
int32 pageNum,
bool16 lastPage 
)
pure virtual

This method is called to add a page to a leaf DPart node.

Parameters
DPartNode*leafNode: the leaf DPart node.
int32pageNum: the 0-based PDF page number.
bool16lastPage: kTrue if this is the last page for this DPart.
virtual DPartNode* IPDFDPartHierarchy::CreateChildDPart (DPartNode * parentNode,
DPartNodeType nodeType 
)
pure virtual

This method is called to create a child DPart node of a non-leaf DPart. The memory for the node is owned by the core and clients MUST NOT free it.

Parameters
DPartNode*parentNode: the parent DPart node.
DPartNodeTypenodeType: whether to create a non-leaf or leaf node.
Returns
: DPartNode*: the newly created child DPart node.
virtual DPartNode* IPDFDPartHierarchy::CreateDPartRootNode (DPartNodeType nodeType)
pure virtual

This method is called to create the root node of the document part hierarchy. The memory for the node is owned by the core and clients MUST NOT free it.

Parameters
DPartNodeTypenodeType: whether to create a non-leaf or leaf node.
Returns
DPartNode: root node of the document part hierarchy.
virtual CosObj IPDFDPartHierarchy::GetDPartRootCosObj ()
pure virtual

Adobe internal use only.

virtual void IPDFDPartHierarchy::SetMetadata (DPartNode * dpartNode,
CosObjID dpmDict 
)
pure virtual

This method is called to set the DPart Metadata (DPM) of a DPart node.

Parameters
DPartNode*dpartNode: the DPart node to set metadata for.
CosObjIDdpmDict: the DPart metadata dictionary identifier.
virtual void IPDFDPartHierarchy::SetNodeNameList (const NodeNameList & nodeNames)
pure virtual

This method is called to set the names of levels of the document part hierarchy.

Parameters
NodeNameListnodeNames: names of the levels of the document part hierarchy.
virtual void IPDFDPartHierarchy::SetRecordLevel (int32 recordLevel)
pure virtual

This method is called to set the record level of the document part hierarchy. The record level is the zero based level of the document part hierarchy where where each DPart node of that level corresponds to a recipient record.

Parameters
int32recordLevel: record level of the document part hierarchy.