IExportValidationCmdData Class Reference

#include <IExportValidationCmdData.h>

Inheritance diagram for IExportValidationCmdData:

Public Types
enum	{ kDefaultIID = IID_IEXPORTVALIDATIONCMDDATA }
enum	ValidationFlags {   kVerifyNone = 0x00000000, kVerifyLinks = 0x00000001, kVerifyFonts = 0x00000002, kVerifyNoDCSPlates = 0x00000004,   kVerifyOnlyCMYKColor = 0x00000008, kVerifyHasNonBlankPages = 0x00000010, kVerifyLanguageLevel = 0x00000020, kVerifyLanguageLevelMaybe = 0x00000040,   kVerifyBinaryData = 0x00000080, kVerifyBinaryDataMaybe = 0x00000100, kVerifyMultiMediaTransforms = 0x00000200, kVerifyMultiMediaClipping = 0x00000400,   kVerifyMoviePDFCompat = 0x00000800, kVerifyMoviePosterColorCompat = 0x00001000, kVerifyMovieEmbedCompat = 0x00002000, kVerifySoundEmbedCompat = 0x00004000,   kVerifyEPSInks = 0x00008000, kVerifyAtmospherePDFCompat = 0x00010000, kVerifyBlendingSpace = 0x00020000, kVerifyOversetText = 0x00040000,   kVerifyConditionTags = 0x00080000, kVerifyFlashExport = 0x00100000, kVerifyXRefsStatus = 0x00200000, kVerifyPDFButtonActions = 0x00400000,   kVerifyLegacyMedia = 0x00800000, kVerifyControllerSkins = 0x01000000, kVerifyLinksContentAvailable = 0x02000000, kVerifyAll = 0xFFFFFFFF }

Public Member Functions
virtual void	SetValidateFlags (int32 nValidateFlags)=0
virtual bool16	ShouldValidate (int32 nFlag)=0
virtual void	SetShowWarnings (int32 nFlags)=0
virtual bool16	ShowWarning (int32 nFlag)=0
virtual void	SetValidationFailure (int32 nFlag)=0
virtual bool16	GetValidationFailure (int32 nFlag)=0
virtual void	SetCanceled (int32 nFlag)=0
virtual bool16	GetCancelled (int32 nFlag)=0
virtual void	SetBleedSize (const PMRect &rectSize)=0
virtual PMRect &	GetBleedSize ()=0
virtual void	SetSpreadsEnabled (bool16 bSpreads)=0
virtual bool16	SpreadsEnabled ()=0
virtual void	SetOutputPages (IOutputPages *pOutputPages)=0
virtual IOutputPages *	GetOutputPages ()=0
virtual void	SetIterationFlags (int32 nFlags)=0
virtual int32	GetIterationFlags ()=0
virtual void	SetOmitBitmaps (bool16 b)=0
virtual bool16	GetOmitBitmaps ()=0
virtual void	SetOmitEPS (bool16 b)=0
virtual bool16	GetOmitEPS ()=0
virtual void	SetOmitPDF (bool16 b)=0
virtual bool16	GetOmitPDF ()=0
virtual void	SetFontDownload (int32 nFontDownload)=0
virtual int32	GetFontDownload ()=0
virtual void	SetIsINDDPage (bool16 b)=0
virtual bool16	GetIsINDDPage () const =0
virtual void	SetIsBook (bool16 b)=0
virtual bool16	GetIsBook ()=0
virtual void	SetHasGuidesOrGrids (bool16 b)=0
virtual bool16	GetHasGuidesOrGrids ()=0
virtual void	OverrideErrorMessage (int32 nValidateFlags, const PMString &strMsg)=0
virtual void	GetErrorMessage (int32 nValidateFlags, PMString &strMsg)=0
virtual void	SetContext (IDocIterationProvider::IterationContext nContext)=0
virtual IDocIterationProvider::IterationContext	GetContext ()=0
virtual void	SetContextSpecificData (IPMUnknown *pData)=0
virtual IPMUnknown *	GetContextSpecificData ()=0
virtual void	SetContextSpecificData2 (IPMUnknown *pData)=0
virtual IPMUnknown *	GetContextSpecificData2 ()=0
virtual void	SetResult (IDocIterationResult *pData)=0
virtual IDocIterationResult *	GetResult ()=0
virtual void	SetInGalleyView (bool16 nFlag)=0
virtual bool16	GetInGalleyView ()=0
virtual void	SetSupportsTransparency (bool16 bSupported)=0
virtual bool16	GetSupportsTransparency ()=0
virtual void	SetPDFCompatibilityLevel (int32 pdfVersion)=0
virtual int32	GetPDFCompatibilityLevel ()=0
virtual void	SetMediaEmbedOption (int32 mediaEmbedOption)=0
virtual int32	GetMediaEmbedOption ()=0
virtual void	SetPDFOutputColorSpace (int32 colorSpace)=0
virtual int32	GetPDFOutputColorSpace ()=0
virtual void	SetUseDocumentBleed (bool16 bUseDocBleed)=0
virtual bool16	GetUseDocumentBleed ()=0
virtual void	SetIncludeSlugArea (bool16 bIncludeSlugArea)=0
virtual bool16	GetIncludeSlugArea ()=0
virtual void	SetCollectLinks (bool32 collectLinks)=0
virtual bool32	GetCollectLinks () 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

Data interface to the export validation command.

Member Enumeration Documentation

enum IExportValidationCmdData::ValidationFlags

Flags used to indicate what types of verification should be performed.

Enumerator
kVerifyNone	Don't do any verification.
kVerifyLinks	Verify that all of the links in the document are up to date.
kVerifyFonts	Verify that all of the fonts used in the document are present.
kVerifyNoDCSPlates	Verify that there are no DCS pageitems.
kVerifyOnlyCMYKColor	Verify that only CMYK color is used in the document.
kVerifyHasNonBlankPages	Verify that there are no blank pages in the document.
kVerifyLanguageLevel	Verify that there are no pageitems with an invalid PostScript language level.
kVerifyLanguageLevelMaybe	Verify that there are no pageitems with an apparently invalid PostScript language level (obsolete)
kVerifyBinaryData	Verify that there are no pageitems using binary PostScript data.
kVerifyBinaryDataMaybe	Verify that there are no pageitems that might be using binary PostScript data.
kVerifyMultiMediaTransforms	Verify that there are no multimedia pageitems using invalid coordinate transformations.
kVerifyMultiMediaClipping	Verify that there are no multimedia pageitems with invalid clipping paths.
kVerifyMoviePDFCompat	Verify that there are no multimedia pageitems that cannot be supported in the selected PDF language level.
kVerifyMoviePosterColorCompat	Verify that there are no movie pageitems whose colorspaces cannot be represented with current PDF color settings.
kVerifyMovieEmbedCompat	Verify that there are no movie pageitems whose embed settings are unsupported in the selected PDF language level.
kVerifySoundEmbedCompat	Verify that there are no sound pageitems whose embed settings are unsupported in the selected PDF language level.
kVerifyEPSInks	Verify that the inks used in placed EPS files are valid.
kVerifyAtmospherePDFCompat	Verify that there are no Atmosphere pageitems that cannot be supported in the selected PDF language level.
kVerifyBlendingSpace	Verify that there are no problems with the blending colorspace.
kVerifyOversetText	Verify that there is no overset text.
kVerifyConditionTags	Verify that condition tags that are used have consistent visibilities.
kVerifyFlashExport	Verify special conditions related to SWF and XFL export.
kVerifyXRefsStatus	Verify xrefs' status is okay.
kVerifyPDFButtonActions	Check for unsupported button actions when exporting to PDF.
kVerifyLegacyMedia	Check for legacy media.
kVerifyControllerSkins	Check for missing controller skins.
kVerifyLinksContentAvailable	Verify that all of the links in the document, have their content ready.
kVerifyAll	Perform all of the available verifications.

Member Function Documentation

virtual PMRect& IExportValidationCmdData::GetBleedSize ( )

pure virtual

Gets the bleed size to be used during validation.

Returns

The bleed size to use

virtual bool16 IExportValidationCmdData::GetCancelled ( int32  nFlag )

pure virtual

Gets whether the specified validation failure should cause further verification to be canceled.

Parameters

nFlag

IN One of the validation options from the ValidationFlags enumeration

Returns

kTrue if further validation should be canceled

virtual bool32 IExportValidationCmdData::GetCollectLinks ( ) const

pure virtual

Gets whether or not to collect page items with links.

Returns

kTrue if collecting page items with links, kFalse otherwise.

virtual IDocIterationProvider::IterationContext IExportValidationCmdData::GetContext ( )

pure virtual

Gets the document iteration context for the validation.

Returns

The context to use for the validation

virtual IPMUnknown* IExportValidationCmdData::GetContextSpecificData ( )

pure virtual

Gets the context specific data to use for the validation.

Returns

The context specific data to use for the validation

virtual IPMUnknown* IExportValidationCmdData::GetContextSpecificData2 ( )

pure virtual

Gets additional context specific data to use for the validation.

Returns

The context specific data to use for the validation

virtual void IExportValidationCmdData::GetErrorMessage ( int32  nValidateFlags, PMString &  strMsg  )

pure virtual

Gets the error message for the specified validation type.

Parameters

nValidateFlags	IN The validation type requested
strMsg	OUT The error message for the validation type

virtual int32 IExportValidationCmdData::GetFontDownload ( )

pure virtual

Gets the selector for font download while printing.

Returns

The selector for font download while printing

See Also

IPrintData

virtual bool16 IExportValidationCmdData::GetHasGuidesOrGrids ( )

pure virtual

Gets whether have guides or grids.

Returns

kTrue if have guides or grids, else kFalse

virtual bool16 IExportValidationCmdData::GetIncludeSlugArea ( )

pure virtual

Gets whether to include slug area.

Returns

kTrue if should include slug area

virtual bool16 IExportValidationCmdData::GetInGalleyView ( )

pure virtual

Gets whether iteration is for InCopy galley view.

Returns

kTrue if iteration is for InCopy galley view, else kFalse

virtual bool16 IExportValidationCmdData::GetIsBook ( )

pure virtual

Gets whether output is for a book.

Returns

kTrue if output is for a book, else kFalse

virtual bool16 IExportValidationCmdData::GetIsINDDPage ( ) const

pure virtual

Gets whether output is for a placed INDD page.

Returns

kTrue if output is for a placed INDD page, else kFalse

virtual int32 IExportValidationCmdData::GetIterationFlags ( )

pure virtual

Gets the drawing flags to be used while iterating through drawable pageitems.

Returns

The drawing flags to use while iterating

See Also

IShape

virtual int32 IExportValidationCmdData::GetMediaEmbedOption ( )

pure virtual

Gets the Embed Media option (PDF only).

Returns

The Embed Media option

See Also

IPDFExportPrefs::GetContentToEmbed

virtual bool16 IExportValidationCmdData::GetOmitBitmaps ( )

pure virtual

Gets whether raster images are being omitted for output.

Returns

kTrue if raster images are being omitted, else kFalse

virtual bool16 IExportValidationCmdData::GetOmitEPS ( )

pure virtual

Gets whether placed EPS files are being omitted for output.

Returns

kTrue if placed EPS files are being omitted, else kFalse

virtual bool16 IExportValidationCmdData::GetOmitPDF ( )

pure virtual

Gets whether placed PDF files are being omitted for output.

Returns

kTrue if placed PDF files are being omitted, else kFalse

virtual IOutputPages* IExportValidationCmdData::GetOutputPages ( )

pure virtual

Gets the output pages to use during validation. The returned pointer is unowned and must not be released by the caller.

Returns

The output pages to use for validation

virtual int32 IExportValidationCmdData::GetPDFCompatibilityLevel ( )

pure virtual

Gets the PDF compatibility level.

Returns

The PDF compatibility level

See Also

IPDFExportPrefs::GetPDFExAcrobatCompatibilityLevel

virtual int32 IExportValidationCmdData::GetPDFOutputColorSpace ( )

pure virtual

Gets the PDF export output colorspace.

Returns

The PDF export colorspace

See Also

IPDFExportPrefs::GetPDFExColorSpace

virtual IDocIterationResult* IExportValidationCmdData::GetResult ( )

pure virtual

Gets the results of the iteration. The returned interface is owned by this object and must not be released by the caller.

Returns

The results of the iteration

virtual bool16 IExportValidationCmdData::GetSupportsTransparency ( )

pure virtual

Gets whether transparency is supported in the output scenario.

Returns

kTrue if transparency is supported in the output scenario

virtual bool16 IExportValidationCmdData::GetUseDocumentBleed ( )

pure virtual

Gets whether to use document bleed.

Returns

kTrue if should use document bleed

virtual bool16 IExportValidationCmdData::GetValidationFailure ( int32  nFlag )

pure virtual

Determines whether the specified type failed validation.

Parameters

nFlag

IN One of the validation options from the ValidationFlags enumeration

Returns

kTrue if the specified failure occurred, else kFalse

virtual void IExportValidationCmdData::OverrideErrorMessage ( int32  nValidateFlags, const PMString &  strMsg  )

pure virtual

Overrides error message for the specified validation type.

Parameters

nValidateFlags	IN The validation type to override
strMsg	IN The new error message for the validation type

virtual void IExportValidationCmdData::SetBleedSize ( const PMRect &  rectSize )

pure virtual

Sets the bleed size to be used during validation.

Parameters

rectSize

IN The bleed size to use

virtual void IExportValidationCmdData::SetCanceled ( int32  nFlag )

pure virtual

Sets whether the specified validation failure should cause further verification to be canceled.

Parameters

nFlag

IN One of the validation options from the ValidationFlags enumeration

virtual void IExportValidationCmdData::SetCollectLinks ( bool32  collectLinks )

pure virtual

Sets whether or not to collect page items with links.

Parameters

collectLinks

[IN]: kTrue to collect page items with links, kFalse otherwise.

virtual void IExportValidationCmdData::SetContext ( IDocIterationProvider::IterationContext  nContext )

pure virtual

Sets the document iteration context for the validation.

Parameters

nContext

IN The context to use for the validation

virtual void IExportValidationCmdData::SetContextSpecificData ( IPMUnknown *  pData )

pure virtual

Sets the context specific data to use for the validation.

NOTE: pData is not owned by this interface and must remain valid for the duration of the validation pass.

Parameters

pData

IN Context specific data to use for the validation

virtual void IExportValidationCmdData::SetContextSpecificData2 ( IPMUnknown *  pData )

pure virtual

Sets additional context specific data to use for the validation.

NOTE: pData is not owned by this interface and must remain valid for the duration of the validation pass.

Parameters

pData

IN Context specific data to use for the validation

virtual void IExportValidationCmdData::SetFontDownload ( int32  nFontDownload )

pure virtual

Sets the selector for font download while printing.

Parameters

nFontDownload

IN The selector for font download while printing

See Also

IPrintData

virtual void IExportValidationCmdData::SetHasGuidesOrGrids ( bool16  b )

pure virtual

Sets whether have guides or grids.

Parameters

b	IN kTrue if have guides or grids, else kFalse

virtual void IExportValidationCmdData::SetIncludeSlugArea ( bool16  bIncludeSlugArea )

pure virtual

Sets whether to include slug area.

Parameters

bIncludeSlugArea

IN kTrue if should include slug area

virtual void IExportValidationCmdData::SetInGalleyView ( bool16  nFlag )

pure virtual

Sets whether iteration is for InCopy galley view.

Parameters

nFlag

IN kTrue if iteration is for InCopy galley view

virtual void IExportValidationCmdData::SetIsBook ( bool16  b )

pure virtual

Sets whether output is for a book.

Parameters

b	IN kTrue if output is for a book, else kFalse

virtual void IExportValidationCmdData::SetIsINDDPage ( bool16  b )

pure virtual

Sets whether the output is for a placed INDD page.

Parameters

b	IN kTrue if output is for a palced INDD page, else kFalse

virtual void IExportValidationCmdData::SetIterationFlags ( int32  nFlags )

pure virtual

Sets the drawing flags to be used while iterating through drawable pageitems. The values to be used are taken from IShape's drawing flags.

Parameters

nFlags

IN The drawing flags to use while iterating

See Also

IShape

virtual void IExportValidationCmdData::SetMediaEmbedOption ( int32  mediaEmbedOption )

pure virtual

Sets the Embed Media option (PDF only).

Parameters

mediaEmbedOption

IN The Embed Media option

See Also

IPDFExportPrefs::GetContentToEmbed

virtual void IExportValidationCmdData::SetOmitBitmaps ( bool16  b )

pure virtual

Sets whether raster images are being omitted for output.

Parameters

b	IN kTrue if raster images are being omitted, else kFalse

virtual void IExportValidationCmdData::SetOmitEPS ( bool16  b )

pure virtual

Sets whether placed EPS files are being omitted for output.

Parameters

b	IN kTrue if placed EPS files are being omitted, else kFalse

virtual void IExportValidationCmdData::SetOmitPDF ( bool16  b )

pure virtual

Sets whether placed PDF files are being omitted for output.

Parameters

b	IN kTrue if placed PDF files are being omitted, else kFalse

virtual void IExportValidationCmdData::SetOutputPages ( IOutputPages *  pOutputPages )

pure virtual

Sets the output pages to use during validation. Implicitly calls AddRef on the output pages object.

Parameters

pOutputPages

IN The output pages to be used for validation

virtual void IExportValidationCmdData::SetPDFCompatibilityLevel ( int32  pdfVersion )

pure virtual

Sets the PDF compatibility level.

Parameters

pdfVersion

IN The PDF compatibility level

See Also

IPDFExportPrefs::GetPDFExAcrobatCompatibilityLevel

virtual void IExportValidationCmdData::SetPDFOutputColorSpace ( int32  colorSpace )

pure virtual

Sets the PDF export output colorspace.

Parameters

colorSpace

IN The PDF export colorspace

See Also

IPDFExportPrefs::GetPDFExColorSpace

virtual void IExportValidationCmdData::SetResult ( IDocIterationResult *  pData )

pure virtual

Sets the results of the iteration. Implicitly AddRef's the data.

Parameters

pData

IN The iteration results

virtual void IExportValidationCmdData::SetShowWarnings ( int32  nFlags )

pure virtual

Sets whether warnings should be shown for the specified validation failures.

Parameters

nFlags

IN A bitmap of validation options from the ValidationFlags enumeration

virtual void IExportValidationCmdData::SetSpreadsEnabled ( bool16  bSpreads )

pure virtual

Sets whether spreads are enabled.

Parameters

bSpreads

IN The new enabled value

virtual void IExportValidationCmdData::SetSupportsTransparency ( bool16  bSupported )

pure virtual

Sets whether transparency is supported in the output scenario.

Parameters

bSupported

IN kTrue if transparency is supported in the output scenario

virtual void IExportValidationCmdData::SetUseDocumentBleed ( bool16  bUseDocBleed )

pure virtual

Sets whether to use document bleed.

Parameters

bUseDocBleed

IN kTrue if should use document bleed

virtual void IExportValidationCmdData::SetValidateFlags ( int32  nValidateFlags )

pure virtual

Sets the flags used to determine what validation should be performed.

Parameters

nValidateFlags

IN A bitmap of validation options from the ValidationFlags enumeration

virtual void IExportValidationCmdData::SetValidationFailure ( int32  nFlag )

pure virtual

Indicates that the specified validation type failed.

Parameters

nFlag

IN One of the validation options from the ValidationFlags enumeration

virtual bool16 IExportValidationCmdData::ShouldValidate ( int32  nFlag )

pure virtual

Determines if the specified validation should be performed based on the current validation flags.

Returns

kTrue if the validation should be performed, else kFalse

virtual bool16 IExportValidationCmdData::ShowWarning ( int32  nFlag )

pure virtual

Determines if a warning should be shown for the specified validation flag.

Returns

kTrue if a warning should be shown the specified validation flag

virtual bool16 IExportValidationCmdData::SpreadsEnabled ( )

pure virtual

Gets whether spreads are enabled.

Returns

kTrue if spreads are enabled, else kFalse