IPrintSetupProvider Class Reference

#include <IPrintSetupProvider.h>

Inheritance diagram for IPrintSetupProvider:

Public Member Functions
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
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
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

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.

Member Function Documentation

virtual void IPrintSetupProvider::AfterDrawGalleyPageEvent ( IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData, int32 *  whichPage  )

pure virtual

Called after an InCopy draw galley page event is processed.

Parameters

iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output. The IOutputPages GetNthUIDRef() method returns the physcial galley page number, not the page's UIDRef.
iPrintJobData	IN IPrintJobData containing the gathered information.
whichPage	IN Which page is being printed; can be used as index into IOutputPages.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::AfterDrawPageEvent ( IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData, int32 *  whichPage  )

pure virtual

Called after a draw page event is processed.

Parameters

iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output.
iPrintJobData	IN IPrintJobData containing the gathered information.
whichPage	IN Which page is being printed; can be used as index into IOutputPages.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::AfterInCopyPrintUI ( bool16 &  bReturn, int32  currentPanel, IInCopyGalleyPrintData *  iGalleyPrintData, IInCopyLayoutPrintData *  iLayoutPrintData, IPrintData *  iPrintData  )

pure virtual

Called after the InCopy Print UI dialog is closed. The PM global error code will be set to kCancel if the Print UI was cancelled.

Parameters

bReturn	OUT Return value: true to continue, false to stop.
currentPanel	IN which panel is currently active, IInCopyPrintDialogData::kGalleyPanel or IInCopyPrintDialogData::kLayoutPanel.
iGalleyPrintData	IN IInCopyGalleyPrintData containing galley print settings to be used, if the currentPanel is IInCopyPrintDialogData::kGalleyPanel.
iLayoutPrintData	IN IInCopyLayoutPrintData containing layout print settings to be used, if the currentPanel is IInCopyPrintDialogData::kLayoutPanel.
iPrintData	IN IPrintData containing the print settings to be used. This interface will be intialized by the relevant settings from iGalleyPrintData or iLayoutPrintData.

Implemented in CPrintSetupProvider.

virtual void IPrintSetupProvider::AfterPrintGatherCmd ( bool16 &  bReturn, IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData  )

pure virtual

Called after the print gather command.

Parameters

bReturn	OUT Return value: true to continue, false to stop.
iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages the info was gathered for.
iPrintJobData	IN IPrintJobData containing the gathered information.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::AfterPrintJobParamsInit ( bool16 &  bReturn, IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData  )

pure virtual

Called after initialization of the print job parameters.

Parameters

bReturn	OUT Return value: true to continue, false to stop.
iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output.
iPrintJobData	IN IPrintJobData containing the gathered information.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::AfterPrintUI ( bool16 &  bReturn, IPrintData *  iPrintData  )

pure virtual

Called after the InDesign Print UI dialog is closed. The PM global error code will be set to kCancel if the Print UI was cancelled.

Parameters

bReturn	OUT Return value: true to continue, false to stop.
iPrintData	IN IPrintData containing all the print settings to be used.

Implemented in CPrintSetupProvider, PrtMemPrintSetupProvider, and PrnSelPrintSetupProvider.

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

pure virtual

Called before an InCopy galley page is drawn.

Parameters

bReturn	OUT Return value: true to continue, false to not draw page or spread.
iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output. The IOutputPages GetNthUIDRef() method returns the physcial galley page number, not the page's UIDRef.
whichPage	IN Which page is being printed; can be used as index into IOutputPages.
outputRect	IN Rect used for setting up the draw manager filter.
gd	IN Graphics data from which you can get IGraphicsPort, IViewPortAttributes etc.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::BeforeDrawGalleyPageEvent ( bool16 &  bReturn, IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData, int32 *  whichPage  )

pure virtual

Called before an InCopy draw galley page event is processed.

Parameters

bReturn	OUT Return value: true to continue, false to continue to the next event.
iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output. The IOutputPages GetNthUIDRef() method returns the physcial galley page number, not the page's UIDRef.
iPrintJobData	IN IPrintJobData containing the gathered information.
whichPage	IN Which page is being printed; can be used as index into IOutputPages.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

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

pure virtual

Called before a page is drawn.

Parameters

bReturn	OUT Return value: true to continue, false to not draw page or spread.
iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output.
whichPage	IN Which page is being printed; can be used as index into IOutputPages.
outputRect	IN Rect used for setting up the draw manager filter.
gd	IN Graphics data from which you can get IGraphicsPort, IViewPortAttributes etc.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::BeforeDrawPageEvent ( bool16 &  bReturn, IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData, int32 *  whichPage  )

pure virtual

Called before a draw page event is processed.

Parameters

bReturn	OUT Return value: true to continue, false to continue to the next event.
iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output.
iPrintJobData	IN IPrintJobData containing the gathered information.
whichPage	IN Which page is being printed; can be used as index into IOutputPages.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::BeforeInCopyPrintUI ( bool16 &  bReturn, int32  currentPanel, IInCopyGalleyPrintData *  iGalleyPrintData, IInCopyLayoutPrintData *  iLayoutPrintData, IPrintData *  iPrintData  )

pure virtual

Called before the InCopy Print UI dialog is opened.

Parameters

bReturn	OUT Return value: true to continue, false - don't show the Print UI.
currentPanel	IN which panel is currently active, IInCopyPrintDialogData::kGalleyPanel or IInCopyPrintDialogData::kLayoutPanel.
iGalleyPrintData	IN IInCopyGalleyPrintData containing galley print settings to be used, if the currentPanel is IInCopyPrintDialogData::kGalleyPanel.
iLayoutPrintData	IN IInCopyLayoutPrintData containing layout print settings to be used, if the currentPanel is IInCopyPrintDialogData::kLayoutPanel.
iPrintData	IN IPrintData containing the print settings to be used. This interface will be intialized by the relevant settings from iGalleyPrintData or iLayoutPrintData.

Implemented in CPrintSetupProvider.

virtual void IPrintSetupProvider::BeforePrintGatherCmd ( bool16 &  bReturn, IPrintData *  iPrintData, IOutputPages *  iOutputPages  )

pure virtual

Called before the print gather command.

Parameters

bReturn	OUT Return value: true to continue, false to stop.
iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to gather info for.

Implemented in CPrintSetupProvider, PrtMemPrintSetupProvider, PrnSelPrintSetupProvider, and CusCondTxtPrintSetupProvider.

virtual void IPrintSetupProvider::BeforePrintJobParamsInit ( bool16 &  bReturn, IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData  )

pure virtual

Called before initialization of the print job parameters.

Parameters

bReturn	OUT Return value: true to continue, false to stop.
iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output.
iPrintJobData	IN IPrintJobData containing the gathered information.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::BeforePrintLoop ( bool16 &  bReturn, IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData  )

pure virtual

Called before the print loop starts.

Parameters

bReturn	OUT Return value: true to continue, false to stop.
iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output.
iPrintJobData	IN IPrintJobData containing the gathered information.

Implemented in CPrintSetupProvider.

virtual void IPrintSetupProvider::BeforePrintUI ( bool16 &  bReturn, IPrintData *  iPrintData  )

pure virtual

Called before the InDesign Print UI dialog is opened.

Parameters

bReturn	OUT Return value: true to continue, false to don't show the Print UI.
iPrintData	IN IPrintData containing all the print settings to be used.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::BeginPageEvent ( IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData, int32 *  whichPage  )

pure virtual

Called before a begin page event is processed.

Parameters

iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output.
iPrintJobData	IN IPrintJobData containing the gathered information.
whichPage	IN Which page is being printed; can be used as index into IOutputPages.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::EndPageEvent ( IPrintData *  iPrintData, IOutputPages *  iOutputPages, IPrintJobData *  iPrintJobData, int32 *  whichPage  )

pure virtual

Called before an end page event is processed.

Parameters

iPrintData	IN IPrintData containing all the print settings to be used.
iOutputPages	IN IOutputPages containing the pages to output.
iPrintJobData	IN IPrintJobData containing the gathered information.
whichPage	IN Which page is being printed; can be used as index into IOutputPages.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::EndPrint ( )

pure virtual

Called when the printing has ended. Doing so ensures that the ref counts for all interfaces are properly decremented and any other cleanup tasks are completed.. The PM global error code denotes the final status of the print job: kSuccess if the print job completed successfully, kCancel if the print job was cancelled, an error code if the print job failed.

Implemented in CPrintSetupProvider, PrtMemPrintSetupProvider, PrnSelPrintSetupProvider, and CusCondTxtPrintSetupProvider.

virtual void IPrintSetupProvider::EndPrintingEvent ( )

pure virtual

Called before the end printing event is processed.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::PrintErrorEvent ( bool16 &  bReturn, IPrintData *  iPrintData, ErrorCode &  errorNum, PMString &  errComponent, PMString &  errText, PMString &  errOtherInfo  )

pure virtual

Called before an error event is processed. NOTE: This is an error event from AGM. InDesign maps the error number to strings that are localized. We do not use the errText that this event provides.

Parameters

bReturn	OUT Return value: true to continue, false to not set the global error code.
iPrintData	IN IPrintData containing all the print settings to be used.
errorNum	IN Error number.
errComponent	IN Error component from Bravo.
errText	IN Error text.
errOtherInfo	IN Other error information; i.e. name of a problem font.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

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

pure virtual

Called at the start of printing a book. For properly ref counting of interfaces, this must be paired with an EndPrint() call when you are done with printing.

Parameters

bReturn	OUT Return value: true to continue, false to stop.
iBook	IN IBook interface of the book being printed.
pubsUIDList	IN UIDList of the pubs in the book that are being printed.
printBookUIOpt	IN UI options invoked (see IBookOutputActionCmdData.h for definitions).
iInkList	IN Ink list to be used throughout the print job.
iTrapListMgr	IN Trap list manager to be used throughout the print job.

Implemented in CPrintSetupProvider, and PrtMemPrintSetupProvider.

virtual void IPrintSetupProvider::StartPrintPub ( bool16 &  bReturn, IDocument *  iDoc, UIDRef &  styleUIDRef, IPrintCmdData::PrintUIOptions &  printPubUIOpt, IInkList *  iInkList, ITrapStyleListMgr *  iTrapListMgr  )

pure virtual

Called at the start of printing a single pub. For properly ref counting of interfaces, this must be paired with an EndPrint() call when you are done with printing.

Parameters

bReturn	OUT Return value: true to continue, false to stop.
iDoc	IN IDocument of the pub being printed.
styleUIDRef	IN If valid, is the printer style UIDRef to be used.
printPubUIOpt	IN UI options invoked (see IPrintCmdData.h for definitions).
iInkList	IN Ink list to be used throughout the print job.
iTrapListMgr	IN Trap list manager to be used throughout the print job.

Implemented in PrtMemPrintSetupProvider, and CPrintSetupProvider.