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

#include <IXMLExportHandler.h>

Inheritance diagram for IXMLExportHandler:
IPMUnknownCPMUnknown< IXMLExportHandler >DataUpdaterExportHandler

Public Types

enum  { kDefaultIID = IID_IXMLEXPORTHANDLER }
 

Public Member Functions

virtual bool16 CanHandleElement (IIDXMLElement *element)=0
 
virtual bool16 HandleElementBefore (IXMLOutStream *stream, IIDXMLElement *element)=0
 
virtual bool16 HandleAfterNthChild (IXMLOutStream *stream, IIDXMLElement *element, int32 childIndex)=0
 
virtual bool16 HandleElementAfter (IXMLOutStream *stream, IIDXMLElement *element)=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

Export Handler interface, gets called for every element of the structure tree, when tree is iterated. this interface is on a service provider that provides service for kXMLExportHandlerSignalService. It gets asked whether or not it wants to export each element. It can respond yes (and will get called to handle) or no (and will not get called)

Member Function Documentation

virtual bool16 IXMLExportHandler::CanHandleElement (IIDXMLElementelement)
pure virtual

Called before element processed to determine whether this interface wants to handle it.

Parameters
elementspecifies current node in structure tree during traversal
Returns
kTrue - Yes I will handle it : kFalse - No I will not

Implemented in DataUpdaterExportHandler.

virtual bool16 IXMLExportHandler::HandleAfterNthChild (IXMLOutStreamstream,
IIDXMLElementelement,
int32 childIndex 
)
pure virtual

Called after each child is processed. This is the place to do stuff in between child elements

Parameters
streamspecifies the stream out export the element to
elementspecifies current node in structure tree during traversal
childIndexindex in parent of child
Returns
kTrue - I handled this element : kFalse - I did not handle this element

Implemented in DataUpdaterExportHandler.

virtual bool16 IXMLExportHandler::HandleElementAfter (IXMLOutStreamstream,
IIDXMLElementelement 
)
pure virtual

Called after element processed. Use this to close the element after all of its children/content has been exported.

Parameters
streamspecifies the stream out export the element to
elementspecifies current node in structure tree during traversal
Returns
kTrue - I handled this element : kFalse - I did not handle this element

Implemented in DataUpdaterExportHandler.

virtual bool16 IXMLExportHandler::HandleElementBefore (IXMLOutStreamstream,
IIDXMLElementelement 
)
pure virtual

Called before element processed.

Parameters
streamspecifies the stream out export the element to
elementspecifies current node in structure tree during traversal
Returns
kTrue - I handled this element : kFalse - I did not handle this element

Implemented in DataUpdaterExportHandler.