InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IXMLTransformer Class Referenceabstract

#include <IXMLTransformer.h>

Inheritance diagram for IXMLTransformer:
IPMUnknownCPMUnknown< IXMLTransformer >CXMLTransformerXDocBkXMLTransformer

Public Types

enum  { kDefaultIID = IID_IXMLTRANSFORMER }
 

Public Member Functions

virtual ErrorCode TransformStream (const IPMStream *in, IPMStream **out, IPMUnknown *xmlImporter=nil)=0
 
virtual ErrorCode TransformDOM (IIDXMLDOMDocument *dom, IPMUnknown *xmlImporter=nil)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This class can be used during two different phases of the XML import.

The first phase is while there is a stream. During this phase you can pass the stream to a transformer using an XSLt script.

The second phase will occur imediately after the DOM has been created. During this phase you can manually manipulate the DOM by inserting, removing, and changing elements.

Place this interface on the same boss as a service provider that supports kXMLImporterTransformerService to ensure that it gets called at the appropriate times.

Member Function Documentation

virtual ErrorCode IXMLTransformer::TransformDOM (IIDXMLDOMDocumentdom,
IPMUnknownxmlImporter = nil 
)
pure virtual

Transform a DOM

Parameters
dom- The DOM to be manipulated
xmlImporter- A pointer to the importer boss (so we can get import data)
Returns
- kSuccess if the transform succeeded.

Implemented in XDocBkXMLTransformer, and CXMLTransformer.

virtual ErrorCode IXMLTransformer::TransformStream (const IPMStreamin,
IPMStream ** out,
IPMUnknownxmlImporter = nil 
)
pure virtual

Transform an XML stream using an XSLT script

Parameters
in- The original stream
out- The new stream. (nil if no transformation occurred)
xmlImporter- A pointer to the importer boss (so we can get import data)
Returns
- kSuccess if the transform succeeded.

Implemented in CXMLTransformer.