IDocIterationProvider.h

//========================================================================================
// 
// $File$
// 
// Owner: Chris Jones
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Purpose:
// 
//========================================================================================

#ifndef __IDocIterationProvider__
#define __IDocIterationProvider__

#include "PrintID.h"
#include "PMRect.h"
class IDocument;
class PMMatrix;
class IExportValidationCmdData;

class IDocIterationProvider : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDOCITERATIONPROVIDER };

 enum IterationContext
 { 
 kGatherAndValidateBeforePrint = 1,
 kValidateBeforePDFExport = 2,
 kValidateBeforeEPSExport = 3,
 
 kValidateBeforeSVGExport = 4,

 kValidateBeforeHTMLExport = 5,
 kGatherAndValidateBeforePlace = 6,
 kValidateBeforeXFLExport = 8
 };

public: 
 virtual void SetIterationData( IPMUnknown* pIterationData, IterationContext nContext ) = 0;


 virtual bool16 InterestedIn( IterationContext nContext ) = 0;

 virtual bool16 StopIterating() const = 0;

 virtual void BeginIteration() = 0;

 virtual void EndIteration() = 0;

 virtual void BeginPageOrSpread(IDocument* pDoc, 
 const int32 nOutputPage, 
 const UIDRef refPageOrSpread, 
 const PMRect& rectBounds,
 const PMMatrix& boundsToSpreadMatrix ) = 0;

 virtual void EndPageOrSpread() = 0;

 virtual void VisitPageItem( const PMMatrix* masterSpread2LayoutSpreadMatrix, IPMUnknown* pPageItem, int32 nFlags) = 0;

 virtual bool16 OnIterationCompleted() = 0;

 virtual void Cleanup() = 0;

};

#endif

// End, IDocIterationProvider.h.