IPDFFormXObjectSetupProvider.h

//========================================================================================
// 
// $File$
// 
// Owner: DBerggren
// 
// $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 __IPDFFormXObjectSetupProvider__
#define __IPDFFormXObjectSetupProvider__

#include "PDFID.h"
#include "PMRect.h"
#include "IPDFFormXObjectData.h"

class IDocument;
class IExportValidationCmdData;
class PMMatrix;

class IPDFFormXObjectSetupProvider: public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPDFFORMXOBJECTSETUPPROVIDER };

 enum {
 kNotInContext = 0,
 kBeginStaticContext = 1,
 kContinueStaticContext = 2,
 kAbortStaticContext = 3,
 kEndStaticContextInclude = 4,
 kEndStaticContextExclude = 5,
 kEndStaticContextExcludeBeginNew = 6,

 kPlaceholder = ((int32)-32767)
 };

public: 

 virtual bool16 InterestedIn() = 0;

 virtual void BeginIteration(IExportValidationCmdData* validData) = 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( int32* returnContext,
 FormID* returnFormID,
 K2Vector<FormID>& formsUsedOnPage) = 0;

 //As of Aug 2009 this has one caller: PDFFormXObjectGatherProvider::VisitPageItem
 //and two implementations: MasterPageFormXObjectProvider and DataMergeFormXObjectProvider
 virtual void VisitPageItem( const PMMatrix* masterSpread2LayoutSpreadMatrix, 
 IPMUnknown* pPageItem, 
 int32 nFlags,
 int32* returnContext,
 FormID* returnFormID) = 0;

 virtual bool16 OnIterationCompleted(IPDFFormXObjectData* formData) = 0;

};

#endif