#include <IPrintJobData.h>

Inheritance diagram for IPrintJobData:

Public Types
enum	{ kDefaultIID = IID_IPRINTJOBDATA }

Public Member Functions
virtual IInkList *	GetInkList (void) const =0

virtual void	SetInkList (IInkList *iInkList)=0

virtual void	InkRsrcInsert (int32 index, IInkResourceData *iInkRsrcData)=0

virtual void	InkRsrcRemove (int32 index)=0

virtual void	InkRsrcClear (void)=0

virtual int32	InkRsrcLength (void)=0

virtual IInkResourceData *	GetNthInkRsrcData (int32 index) const =0

virtual bool16	GetGradientUsed () const =0

virtual void	SetGradientUsed (const bool16 bGradientUsed)=0

virtual bool16	GetImagesUsed () const =0

virtual void	SetImagesUsed (const bool16 bImagesUsed)=0

virtual bool16	GetTransparencyUsedInJob () const =0

virtual bool16	GetTransparencyUsed (const int32 whichPage) const =0

virtual void	SetTransparencyInfo (const K2Vector< int32 > &xpPages)=0

virtual int32	NumberOfPagesWithTransparency () const =0

virtual void	AppendGraphicSuppliedFontName (const PMString &fontName)=0

virtual int32	NumGraphicSuppliedFonts () const =0

virtual void	GetNthGraphicSuppliedFontName (int32 n, PMString &fontName) const =0

virtual bool16	GetSVGFontsUsed (const int32 whichPage) const =0

virtual void	SetSVGFontsInfo (const K2Vector< int32 > &svgPages)=0

virtual void	AppendFontInfo (const Font_Info *fontInfo)=0

virtual int32	NumFontInfo () const =0

virtual Font_Info *	GetNthFontInfo (int32 n) const =0

virtual int32	NumMissingFonts () const =0

virtual void	GetNthMissingFontName (const int32 n, PMString &fontName) const =0

virtual void	AppendMissingFontName (const PMString &fontName)=0

virtual void	TZPathsInsert (int32 index, K2Vector< TrapZoneInfo * > pathList)=0

virtual void	TZPathsRemove (int32 index)=0

virtual void	TZPathsClear (void)=0

virtual int32	TZPathsLength (void)=0

virtual K2Vector< TrapZoneInfo * >	GetNthTZPathsList (int32 index) const =0

virtual bool16	GetGradientMeshUsed () const =0

virtual void	SetGradientMeshUsed (const bool16 bGradientMeshUsed)=0

virtual void	AddPageLabelString (int32 pageIndex, const PMString &pageLabelStr)=0

virtual void	RemovePageLabelString (int32 pageIndex)=0

virtual void	ClearPageLabelStrings (void)=0

virtual PMString	GetPageLabelString (int32 pageIndex) const =0

virtual void	AppendLinks (const UIDList &links)=0

virtual const UIDList &	GetLinks (void) const =0

virtual void	PageGapsListInsertPage (int32 page, K2Vector< PMRect > vecPageGapsList)=0

virtual void	PageGapsListRemovePage (int32 page)=0

virtual void	PageGapsListClear (void)=0

virtual K2Vector< PMRect >	GetPageGapsListForPage (int32 page) const =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 Job Data that is collected in a gathering process is stored here to be passed to and shared with various print commands. This data is gathered in the PrintGatherDataCmd.

Member Function Documentation

virtual void IPrintJobData::AddPageLabelString	(	int32	pageIndex,
		const PMString &	pageLabelStr
	)

pure virtual

for a given page (the pageIndex), provide an optional page label string to be used. The page label appears in the page information printer marks, as well as the DSC comments.

Parameters

pageIndex	IN the page that you wish to override the page label. Note that the pageIndex has to be the same as the index into IOutputPages.
pageLabelStr	IN PMString containing alternate page label

virtual void IPrintJobData::AppendFontInfo ( const Font_Info * fontInfo )

pure virtual

append font information into the list

Parameters

fontInfo IN a reference to a Font_Info class describing a font that is used in the job

virtual void IPrintJobData::AppendGraphicSuppliedFontName ( const PMString & fontName )

pure virtual

Sometimes we care about the fonts that are supplied by the graphics within the document. For example, when placing a page from an imported INDD document, we may want to obtain a list of all the fonts in the document, including those within any vector graphics within said document. These fonts can then be stored in the IFontNames interface for the placed object.

Parameters

fontName [IN] the name of the graphic font.

virtual void IPrintJobData::AppendLinks ( const UIDList & links )

pure virtual

Append a list of page items with 1 or more data links.

Parameters

links [IN]: A list of page items with links to append to the list encountered so far.

virtual void IPrintJobData::AppendMissingFontName ( const PMString & fontName )

pure virtual

Add the name of a missing font.

Parameters

fontName[IN],: Name of the missing font.

virtual void IPrintJobData::ClearPageLabelStrings ( void )

pure virtual

clear all PMStrings from the list of optional page label strings

virtual bool16 IPrintJobData::GetGradientMeshUsed ( ) const

pure virtual

get whether a gradient mesh is used in the pub - print code will not download the gradient mesh procset if this is false

Returns: kTrue if gradient mesh is used in the job, kFalse otherwise

virtual bool16 IPrintJobData::GetGradientUsed ( ) const

pure virtual

get whether a gradient paint server is used in the pub - print code will not download the gradient paint server procset if this is false see below for information about flagging gradient meshes

Returns: kTrue if gradient paint server is used, kFalse otherwise

virtual bool16 IPrintJobData::GetImagesUsed ( ) const

pure virtual

get whether an image is used in the pub - print code will not download the image procset if this is false

Returns: kTrue if an image is used in the job, kFalse otherwise

virtual IInkList* IPrintJobData::GetInkList ( void ) const

pure virtual

get the ink list used in the print job

Returns: pointer to IInkList used in the print job

See Also: IInkList

virtual const UIDList& IPrintJobData::GetLinks ( void ) const

pure virtual

Get the list of page items with links used in this print job. Note that you will need to query for the IDataLinkReference and/or IDataLinkListReference on each element in the list to obtain the actual links.

Returns: UIDList of links.

virtual Font_Info* IPrintJobData::GetNthFontInfo ( int32 n ) const

pure virtual

get the Nth Font_Info class from the list

Parameters

n	IN the index to get

Returns: Font_Info class of the given index

virtual void IPrintJobData::GetNthGraphicSuppliedFontName	(	int32	n,
		PMString &	fontName
	)		const

pure virtual

Sometimes we care about the fonts that are supplied by the graphics within the document. For example, when placing a page from an imported INDD document, we may want to obtain a list of all the fonts in the document, including those within any vector graphics within said document. These fonts can then be stored in the IFontNames interface for the placed object.

Parameters

n	[IN]: zero-based index of font to get
fontName	[OUT]: on return, will hold the name of the Nth graphic font.

virtual IInkResourceData* IPrintJobData::GetNthInkRsrcData ( int32 index ) const

pure virtual

get the Nth IInkResourceData pointer out of the list.

Parameters

index IN the index to retrieve

Returns: a pointer to the given IInkResourceData, or nil if one does not exist for the given index

See Also: IInkResourceData

virtual void IPrintJobData::GetNthMissingFontName	(	const int32	n,
		PMString &	fontName
	)		const

pure virtual

Get the name of the Nth missing font.

Parameters

n	[IN]: zero-based index of font to get
fontName	[OUT]: on return, will hold the name of the Nth missing font.

virtual K2Vector<TrapZoneInfo*> IPrintJobData::GetNthTZPathsList ( int32 index ) const

pure virtual

get the Nth trap zone information

Parameters

index IN which page to retrieve

Returns: a K2Vector of TrapZoneInfo pointers containing the trap zone information for that page

virtual K2Vector<PMRect> IPrintJobData::GetPageGapsListForPage ( int32 page ) const

pure virtual

get the page gaps information for a particular page.

Parameters

page	IN which page to retrieve

Returns: a K2Vector of PMRects containing the page gaps information for that page

virtual PMString IPrintJobData::GetPageLabelString ( int32 pageIndex ) const

pure virtual

get the PMString to use as a page label string for the pageIndex page. If the string is not present for a particular page, an empty string will be returned. If an empty string is returned, the page label will be generated in the default manner.

Parameters

pageIndex IN the index (page) to retrieve. Note that the pageIndex has to be the same as the index into IOutputPages.

Returns: a PMString containing the optional page label; returned string will be empty if one does not exist for the given pageIndex. If empty, the page label will be generated in the default manner.

virtual bool16 IPrintJobData::GetSVGFontsUsed ( const int32 whichPage ) const

pure virtual

get whether SVG Fonts is used on a particular page

Parameters

whichPage IN which page to check

Returns: kTrue if SVG fonts used on that page, kFalse otherwise

virtual bool16 IPrintJobData::GetTransparencyUsed ( const int32 whichPage ) const

pure virtual

get whether transparency is used on a particular page

Parameters

whichPage IN which page to check

Returns: kTrue if XP used on that page, kFalse otherwise

virtual bool16 IPrintJobData::GetTransparencyUsedInJob ( ) const

pure virtual

get whether transparency is used in the pub

Returns: kTrue if XP used in job, kFalse otherwise

virtual void IPrintJobData::InkRsrcClear ( void )

pure virtual

clear all IInkResourceData pointers from the list

virtual void IPrintJobData::InkRsrcInsert	(	int32	index,
		IInkResourceData *	iInkRsrcData
	)

pure virtual

insert an IInkResourceData into the list for a given page (the index)

Parameters

index	IN the page that the inks were gathered from. Note that the index has to be the same as the index into IOutputPages.
iInkRsrcData	IN pointer to IInkResourceData containing the inks that are used on the page.

See Also: IInkResourceData

virtual int32 IPrintJobData::InkRsrcLength ( void )

pure virtual

get the number of IInkResourceData pointers stored in the list

virtual void IPrintJobData::InkRsrcRemove ( int32 index )

pure virtual

remove an IInkResourceData from the list for a given page (the index)

Parameters

index IN the index to remove from the list

virtual int32 IPrintJobData::NumberOfPagesWithTransparency ( ) const

pure virtual

get the number of pages that have transparency in the job

Returns: number of page that have XP in the job

virtual int32 IPrintJobData::NumFontInfo ( ) const

pure virtual

get the number of Font_Info stored in the list

Returns: number of fonts in the list

virtual int32 IPrintJobData::NumGraphicSuppliedFonts ( ) const

pure virtual

Sometimes we care about the fonts that are supplied by the graphics within the document. For example, when placing a page from an imported INDD document, we may want to obtain a list of all the fonts in the document, including those within any vector graphics within said document. These fonts can then be stored in the IFontNames interface for the placed object.

Returns: number of fonts supplied by graphics.

virtual int32 IPrintJobData::NumMissingFonts ( ) const

pure virtual

Get the number of missing fonts. These fonts are NOT included in the NumFontInfo() count.

Returns: number of missing fonts.

virtual void IPrintJobData::PageGapsListClear ( void )

pure virtual

remove all page gap information from the list

virtual void IPrintJobData::PageGapsListInsertPage	(	int32	page,
		K2Vector< PMRect >	vecPageGapsList
	)

pure virtual

insert information about page gaps for a page into the list. This is used for positioning vertical gutter marks if crop marks is on, to be used with page imposition. The PMRect should have coordinates for the size of the gap between the imposed pages, in the same coordinate space as the IOutputPages being used.

Parameters

page	IN the page that the gaps refer to
pathList	IN a K2Vector of PMRects containing the gap sizes for the page, in the same coordinate space as IOutputPages page size.

virtual void IPrintJobData::PageGapsListRemovePage ( int32 page )

pure virtual

remove the gaps list information for a page from the list

Parameters

page	IN the page which to remove

virtual void IPrintJobData::RemovePageLabelString ( int32 pageIndex )

pure virtual

remove a PMString from the optional page label list for a given page (the pageIndex)

Parameters

pageIndex IN the index (page) to remove from the list

virtual void IPrintJobData::SetGradientMeshUsed ( const bool16 bGradientMeshUsed )

pure virtual

set whether a gradient mesh is used in the pub - print code will not download the gradient mesh procset if this is false

Parameters

bGradientMeshUsed IN kTrue if gradient mesh is used in the job, kFalse otherwise

virtual void IPrintJobData::SetGradientUsed ( const bool16 bGradientUsed )

pure virtual

set whether a gradient paint server is used in the pub - print code will not download the gradient paint server procset if this is false see below for information about flagging gradient meshes

Parameters

bGradientUsed IN kTrue if gradient paint server is used, kFalse otherwise

virtual void IPrintJobData::SetImagesUsed ( const bool16 bImagesUsed )

pure virtual

set whether an image is used in the pub - print code will not download the image procset if this is false

Parameters

bImagesUsed IN kTrue if an image is used in the job, kFalse otherwise

virtual void IPrintJobData::SetInkList ( IInkList * iInkList )

pure virtual

set the ink list used in the print job

Parameters

iInkList IN pointer to IInkList used in the print job

See Also: IInkList

virtual void IPrintJobData::SetSVGFontsInfo ( const K2Vector< int32 > & svgPages )

pure virtual

set whether SVG Fonts is used in the pub

Parameters

xpPages IN a K2Vector which SVG fonts info for each page in the job

virtual void IPrintJobData::SetTransparencyInfo ( const K2Vector< int32 > & xpPages )

pure virtual

set whether transparency is used in the pub

Parameters

xpPages IN a K2Vector which XP info for each page in the job

virtual void IPrintJobData::TZPathsClear ( void )

pure virtual

remove all trap zone information from the list

virtual void IPrintJobData::TZPathsInsert	(	int32	index,
		K2Vector< TrapZoneInfo * >	pathList
	)

pure virtual

insert information about trap zones for a page into the list

Parameters

index	IN the page that the trap zones apply
pathList	IN a K2Vector of TrapZoneInfo pointers containing the trap zones for the page

virtual int32 IPrintJobData::TZPathsLength ( void )

pure virtual

get the number of trap zone pages in the list

Returns: number of trap zone pages in list

virtual void IPrintJobData::TZPathsRemove ( int32 index )

pure virtual

remove the trap zone information for a page from the list

Parameters

index IN the page which to remove

Public Types

Public Member Functions

Detailed Description

Member Function Documentation