IPrintProgress Class Reference

#include <IPrintCmdData.h>

Inheritance diagram for IPrintProgress:

Public Member Functions
virtual void	Initialize (int32 nPrintTo, bool16 bPrintReverse)=0
virtual void	StartPrint (int32 nPages)=0
virtual void	BeginPage (UIDRef &uidPage, int32 whichPage)=0
virtual void	DrawPage (int32 whichPage, PMString &currInkStr)=0
virtual Bool8	Update (float current, const char *name, long stage)=0
virtual void	EndPage (int32 whichPage)=0
virtual void	EndPrint ()=0
virtual bool16	WasCancelled ()=0
virtual void	ClearSubTaskProgress ()=0
virtual void	SetSupressStartStopPrint (bool16 bSupress)=0
virtual void	SetCurrentSubtaskText (const char *pszText)=0
virtual void	BeginGalleyPage (int32 whichPage)=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

Print progress bar information

Member Function Documentation

virtual void IPrintProgress::BeginGalleyPage ( int32  whichPage )

pure virtual

Begin a galley page - InCopy specific

Parameters

whichPage

IN which page is beginning

virtual void IPrintProgress::BeginPage ( UIDRef &  uidPage, int32  whichPage  )

pure virtual

Begin a page

Parameters

uidPage	IN UIDRef of the page begin printed, or UIDRef::gNull
whichPage	IN if uidPage is null, use this as the page number

virtual void IPrintProgress::ClearSubTaskProgress ( )

pure virtual

Clear the sub task progress information

virtual void IPrintProgress::DrawPage ( int32  whichPage, PMString &  currInkStr  )

pure virtual

Draw a page

Parameters

whichPage	IN which page being printed
currInkStr	IN either "Composite" or the plate name

virtual void IPrintProgress::EndPage ( int32  whichPage )

pure virtual

End a page

Parameters

whichPage

IN which page is ending

virtual void IPrintProgress::EndPrint ( )

pure virtual

End printing

virtual void IPrintProgress::Initialize ( int32  nPrintTo, bool16  bPrintReverse  )

pure virtual

Initialize the class

Parameters

nPrintTo	IN where we are printing to, i.e. from IPrintData::GetPrintTo
bPrintReverse	IN if we are printing in reverse order

virtual void IPrintProgress::SetCurrentSubtaskText ( const char *  pszText )

pure virtual

Set the current sub task text

Parameters

pszText

IN the new text to display

virtual void IPrintProgress::SetSupressStartStopPrint ( bool16  bSupress )

pure virtual

Supress the creation of the RangeProgressBar in StartPrint

Parameters

bSupress

IN kTrue to supress progress bar creation, kFalse otherwise

virtual void IPrintProgress::StartPrint ( int32  nPages )

pure virtual

Start the printing - this will construct a RangeProgressBar

Parameters

nPages

IN the number of pages printing

virtual Bool8 IPrintProgress::Update ( float  current, const char *  name, long  stage  )

pure virtual

Callback that is called by AGM Print

Parameters

current	IN current percentage done
name	IN current name of resource
stage	IN current stage of callback - defined in GraphicsExternal.h

Returns

kTrue if cancelled, kFalse otherwise

See Also

GraphicsExternal.h

virtual bool16 IPrintProgress::WasCancelled ( )

pure virtual

Check if progress has been cancelled

Returns

kTrue if cancelled, kFalse otherwise