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

#include <IXMLGenerator.h>

Inheritance diagram for IXMLGenerator:
IPMUnknownCPMUnknown< IXMLGenerator >CXMLGeneratorCPanelBasedXMLGeneratorBasePanelXMLGeneratorDCLSizPanelXMLGenerator

Public Types

enum  { kDefaultIID = IID_IXMLGENERATOR }
 

Public Member Functions

virtual void GenerateBeginTag (IXMLOutStream *s)=0
 
virtual void CollectAttributes (IXMLOutStream *s, IXMLOutStream::AttributeList *attrs)=0
 
virtual void GenerateContent (IXMLOutStream *s, int32 beforeChildIndex=0)=0
 
virtual void GenerateEndTag (IXMLOutStream *s)=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

Interface representing cability to generate XML content. This is used by the export handler; see IXMLHandler.

Member Function Documentation

virtual void IXMLGenerator::CollectAttributes (IXMLOutStreams,
IXMLOutStream::AttributeListattrs 
)
pure virtual

Collects the attributes that belong to a tag. The stream is necessary so that we can access cached path information for converted assets. Converted assets will have their href values replaced with the updated path information.

Parameters
sstream where content written to
attrs[OUT] parameter containing the attributes belonging to given boss object

Implemented in CXMLGenerator.

virtual void IXMLGenerator::GenerateBeginTag (IXMLOutStreams)
pure virtual

Generates the beginning tag and its attributes, and then calls generate content

Parameters
sstream where content written to

Implemented in BasePanelXMLGenerator, and CXMLGenerator.

virtual void IXMLGenerator::GenerateContent (IXMLOutStreams,
int32 beforeChildIndex = 0 
)
pure virtual

Item generates a string of XML code that represents itself.

Parameters
s[OUT] parameter, stream where content written to
beforeChildIndexGenerate the XML content that goes just before the child with index beforeChildIndex

For example:


 <element>before child 0<child0>0</child0>before child1<child1>

Implemented in BasePanelXMLGenerator, DCLSizPanelXMLGenerator, and CXMLGenerator.

virtual void IXMLGenerator::GenerateEndTag (IXMLOutStreams)
pure virtual

Generates ending tag

Parameters
sstream where content written to

Implemented in BasePanelXMLGenerator, and CXMLGenerator.