InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IXMLPostImportIteration Class Referenceabstract

#include <IXMLPostImportIteration.h>

Inheritance diagram for IXMLPostImportIteration:
IPMUnknownCPMUnknown< IXMLPostImportIteration >XDocBkXMLPostImportIteration

Public Types

enum  { kDefaultIID = IID_IXMLPOSTIMPORTITERATION }
 

Public Member Functions

virtual bool16 ShouldIterate (IPostImportResponderData *responderData)=0
 
virtual ErrorCode BeforeIteration (IPostImportResponderData *responderData)=0
 
virtual ErrorCode HandleElement (IIDXMLElement *element, IIDXMLDOMNode *domNode)=0
 
virtual ErrorCode AfterIteration ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

An interface used by XMLPostImportIterationResponder. Client code that wants to iterate the imported elements depth-first during the post-import phase of XML import can regiester for kXMLPostImportIterationService and implement this interface.

See Also
kXMLImporterPostImportMappingBoss for an example

Member Function Documentation

virtual ErrorCode IXMLPostImportIteration::AfterIteration ()
pure virtual

This method is called by XMLPostImportIterationResponder after the depth-first iteration.

Returns
kSuccess if succeeds. Otherwise an error code.

Implemented in XDocBkXMLPostImportIteration.

virtual ErrorCode IXMLPostImportIteration::BeforeIteration (IPostImportResponderData * responderData)
pure virtual

This method is called by XMLPostImportIterationResponder before the depth-first iteration.

Parameters
responderDataThe responder data from kXMLImporterPostImportSignalMgrBoss.
Returns
kSuccess if succeeds. Otherwise an error code.

Implemented in XDocBkXMLPostImportIteration.

virtual ErrorCode IXMLPostImportIteration::HandleElement (IIDXMLElement * element,
IIDXMLDOMNode * domNode 
)
pure virtual

This method is called by XMLPostImportIterationResponder during the depth-first iteration. One possible usage of this method is to map the element's tag to a style.

Parameters
elementThe element being iterated.
domNodeThe corresponding DOM node to the element, if there is one. Could be nil.
Returns
kSuccess if succeeds. Otherwise an error code.

Implemented in XDocBkXMLPostImportIteration.

virtual bool16 IXMLPostImportIteration::ShouldIterate (IPostImportResponderData * responderData)
pure virtual

This method is called by XMLPostImportIterationResponder during the setup period. XMLPostImportIterationResponder asks each services on whether it wants to be iterated. If yes (returns kTrue), then the callbacks for iteration will be called. If no (returns kFalse), then this service will not be called during iteration. The service should return kFalse if it does not plan on performing any work during the iteration

Parameters
responderDataThe responder data from kXMLImporterPostImportSignalMgrBoss.
Returns
bool16 kTrue if this service should be iterated. kFalse if this service should not be iterated

Implemented in XDocBkXMLPostImportIteration.