InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPrintCmdData Class Referenceabstract

#include <IPrintCmdData.h>

Inheritance diagram for IPrintCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPRINTCMDDATA }
 
enum  {
  kShowPageSetup = 0x0001, kWorkingOnStyle = 0x0002, kWorkingOnBook = 0x0004, kPrintUsingStyle = 0x0008,
  kIsNewStyle = 0x0010, kFromPrintBooklet = 0x0020, kPrintingBooklet = 0x0040, kPreflighting = 0x0080
}
 
enum  PrintUIOptions {
  kSuppressNothing = 0x0, kSuppressPrintProgress = 0x1, kSuppressPrintWarnings = 0x2, kSuppressPrintDialog = 0x4,
  kSuppressFileSaveDialog = 0x8, kSuppressEverything = 0xFF
}
 

Public Member Functions

virtual void SetIDoc (IDocument *iDoc)=0
 
virtual void SetProgressData (IPrintProgress *pProcData)=0
 
virtual void SetPrintData (IPrintData *iPrintData)=0
 
virtual void SetPrintJobData (IPrintJobData *iPrintData)=0
 
virtual void SetInkList (IInkList *iInkList)=0
 
virtual void SetTrapListMgr (ITrapStyleListMgr *iTrapListMgr)=0
 
virtual void SetFlags (const uint32 flags)=0
 
virtual void SetPrintUIOptions (const PrintUIOptions uiOptions)=0
 
virtual void SetPrtStyleUIDRef (const UIDRef prtStyleUIDRef)=0
 
virtual IDocumentGetIDoc () const =0
 
virtual IPrintProgressGetProgressData () const =0
 
virtual IPrintDataGetPrintData () const =0
 
virtual IPrintJobDataGetPrintJobData () const =0
 
virtual IInkListGetInkList () const =0
 
virtual ITrapStyleListMgrGetTrapListMgr () const =0
 
virtual uint32 GetFlags () const =0
 
virtual PrintUIOptions GetPrintUIOptions () const =0
 
virtual UIDRef GetPrtStyleUIDRef () const =0
 
virtual uint32 GetNumberOfExportedPages () const =0
 
virtual void SetNumberOfExportedPages (uint32 numPages)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Print command data - data container for most print commands

Member Enumeration Documentation

anonymous enum

Print flags

Print UI options

Member Function Documentation

virtual uint32 IPrintCmdData::GetFlags () const
pure virtual

Get method for print flags

Returns
print flags to use
virtual IDocument* IPrintCmdData::GetIDoc () const
pure virtual

Get method for IDocument

Returns
IDocument pointer to the document being printed
See Also
IDocument
virtual IInkList* IPrintCmdData::GetInkList () const
pure virtual

Get method for IInkList object pointer

Returns
IInkList to use when printing
See Also
IInkList
virtual uint32 IPrintCmdData::GetNumberOfExportedPages () const
pure virtual

Get method for number of pages exported in PDF passthrough mode

Returns
uint32 number of pages exported
virtual IPrintData* IPrintCmdData::GetPrintData () const
pure virtual

Get method for IPrintData object pointer

Returns
IPrintData containing all of the print settings
See Also
IPrintData
virtual IPrintJobData* IPrintCmdData::GetPrintJobData () const
pure virtual

Get method for IPrintJobData object pointer

Returns
IPrintJobData information that was collected
See Also
IPrintJobData
virtual PrintUIOptions IPrintCmdData::GetPrintUIOptions () const
pure virtual

Get method for the print UI options

Returns
print UI options to use
virtual IPrintProgress* IPrintCmdData::GetProgressData () const
pure virtual

Get method for print progress callback

Returns
IPrintProgress pointer to use
virtual UIDRef IPrintCmdData::GetPrtStyleUIDRef () const
pure virtual

Get method for Printer Sytle UIDRef (if used)

Returns
UIDRef of the printer style to use
virtual ITrapStyleListMgr* IPrintCmdData::GetTrapListMgr () const
pure virtual

Get method for ITrapStyleListMgr object pointer

Returns
ITrapStyleListMgr pointer to use
See Also
ITrapStyleListMgr
virtual void IPrintCmdData::SetFlags (const uint32 flags)
pure virtual

Set method for the print flags

Parameters
flagsIN flags regarding the current state
virtual void IPrintCmdData::SetIDoc (IDocumentiDoc)
pure virtual

Set method for IDocument

Parameters
iDocIN pointer to IDocument being printed
See Also
IDocument
virtual void IPrintCmdData::SetInkList (IInkListiInkList)
pure virtual

Set method for ink list to use

Parameters
iInkListIN pointer the IInkList to use
See Also
IInkList
virtual void IPrintCmdData::SetNumberOfExportedPages (uint32 numPages)
pure virtual

Set method for number of pages exported in PDF passthrough mode

Parameters
INnumber of pages exported
Returns
void
virtual void IPrintCmdData::SetPrintData (IPrintDataiPrintData)
pure virtual

Set method for print data object

Parameters
iPrintDataIN pointer to IPrintData to use - contains all the print settings
See Also
IPrintData
virtual void IPrintCmdData::SetPrintJobData (IPrintJobDataiPrintData)
pure virtual

Set method for the print job data to use

Parameters
iPrintJobDataIN pointer to the IPrintJobData information that was collected in the gathering process
See Also
IPrintJobData
virtual void IPrintCmdData::SetPrintUIOptions (const PrintUIOptions uiOptions)
pure virtual

Set method for the print UI options

Parameters
uiOptionsIN the UI options to use
virtual void IPrintCmdData::SetProgressData (IPrintProgresspProcData)
pure virtual

Set method for print progress data

Parameters
pProcDataIN pointer to IPrintProgress, the print progress callback class
virtual void IPrintCmdData::SetPrtStyleUIDRef (const UIDRef prtStyleUIDRef)
pure virtual

Set method for Printer Sytle UIDRef (if used)

Parameters
prtStyleUIDRefIN UIDRef of the printer style to use, if desired
virtual void IPrintCmdData::SetTrapListMgr (ITrapStyleListMgriTrapListMgr)
pure virtual

Set method for ITrapStyleListMgr to use

Parameters
iTrapListMgrIN pointer to ITrapStyleListMgr to use
See Also
ITrapStyleListMgr