CDocIterationProvider Class Reference

Inheritance diagram for CDocIterationProvider:

Public Member Functions
	CDocIterationProvider (IPMUnknown *pBoss)
virtual void	SetIterationData (IPMUnknown *pIterationData, IterationContext nContext)
virtual bool16	InterestedIn (IterationContext nContext)
virtual bool16	StopIterating () const
virtual void	BeginIteration ()
virtual void	EndIteration ()
virtual void	BeginPageOrSpread (IDocument *pDoc, const int32 nOutputPage, const UIDRef refPageOrSpread, const PMRect &rectBounds, const PMMatrix &boundsToSpreadMatrix)
virtual void	EndPageOrSpread ()
virtual void	VisitPageItem (const PMMatrix *pXForm, IPMUnknown *pPageItem, int32 nFlags)
virtual bool16	OnIterationCompleted ()
virtual void	Cleanup ()

Protected Member Functions
virtual void	Clear ()
bool16	ShowVerificationWarning (IExportValidationCmdData *pData, int32 nTest)
bool16	ShowVerificationError (IExportValidationCmdData *pData, int32 nTest)
bool16	ShowVerificationWarningDontShowAgain (IExportValidationCmdData *pData, int32 nTest, int32 nWarningID)

Protected Attributes
IPMUnknown *	fpIterationData
IDocument *	fpDocument
IterationContext	fnIterationContext
int32	fnCurrentPage

Additional Inherited Members
Public Types inherited from IDocIterationProvider
enum	{ kDefaultIID = IID_IDOCITERATIONPROVIDER }
enum	IterationContext {   kGatherAndValidateBeforePrint = 1, kValidateBeforePDFExport = 2, kValidateBeforeEPSExport = 3, kValidateBeforeSVGExport = 4,   kValidateBeforeHTMLExport = 5, kGatherAndValidateBeforePlace = 6, kValidateBeforeXFLExport = 8 }

Member Function Documentation

virtual void CDocIterationProvider::BeginIteration ( )

virtual

Called at the beginning of the iteration.

Implements IDocIterationProvider.

virtual void CDocIterationProvider::BeginPageOrSpread ( IDocument *  pDoc, const int32  nOutputPage, const UIDRef  refPageOrSpread, const PMRect &  rectBounds, const PMMatrix &  boundsToSpreadMatrix  )

virtual

Beginning of a page or spread in the iteration.

Parameters

pDoc	IN pointer to the IDocument
nOutputPage	IN index of the current page or spread
refPageOrSpread	IN the UIDRef of the page or spread
rectBounds	IN bounds of the page or spread in that objects coordinate system
boundsToSpreadMatrix	IN the transformation matrix that maps the rectBounds of a page to spread coordinates. This matrix will be an identity matrix when printing or exporting spreads.

Implements IDocIterationProvider.

virtual void CDocIterationProvider::Cleanup ( )

virtual

Allows the provider to do cleanup tasks.

Implements IDocIterationProvider.

virtual void CDocIterationProvider::EndIteration ( )

virtual

Called at the end of the iteration.

Implements IDocIterationProvider.

virtual void CDocIterationProvider::EndPageOrSpread ( )

virtual

End of a page or spread.

Implements IDocIterationProvider.

virtual bool16 CDocIterationProvider::InterestedIn ( IterationContext  nContext )

virtual

Determines if the iteration provider is interested in participating in the specified iteration context.

Parameters

nContext

IN the iteration context

Returns

bool16 kTrue if interested in participating, kFalse otherwise

Implements IDocIterationProvider.

virtual bool16 CDocIterationProvider::OnIterationCompleted ( )

virtual

Allows the provider to do whatever it wants when the iteration completes. Can be used to display error or warning messages.

Returns

bool16 if kFalse returned, other providers will not be called (i.e. if the operation was cancelled).

Implements IDocIterationProvider.

virtual void CDocIterationProvider::SetIterationData ( IPMUnknown *  pIterationData, IterationContext  nContext  )

virtual

Used by the iteration code to set the context and a data interface specific to the context.

Parameters

pIterationData	IN data interface specific to the given iteration context
nContext	IN the iteration context defined above

Implements IDocIterationProvider.

virtual bool16 CDocIterationProvider::StopIterating ( ) const

virtual

Whether to stop the iteration.

Returns

bool16 kTrue stops the iteration.

Implements IDocIterationProvider.

virtual void CDocIterationProvider::VisitPageItem ( const PMMatrix *  masterSpread2LayoutSpreadMatrix, IPMUnknown *  pPageItem, int32  nFlags  )

virtual

Process an item on the page. Called for each page item.

Parameters

masterSpread2LayoutSpreadMatrix	IN the page item's transformation matrix
pPageItem	IN the page item itself
nFlags	IN the current drawing flags

Implements IDocIterationProvider.