IPrintSetupProvider.h

//========================================================================================
// 
// $File$
// 
// Owner: David Berggren
// 
// $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:
// Provider interface for setting up or changing the print parameters, prior to
// and during the printing process.
// 
// Use the helper class CPrintSetupProvider.h to inherit from instead of this
// pure virtual class, so that any future methods added will not break existing
// implementations.
// 
//========================================================================================

#ifndef __IPrintSetupProvider__
#define __IPrintSetupProvider__

#include "IPMUnknown.h"
#include "IPrintCmdData.h"
#include "IBookOutputActionCmdData.h"

class IPrintData;
class IDocument;
class IBook;
class IOutputPages;
class IInkList;
class IPrintJobData;
class ITrapStyleListMgr;
class IViewPort;
class PMRect;
class GraphicsData;
class IInCopyGalleyPrintData;
class IInCopyLayoutPrintData;

class IPrintSetupProvider : public IPMUnknown
{
public:
 virtual void StartPrintPub (
 bool16& bReturn,
 IDocument* iDoc,
 UIDRef& styleUIDRef,
 IPrintCmdData::PrintUIOptions& printPubUIOpt,
 IInkList* iInkList,
 ITrapStyleListMgr* iTrapListMgr
 ) = 0;

 virtual void StartPrintBook (
 bool16& bReturn,
 IBook* iBook,
 UIDList* pubsUIDList,
 IBookOutputActionCmdData::OutputUIOptions& printBookUIOpt,
 IInkList* iInkList,
 ITrapStyleListMgr* iTrapListMgr
 ) = 0;

 virtual void BeforePrintUI (
 bool16& bReturn,
 IPrintData* iPrintData
 ) = 0;

 virtual void BeforeInCopyPrintUI (
 bool16& bReturn,
 int32 currentPanel,
 IInCopyGalleyPrintData* iGalleyPrintData,
 IInCopyLayoutPrintData* iLayoutPrintData,
 IPrintData* iPrintData
 ) = 0;

 virtual void AfterPrintUI (
 bool16& bReturn,
 IPrintData* iPrintData
 ) = 0;

 virtual void AfterInCopyPrintUI (
 bool16& bReturn,
 int32 currentPanel,
 IInCopyGalleyPrintData* iGalleyPrintData,
 IInCopyLayoutPrintData* iLayoutPrintData,
 IPrintData* iPrintData
 ) = 0;

 virtual void BeforePrintGatherCmd (
 bool16& bReturn,
 IPrintData* iPrintData,
 IOutputPages* iOutputPages
 ) = 0;

 virtual void AfterPrintGatherCmd (
 bool16& bReturn,
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData
 ) = 0;


 virtual void BeforePrintJobParamsInit (
 bool16& bReturn,
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData
 ) = 0;

 virtual void AfterPrintJobParamsInit (
 bool16& bReturn,
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData
 ) = 0;

 virtual void BeforePrintLoop (
 bool16& bReturn,
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData
 ) = 0;

 virtual void EndPrint() = 0;


 //
 // Print Loop
 //

 virtual void BeginPageEvent (
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData,
 int32* whichPage
 ) = 0;

 virtual void BeforeDrawPageEvent (
 bool16& bReturn,
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData,
 int32* whichPage
 ) = 0;

 virtual void BeforeDrawPage (
 bool16& bReturn,
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 int32* whichPage,
 PMRect* outputRect,
 GraphicsData* gd
 ) = 0;

 virtual void AfterDrawPageEvent (
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData,
 int32* whichPage
 ) = 0;

 virtual void BeforeDrawGalleyPageEvent (
 bool16& bReturn,
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData,
 int32* whichPage
 ) = 0;

 virtual void BeforeDrawGalleyPage (
 bool16& bReturn,
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 int32* whichPage,
 PMRect* outputRect,
 GraphicsData* gd
 ) = 0;

 virtual void AfterDrawGalleyPageEvent (
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData,
 int32* whichPage
 ) = 0;

 virtual void EndPageEvent (
 IPrintData* iPrintData,
 IOutputPages* iOutputPages,
 IPrintJobData* iPrintJobData,
 int32* whichPage
 ) = 0;

 virtual void EndPrintingEvent ( ) = 0;

 virtual void PrintErrorEvent (
 bool16& bReturn,
 IPrintData* iPrintData,
 ErrorCode& errorNum,
 PMString& errComponent,
 PMString& errText,
 PMString& errOtherInfo
 ) = 0;
};

#endif