#include <CPrintSetupProvider.h>

Inheritance diagram for CPrintSetupProvider:

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

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

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

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

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

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

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

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

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

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

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

virtual void	EndPrint ()

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

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

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

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

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

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

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

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

virtual void	EndPrintingEvent ()

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

Detailed Description

Stubbed out default implementation of the IPrintSetupProvider interface, which is used for setting up or changing the print parameters, prior to and during the printing process.

Users can subclass from this class, and only have to override methods that they are interested in.

See Also: IPrintSetupProvider

Member Function Documentation

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

inlinevirtual

Print Loop - After Draw Galley Page Event - same as AfterDrawPageEvent, only for InCopy

Parameters

iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages didn't containing the pages UID (GetNthUIDRef() will return non page UIDRef), rather, it contains the physcial galley page number.
iPrintJobData	IN the IPrintJobData containing the gathered information
whichPage	IN which page is being printed - can be used as index into IOutputPages

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Print Loop - After DrawPage Event

Parameters

iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info
iPrintJobData	IN the IPrintJobData containing the gathered information
whichPage	IN which page is being printed - can be used as index into IOutputPages

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

After the InCopy Print UI is shown.

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.

Implements IPrintSetupProvider.

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

inlinevirtual

After the print gather command

Parameters

bReturn	OUT return value - true means continue on, false means STOP
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info
iPrintJobData	IN the IPrintJobData containing the gathered information

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

After initialization of the Print Job Params

Parameters

bReturn	OUT return value - true means continue on, false means STOP
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info
iPrintJobData	IN the IPrintJobData containing the gathered information

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

After the InDesign Print UI is shown

Parameters

bReturn	OUT return value - true means continue on, false means STOP
iPrintData	IN the IPrintData containing all the print settings to be used

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider, and PrnSelPrintSetupProvider.

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

inlinevirtual

Print Loop - Before Draw Galley Page - same as BeforeDrawPage, only for InCopy

Parameters

bReturn	OUT return value - true means continue on, false means don't draw page/spread
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages didn't containing the pages UID (GetNthUIDRef() will return non page UIDRef), rather, it contains the physcial galley page number.
iPrintJobData	IN the IPrintJobData containing the gathered information
whichPage	IN which page is being printed - can be used as index into IOutputPages
outputRect	IN the rect which is used for setting up the draw mgr filter
gd	IN from which you can get IGraphicsPort, IViewPortAttributes etc.

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Print Loop - Before Draw Galley Page Event - same as BeforeDrawPageEvent, only for InCopy

Parameters

bReturn	OUT return value - true means continue on, false means continue to next event
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages didn't containing the pages UID (GetNthUIDRef() will return non page UIDRef), rather, it contains the physcial galley page number.
iPrintJobData	IN the IPrintJobData containing the gathered information
whichPage	IN which page is being printed - can be used as index into IOutputPages

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Print Loop - Before DrawPage performed

Parameters

bReturn	OUT return value - true means continue on, false means don't draw page/spread
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info
iPrintJobData	IN the IPrintJobData containing the gathered information
whichPage	IN which page is being printed - can be used as index into IOutputPages
outputRect	IN the rect which is used for setting up the draw mgr filter
gd	IN from which you can get IGraphicsPort, IViewPortAttributes etc.

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Print Loop - Before DrawPage Event

Parameters

bReturn	OUT return value - true means continue on, false means continue to next event
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info
iPrintJobData	IN the IPrintJobData containing the gathered information
whichPage	IN which page is being printed - can be used as index into IOutputPages

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Before the InCopy Print UI is shown.

Parameters

bReturn	OUT Return value: true to continue, false to 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.

Implements IPrintSetupProvider.

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

inlinevirtual

Before the print gather command

Parameters

bReturn	OUT return value - true means continue on, false means STOP
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider, PrnSelPrintSetupProvider, and CusCondTxtPrintSetupProvider.

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

inlinevirtual

Before initialization of the Print Job Params

Parameters

bReturn	OUT return value - true means continue on, false means STOP
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info
iPrintJobData	IN the IPrintJobData containing the gathered information

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Before the beginning of the execution of the print loop. After information is put into the print record (print driver settings) if printing to a printer

Parameters

bReturn	OUT return value - true means continue on, false means STOP
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info
iPrintJobData	IN the IPrintJobData containing the gathered information

Implements IPrintSetupProvider.

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

inlinevirtual

Before the InDesign Print UI is shown

Parameters

bReturn	OUT return value - true means continue on, false means don't show print UI
iPrintData	IN the IPrintData containing all the print settings to be used

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Print Loop - BeginPageEvent

Parameters

bReturn	OUT return value - true means continue on, false means STOP
iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info
iPrintJobData	IN the IPrintJobData containing the gathered information
whichPage	IN which page is being printed - can be used as index into IOutputPages

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Print Loop - EndPage Event

Parameters

iPrintData	IN the IPrintData containing all the print settings to be used
iOutputPages	IN the IOutputPages containing which pages to gather info
iPrintJobData	IN the IPrintJobData containing the gathered information
whichPage	IN which page is being printed - can be used as index into IOutputPages

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

virtual void CPrintSetupProvider::EndPrint ( void )

inlinevirtual

End of Printing. Doing so ensures that the ref counts for

all interfaces are properly decremented and any other cleanup tasks are completed.

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider, PrnSelPrintSetupProvider, and CusCondTxtPrintSetupProvider.

virtual void CPrintSetupProvider::EndPrintingEvent ( void )

inlinevirtual

Print Loop - EndPrinting Event

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Print Loop - Error Event

Parameters

bReturn	OUT return value - true means continue on, false means don't set the global error code NOTE: this is an error event from AGM. InD maps the error number to set strings, which are localized. We do not use the errText that this event provides.
iPrintData	IN the IPrintData containing all the print settings to be used
errorNum	IN the error number
errComponent	IN the error component from Bravo
errText	IN the error text
errOtherInfo	IN other error information, i.e. name of a problem font

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Start of Printing of 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 means continue on, false means STOP
iBook	IN the IBook interface of the book being printed
pubsUIDList	IN the UIDList of the pubs in the book that are being printed
printBookUIOpt	IN UI options invoked - see IBookOutputActionCmdData.h for definitions
iInkList	IN the ink list to be used throughout the print job
iTrapListMgr	IN the trap list manager to be used throughout the print job

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

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

inlinevirtual

Start of Printing of 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 means continue on, false means STOP
iDoc	IN the 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 the ink list to be used throughout the print job
iTrapListMgr	IN the trap list manager to be used throughout the print job

Implements IPrintSetupProvider.

Reimplemented in PrtMemPrintSetupProvider.

Public Member Functions

Detailed Description

Member Function Documentation