#include <IPDFExportPrefs.h>

Inheritance diagram for IPDFExportPrefs:

Public Types
enum	{ kDefaultIID = IID_IPDFEXPORTPREFS }

enum	{ kDontChange = -1, kExportLaunchAcrobatON = 1, kExportLaunchAcrobatOFF, kExportReaderSpreadsON = 1, kExportReaderSpreadsOFF, kExportThumbnailsON = 1, kExportThumbnailsOFF, kExportLinearizedON = 1, kExportLinearizedOFF, kExportEmbedFontsON = 1, kExportEmbedFontsOFF, kExportSubsetFontsON = 1, kExportSubsetFontsOFF, kExportPDFColorSpaceRGB = 1, kExportPDFColorSpaceCMYK, kExportPDFColorSpaceDIC, kExportPDFColorSpacePassthru, kExportPDFRepurposeColorSpaceRGB, kExportPDFRepurposeColorSpaceCMYK, kExportPDFColorSpaceGray, kExportPDFDestProfileNA = 1, kExportPDFDestProfileMonitor, kExportPDFDestProfileDocument, kExportPDFDestProfileWorking, kExportPDFDestProfileUseName, kExportIncludeICCProfilesON = 1, kExportIncludeICCProfilesOFF, kExportIncludeTaggedSourceProfiles, kExportIncludeRGBAndTaggedCMYKSourceProfiles, kExportOutputOPION = 1, kExportOutputOPIOFF, kExportBMSampleOmit_Inval = 1, kExportBMSampleHiRes, kExportBMSampleLowRes, kExportCompressLineArtAndTextON = 1, kExportCompressLineArtAndTextOFF, kCompressStructure = 1, kCompressObjects, kExportSampleImagesNone = 1, kExportSampleImagesByDownsampling, kExportSampleImagesBySubsampling, kExportSampleImagesByBicubicDownsampling, kExportCompressImagesNone = 1, kExportCompressImagesAutoLZWJPEGHigh = 2, kExportCompressImagesAutoLZWJPEGMedHigh, kExportCompressImagesAutoLZWJPEGMed, kExportCompressImagesAutoLZWJPEGMedLow, kExportCompressImagesAutoLZWJPEGLow, kExportCompressImagesManualJPEGHigh, kExportCompressImagesManualJPEGMedHigh, kExportCompressImagesManualJPEGMed, kExportCompressImagesManualJPEGMedLow, kExportCompressImagesManualJPEGLow, kExportCompressImagesManualLZW4Bit, kExportCompressImagesManualLZW8Bit, kExportCompressImagesManualJPEG2000High, kExportCompressImagesManualJPEG2000MedHigh, kExportCompressImagesManualJPEG2000Med, kExportCompressImagesManualJPEG2000MedLow, kExportCompressImagesManualJPEG2000Low, kExportCompressImagesManualJPEG2000Lossless, kExportCompressImagesAutoJPXMaximum, kExportCompressImagesAutoJPXedHigh, kExportCompressImagesAutoJPXMedium, kExportCompressImagesAutoJPXMLow, kExportCompressImagesAutoJPXMinimum, kExportCompressImagesAutoJPXLossless, kExportCompressImagesCCITTGroup4 = (2+65536), kExportCompressImagesCCITTGroup3, kExportCompressImagesZip, kExportCompressImagesRunLength, kExportBleedON = 1, kExportBleedOFF, kExportBleedMarksON = 1, kExportBleedMarksOFF, kExportCropMarksON = 1, kExportCropMarksOFF, kExportRegistrationMarksON = 1, kExportRegistrationMarksOFF, kExportColorBarsON = 1, kExportColorBarsOFF, kExportPageInfoON = 1, kExportPageInfoOFF, kExportErrorControlWarnAndContinue = 1, kExportErrorControlIgnore, kExportErrorControlCancelJob, kExportDisallowImageCropON = 1, kExportDisallowImageCropOFF, kExportOmitPDFON = 1, kExportOmitPDFOFF, kExportOmitEPSON = 1, kExportOmitEPSOFF, kExportOmitBitmapImagesON = 1, kExportOmitBitmapImagesOFF, kExportContentON = 1, kExportContentOFF, kInvalidView = -1, kPerFrameGridView = 0, kGridView = 1, kZNGridView = 2, kAlignmentGridView = 3, kAlways = 0, kWhenEmpty = 1, kExportIncHyperLinksOFF = 0, kExportIncHyperLinksON, kExportAllLayers = 0, kExportVisibleLayers, kExportVisiblePrintableLayers, kExportLegacy = 1, kExportSimulatePress, kExportSimulateScreen, kPDFVersion12 = 12, kPDFVersion13, kPDFVersion14, kPDFVersion15, kPDFVersion16, kPDFVersion17, kExportNoStandardsCompliance = 0, kExportPDFX1a2001, kExportPDFX32002, kExportPDFX1a2003, kExportPDFX32003, kExportPDFA, kExportPDFX42010, kExportCustomOutputCondition = 0, kExportCGATSOutputCondition, kExportNamedOutputCondition, kExportBlankRegistryName = 0, kExportICCRegistryName, kExportCustomRegistryName, kUseObjectSettings = 0, kLinkAll, kEmbedAll, kExportMagnificationDefault = 0, kExportMagnificationActualSize, kExportMagnificationFitPage, kExportMagnificationFitWidth, kExportMagnificationFitHeight, kExportMagnificationFitVisible, kExportMagnification25percent, kExportMagnification50percent, kExportMagnification75percent, kExportMagnification100percent, kExportLayoutDefault = 0, kExportLayoutSinglePage, kExportLayoutSinglePageContinuous, kExportLayoutTwoUpFacing, kExportLayoutTwoUpFacingContinuous, kExportLayoutTwoUpCoverPage, kExportLayoutTwoUpCoverPageContinuous, kExportDisplayFileName = 0, kExportDisplayDocumentTitle }

enum	{ kCompressNone = 0, kCompressAutomatic, kCompressJPEG, kCompressZip, kCompressJPEG2000, kCompressAutomaticJPEG2000 }

enum	{ kQualityNone = -1, kQualityMinimum = 0, kQualityLow, kQualityMedium, kQualityHigh, kQualityMaximum, kQualityLossless }

enum	{ kQuality4Bit = 0, kQuality8Bit }

enum	{ kCompressGroup3 = 1, kCompressGroup4, kCompressMonoZip, kCompressRLE }

enum	{ kResampleNone = 0, kDownsample, kSubsample, kBicubicDownsample }

Public Member Functions
virtual void	CopyPrefs (IPDFExportPrefs const *prefsToCopy)=0

virtual void	SetPDFExLaunchAcrobat (int32 launchAcrobat)=0

virtual void	SetPDFExReaderSpreads (int32 readerSpreads)=0

virtual void	SetPDFExThumbnails (int32 thumbnails)=0

virtual void	SetPDFExLinearized (int32 linearized)=0

virtual void	SetPDFExEmbedFonts (int32 embedFonts)=0

virtual void	SetPDFExSubsetFonts (int32 subsetFonts)=0

virtual void	SetPDFExSubsetFontsThreshold (int32 subsetFontsThreshold)=0

virtual void	SetPDFExColorSpace (int32 colorSpace)=0

virtual void	SetPDFExIncludeICCProfiles (int32 includeICCProfiles)=0

virtual void	SetPDFExOutputOPI (int32 outputOPI)=0

virtual void	SetPDFExBitmapSampling (int32 bitmapSampling)=0

virtual void	SetPDFExCompressLineArtAndText (int32 compressLineArtAndText)=0

virtual void	SetPDFExSampleColorImages (int32 sampleColorImages)=0

virtual void	SetPDFExSampleGrayImages (int32 sampleGrayImages)=0

virtual void	SetPDFExSampleMonoImages (int32 sampleMonoImages)=0

virtual void	SetPDFExSampleColorImagesXRes (int32 colorImagesXRes)=0

virtual void	SetPDFExSampleColorImagesYRes (int32 colorImagesYRes)=0

virtual void	SetPDFExSampleGrayImagesXRes (int32 grayImagesXRes)=0

virtual void	SetPDFExSampleGrayImagesYRes (int32 grayImagesYRes)=0

virtual void	SetPDFExSampleMonoImagesXRes (int32 monoImagesXRes)=0

virtual void	SetPDFExSampleMonoImagesYRes (int32 monoImagesYRes)=0

virtual void	SetPDFExCompressColorImages (int32 compressColorImages)=0

virtual void	SetPDFExCompressGrayImages (int32 compressGrayImages)=0

virtual void	SetPDFExCompressMonoImages (int32 compressMonoImages)=0

virtual void	SetPDFExBleed (int32 bleed)=0

virtual void	SetPDFExBleedMarks (int32 bleedMarks)=0

virtual void	SetPDFExCropMarks (int32 cropMarks)=0

virtual void	SetPDFExRegistrationMarks (int32 registrationMarks)=0

virtual void	SetPDFExColorBars (int32 colorBars)=0

virtual void	SetPDFExPageInfo (int32 pageInfo)=0

virtual void	SetPDFExPrinterMarksOffset (PMReal printerMarksOffset)=0

virtual void	SetPDFExErrorControl (int32 errorControl)=0

virtual void	SetPDFExDisallowImageCrop (int32 disallowImageCrop)=0

virtual void	SetPDFExOmitPDF (int32 omitPDF)=0

virtual void	SetPDFExOmitEPS (int32 omitEPS)=0

virtual void	SetPDFExOmitBitmapImages (int32 omitBitmapImages)=0

virtual void	SetAddStructure (bool16 add)=0

virtual int32	GetPDFExLaunchAcrobat () const =0

virtual int32	GetPDFExReaderSpreads () const =0

virtual int32	GetPDFExThumbnails () const =0

virtual int32	GetPDFExLinearized () const =0

virtual int32	GetPDFExEmbedFonts () const =0

virtual int32	GetPDFExSubsetFonts () const =0

virtual int32	GetPDFExSubsetFontsThreshold () const =0

virtual int32	GetPDFExColorSpace () const =0

virtual int32	GetPDFExIncludeICCProfiles () const =0

virtual int32	GetPDFExOutputOPI () const =0

virtual int32	GetPDFExBitmapSampling () const =0

virtual int32	GetPDFExCompressLineArtAndText () const =0

virtual int32	GetPDFExSampleColorImages () const =0

virtual int32	GetPDFExSampleGrayImages () const =0

virtual int32	GetPDFExSampleMonoImages () const =0

virtual int32	GetPDFExSampleColorImagesXRes () const =0

virtual int32	GetPDFExSampleColorImagesYRes () const =0

virtual int32	GetPDFExSampleGrayImagesXRes () const =0

virtual int32	GetPDFExSampleGrayImagesYRes () const =0

virtual int32	GetPDFExSampleMonoImagesXRes () const =0

virtual int32	GetPDFExSampleMonoImagesYRes () const =0

virtual int32	GetPDFExCompressColorImages () const =0

virtual int32	GetPDFExCompressGrayImages () const =0

virtual int32	GetPDFExCompressMonoImages () const =0

virtual int32	GetPDFExBleed () const =0

virtual int32	GetPDFExBleedMarks () const =0

virtual int32	GetPDFExCropMarks () const =0

virtual int32	GetPDFExRegistrationMarks () const =0

virtual int32	GetPDFExColorBars () const =0

virtual int32	GetPDFExPageInfo () const =0

virtual PMReal	GetPDFExPrinterMarksOffset () const =0

virtual int32	GetPDFExErrorControl () const =0

virtual int32	GetPDFExDisallowImageCrop () const =0

virtual int32	GetPDFExOmitPDF () const =0

virtual int32	GetPDFExOmitEPS () const =0

virtual int32	GetPDFExOmitBitmapImages () const =0

virtual bool16	GetAddStructure () const =0

virtual void	SetPDFExAcrobatCompatibilityLevel (int32 appVersion)=0

virtual int32	GetPDFExAcrobatCompatibilityLevel () const =0

virtual void	SetPDFExResolution (int32 resolution)=0

virtual int32	GetPDFExResolution () const =0

virtual void	SetPDFExDstProfileSelectorAndName (int32 selector, const PMString &name)=0

virtual int32	GetPDFExDstProfileSelector () const =0

virtual PMString	GetPDFExDstProfileName () const =0

virtual PMString	GetEffectiveDstProfileName () const =0

virtual void	SetPDFExIncHyperLinks (int32 incHyperLinks)=0

virtual int32	GetPDFExIncHyperLinks () const =0

virtual void	SetPDFExMarkLineWeight (const PMReal &markLineWeight)=0

virtual PMReal	GetPDFExMarkLineWeightJ () const =0

virtual PMReal	GetPDFExMarkLineWeight () const =0

virtual void	SetPDFExBleedTop (const PMReal &bleedTop)=0

virtual PMReal	GetPDFExBleedTop () const =0

virtual void	SetPDFExBleedInside (const PMReal &bleedInside)=0

virtual PMReal	GetPDFExBleedInside () const =0

virtual void	SetPDFExBleedBottom (const PMReal &bleedBottom)=0

virtual PMReal	GetPDFExBleedBottom () const =0

virtual void	SetPDFExBleedOutside (const PMReal &bleedOutside)=0

virtual PMReal	GetPDFExBleedOutside () const =0

virtual void	SetPDFExSpotOverPrint (int32 spotOverPrint)=0

virtual int32	GetPDFExSpotOverPrint () const =0

virtual UID	GetPDFExFlattenerStyle () const =0

virtual void	SetPDFExFlattenerStyleName (const PMString &strStyle)=0

virtual PMString	GetPDFExFlattenerStyleName () const =0

virtual void	SetPDFExIgnoreFlattenerSpreadOverrides (bool16 ignore)=0

virtual bool16	GetPDFExIgnoreFlattenerSpreadOverrides () const =0

virtual void	SetIncludeBookmarks (bool32 add)=0

virtual bool32	GetIncludeBookmarks () const =0

virtual void	SetNonprintingObjects (bool32 checked)=0

virtual bool32	GetNonprintingObjects () const =0

virtual void	SetVisibleGuidesGrids (bool32 checked)=0

virtual bool32	GetVisibleGuidesGrids () const =0

virtual void	SetPDFExStandardsCompliance (int32 standardLevel)=0

virtual int32	GetPDFExStandardsCompliance (void) const =0

virtual void	SetPDFExOutputConditionName (PMString name)=0

virtual PMString	GetPDFExOutputConditionName () const =0

virtual PMString	GetEffectivePDFXOutputConditionName () const =0

virtual void	SetPDFExOCRegistryName (PMString name)=0

virtual PMString	GetPDFExOCRegistryName () const =0

virtual PMString	GetEffectivePDFXOCRegistryName () const =0

virtual void	SetPDFExAddInteractiveElements (bool16 addIElems)=0

virtual bool16	GetPDFExAddInteractiveElements () const =0

virtual IGenericSettings *	GetSettings (bool16 fShowSecurity=kFalse, bool16 bShowDescriptionAndWarnings=kFalse, IDocument *iDoc=nil) const =0

virtual void	SetProgress (RangeProgressBar *pProgress)=0

virtual RangeProgressBar *	GetProgress () const =0

virtual void	SetPageMarkFile (const PMString &pageMarkFile)=0

virtual PMString	GetPageMarkFile () const =0

virtual void	SetIncludeLayers (bool32 includeLayers)=0

virtual bool32	GetIncludeLayers () const =0

virtual void	SetExportLayers (const int32 exportLayers)=0

virtual int32	GetExportLayers () const =0

virtual void	SetCompressColorAbove (int32 dpi)=0

virtual int32	GetCompressColorAbove () const =0

virtual void	SetCompressGrayAbove (int32 dpi)=0

virtual int32	GetCompressGrayAbove () const =0

virtual void	SetCompressMonochromeAbove (int32 dpi)=0

virtual int32	GetCompressMonochromeAbove () const =0

virtual void	SetColorTileSize (int32 dpi)=0

virtual int32	GetColorTileSize () const =0

virtual void	SetGrayTileSize (int32 dpi)=0

virtual int32	GetGrayTileSize () const =0

virtual void	SetUseDocumentBleed (bool32 documentBleed)=0

virtual bool32	GetUseDocumentBleed () const =0

virtual void	SetIncludeSlug (bool32 includeSlug)=0

virtual bool32	GetIncludeSlug () const =0

virtual void	SetContentToEmbed (int32 contentToEmbed)=0

virtual int32	GetContentToEmbed () const =0

virtual void	SetCompressionType (int32 compressionType)=0

virtual int32	GetCompressionType () const =0

virtual void	SetPDFXProfileSelectorAndName (int32 selector, const PMString &name)=0

virtual int32	GetPDFXProfileSelector () const =0

virtual PMString	GetPDFXProfileName () const =0

virtual PMString	GetEffectivePDFXProfileName () const =0

virtual void	SetTranslatedDescription (const PMString &desc, int32 langid)=0

virtual PMString	GetTranslatedDescription (int32 langid)=0

virtual void	SetOutputConditionHumanReadable (const PMString &id)=0

virtual PMString	GetOutputConditionHumanReadable () const =0

virtual ErrorCode	ReadJobOptionsDataFromDisk (const IDFile &presetFile)=0

virtual ErrorCode	WriteJobOptionsDataToDisk (const IDFile &presetFile)=0

virtual PDFSettings *	GetJobOptionsData () const =0

virtual bool16	IsPresetUsable () const =0

virtual POSObject *	GetWarningList (IDocument const *document) const =0

virtual PMString	GetPresetFilename () const =0

virtual void	SetUIName (PMString const &name)=0

virtual PMString	GetUIName () const =0

virtual uint64	GetTimeStamp () const =0

virtual void	ReadWrite (IPMStream *iPMStream, ImplementationID prop)=0

virtual void	SetPresetFilename (PMString const &filename)=0

virtual bool16	IsModified () const =0

virtual bool32	FixUpSettings (IDocument *iDoc=nil, bool32 clearDirty=kFalse)=0

virtual PDFSettings *	GetPristineJobOptionsData () const =0

virtual PMReal	GetFlattenerRasterVectorBalance () const =0

virtual PMReal	GetFlattenerLineArtTextResolution () const =0

virtual PMReal	GetFlattenerGradientResolution () const =0

virtual bool32	GetFlattenerClipComplexRegions () const =0

virtual bool32	GetFlattenerConvertStrokesToOutlines () const =0

virtual bool32	GetFlattenerConvertTextToOutlines () const =0

virtual void	SetMagnification (int32 magnification)=0

virtual int32	GetMagnification () const =0

virtual void	SetPageLayout (int32 pageLayout)=0

virtual int32	GetPageLayout () const =0

virtual void	SetOpenInFullScreenMode (bool16 fullScreen)=0

virtual bool16	GetOpenInFullScreenMode () const =0

virtual void	SetDisplayTitle (int32 title)=0

virtual int32	GetDisplayTitle () const =0

virtual void	SetDefaultDocumentLanguage (const PMString &language)=0

virtual PMString	GetDefaultDocumentLanguage () const =0

virtual void	SetExportSinglePagesPDF (bool16 exportSinglePages)=0

virtual bool16	GetExportSinglePagesPDF () const =0

virtual void	SetSinglePagesPDFSuffix (PMString singlePagesSuffix)=0

virtual PMString	GetSinglePagesPDFSuffix () const =0

virtual void	SetExportHiddenSpread (bool16 exportHiddenSpread)=0

virtual bool16	GetExportHiddenSpread () 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

IPDFExportPrefs contains the PDF export preferences.

Member Function Documentation

virtual void IPDFExportPrefs::CopyPrefs ( IPDFExportPrefs const * prefsToCopy )

pure virtual

Copy the specified preferences to this object.

Parameters

prefsToCopy is a pointer to the preferences to copy.

virtual bool32 IPDFExportPrefs::FixUpSettings	(	IDocument *	iDoc = `nil`,
		bool32	clearDirty = `kFalse`
	)

pure virtual

Make the PDF preferences consistent for a document's CMS state.

FixUpSettings is meant to ensure that settings are in a consistent state, especially with regards to color conversion and color management options. It is called at various points in the export process, typically where we've read in a set of settings from a .joboptions file on disk. InDesign will also call this at various places in the UI and scripting code to ensure that changes made don't put things into an inconsistent state.

The document parameter to FixUpSettings is used to determine two things: First, whether CMS is on in the specified document; and second, what the current CMYK and RGB working profiles are. If the default nil value is used, InDesign uses profiles from the workspace and makes the assumption that CMS is on. InDesign uses this information to apply various heuristics. At a 10K foot level, it:

1) Applies some basic fix ups related to obsolete keys or bogus entries. This is most relevant when a joboptions file is read in from disk, particularly when the source for that joboptions file is Distiller or an obsolete CS app. It is usually not necessary if the source is a CS app or if entries in the settings are programmatically edited.

2) Fills in any default values that may be missing. Again, this is most common for files read in from disk any is usually not required if entries are explicitly modified.

3) Determines whether we should honor the so-called 'private dict' settings used by CS apps or the 'official' ones that Distiller uses.

The third item is the most important. The problem is that Distiller and the CS apps differ in the way CMS works and the joboptions parameters used to configure it. As a result, CS apps must at times approximate the behavior implied by the Distiller settings. The private dict settings reduce the problem somewhat by standardizing treatment of CMS- related options across CS apps, but present a different problem in that CS apps must be able to determine if a joboptions file has been edited in a way to invalidates the private settings. FixUpSettings accomplishes that.

The recommendation is that a call to FixUpSettings be made after programmatically editing an IPDFExportPrefs instance, particularly with options related to color conversion or color management. Whenever possible, this should include a pointer to the document to be exported to ensure the correct working profiles are used and any necessary corrections are made. It is also recommended - but not required - that a call to IsPresetUsable be made to ensure that the settings instance is in a usable state.

Parameters

iDoc	[IN, OPTIONAL] The associated document to use with these settings. A nil value (the default) indicates that there is no associated document and that the settings should behave as if CMS were on, using default profiles (as the preset editor does).
clearDirty	[IN, OPTIONAL]. A value of true clears the use modified flag (makes IsModified return false).

Returns: true when changes were made to the settings.

virtual bool16 IPDFExportPrefs::GetAddStructure ( ) const

pure virtual

Get Tagged PDF preference.

Returns: true when generating Tagged PDF.

virtual int32 IPDFExportPrefs::GetColorTileSize ( ) const

pure virtual

Get the color tile size.

Returns: the tile size.

virtual int32 IPDFExportPrefs::GetCompressColorAbove ( ) const

pure virtual

Get the color resolution threshold.

Returns: the resolution.

virtual int32 IPDFExportPrefs::GetCompressGrayAbove ( ) const

pure virtual

Get the gray resolution threshold.

Returns: the resolution.

virtual int32 IPDFExportPrefs::GetCompressionType ( ) const

pure virtual

Get compression type.

Returns: compression type.

virtual int32 IPDFExportPrefs::GetCompressMonochromeAbove ( ) const

pure virtual

Get the monochrome resolution threshold.

Returns: the resolution.

virtual int32 IPDFExportPrefs::GetContentToEmbed ( ) const

pure virtual

Get interactive content to embed. NOTE: as of CS5, GetContentToEmbed is obsolete since Export to PDF for Print does not output interactive elements. Instead use the IInteractivePDFExportFacade.

Returns: interactive content to embed.

virtual PMString IPDFExportPrefs::GetDefaultDocumentLanguage ( ) const

pure virtual

Gets the default document language for the PDF being exported.

virtual int32 IPDFExportPrefs::GetDisplayTitle ( ) const

pure virtual

Gets the display title for the PDF being exported.

Returns: One of the DisplayTitle enum specifying the document title to use.

virtual PMString IPDFExportPrefs::GetEffectiveDstProfileName ( ) const

pure virtual

Get destination profile name. This returns the resulting profile after mapping the selector value to an actual profile.

Returns: name of the profile.

virtual PMString IPDFExportPrefs::GetEffectivePDFXOCRegistryName ( ) const

pure virtual

Get the output condition registry name. This returns the known condition associated with an output intent profile identified by the selector value.

Returns: the name of the output condition registry name.

virtual PMString IPDFExportPrefs::GetEffectivePDFXOutputConditionName ( ) const

pure virtual

Get the output condition identifier. Returns a known condition if the effective output intent profile maps to one. Otherwise the name specfied in the preset is returned.

Returns: output condition identifier.

virtual PMString IPDFExportPrefs::GetEffectivePDFXProfileName ( ) const

pure virtual

Get PDF/X profile name. This applies when the selector is use name. It returns the mapped profile if the selector references document or working space rather than using a name directly.

Returns: name of the profile.

virtual bool16 IPDFExportPrefs::GetExportHiddenSpread ( ) const

pure virtual

Gets whether to export the document with hidden spreads or not.

Returns: kTrue if PDF is to be exported with hidden spreads.

virtual int32 IPDFExportPrefs::GetExportLayers ( ) const

pure virtual

Get which layers will export

Returns: one of kExportAllLayers, kExportVisibleLayers, kExportVisiblePrintableLayers

virtual bool16 IPDFExportPrefs::GetExportSinglePagesPDF ( ) const

pure virtual

Gets whether to export the document in single pages PDF.

Returns: kTrue if PDF is to be exported in single pages.

virtual bool32 IPDFExportPrefs::GetFlattenerClipComplexRegions ( ) const

pure virtual

Get the flattener clip complex regions state (GetFlattenerFlags - IFlattenerSettings::kFlOptkClipComplexRegions).

Returns: the state.

virtual bool32 IPDFExportPrefs::GetFlattenerConvertStrokesToOutlines ( ) const

pure virtual

Get the flattener convert strokes to outlines state (GetFlattenerFlags - IFlattenerSettings::kFlOptkConvertStrokeToFill).

Returns: the state.

virtual bool32 IPDFExportPrefs::GetFlattenerConvertTextToOutlines ( ) const

pure virtual

Get the flattener convert text to outlines state (GetFlattenerFlags - IFlattenerSettings::kFlOptUseTextOutlines).

Returns: the state.

virtual PMReal IPDFExportPrefs::GetFlattenerGradientResolution ( ) const

pure virtual

Get the flattener gradient resolution (GetFlattenerInternalDPI).

Returns: the resolution.

virtual PMReal IPDFExportPrefs::GetFlattenerLineArtTextResolution ( ) const

pure virtual

Get the flattener line art text resolution (GetFlattenerExternalDPI).

Returns: the resolution.

virtual PMReal IPDFExportPrefs::GetFlattenerRasterVectorBalance ( ) const

pure virtual

The following flattener settings get methods are used to create a flattener preset when the PDF preset is added to the PDF preset list. When you change the flattener name with SetPDFExFlattenerStyleName all these settings are changed to match the settings in the flattener style list. If there is no associated flattener setting, the default values are returned.Get the flattener raster vector balance (GetFlattenerLevel).

Returns: the level.

virtual int32 IPDFExportPrefs::GetGrayTileSize ( ) const

pure virtual

Get the gray tile size.

Returns: the tile size.

virtual bool32 IPDFExportPrefs::GetIncludeBookmarks ( ) const

pure virtual

Get include bookmarks preference.

Returns: include bookmarks preference.

virtual bool32 IPDFExportPrefs::GetIncludeLayers ( ) const

pure virtual

Get the include layers preference.

Returns: the include layers preference.

virtual bool32 IPDFExportPrefs::GetIncludeSlug ( ) const

pure virtual

Get include slug preference.

Returns: include slug preference.

virtual PDFSettings* IPDFExportPrefs::GetJobOptionsData ( ) const

pure virtual

Get the associated job options data.

Returns: PDFSettings object.

virtual int32 IPDFExportPrefs::GetMagnification ( ) const

pure virtual

Gets the initial magnification setting.

Returns: One of the Magnification enum specifying the magnification to use.

virtual bool32 IPDFExportPrefs::GetNonprintingObjects ( ) const

pure virtual

Get include non-printing objects preference.

Returns: include non-printing objects preference.

virtual bool16 IPDFExportPrefs::GetOpenInFullScreenMode ( ) const

pure virtual

Gets whether to open the PDF in full screen mode.

Returns: kTrue if PDF is to be opened in full screen mode.

virtual PMString IPDFExportPrefs::GetOutputConditionHumanReadable ( ) const

pure virtual

Get the output condition name.

Returns: the output condition name.

virtual int32 IPDFExportPrefs::GetPageLayout ( ) const

pure virtual

Gets the page layout for the PDF being exported.

Returns: One of the PageLayout enum specifying the page layout to use.

virtual PMString IPDFExportPrefs::GetPageMarkFile ( ) const

pure virtual

Get the page mark file.

Returns: the page mark file.

virtual int32 IPDFExportPrefs::GetPDFExAcrobatCompatibilityLevel ( ) const

pure virtual

Get Acrobat compatibility level.

Returns: kPDFVersion12, kPDFVersion13, kPDFVersion14, kPDFVersion15, kPDFVersion16, kPDFVersion17. kPDFVersion12 is for interoperbility only.

virtual bool16 IPDFExportPrefs::GetPDFExAddInteractiveElements ( ) const

pure virtual

Get the include interactive elements preference. NOTE: As of CS5, Export to PDF for Print does not export interactive elements. To export create an interactive PDF, use Export PDF (Interactive). The GetPDFExAddInteractiveElements preference here now maps to the Interactive Elements choice in the UI. If TRUE, interactive elements are drawn as 'Appearance Only'. If FALSE, interactive elements are set to 'Do Not Include'.

Returns: include interactive elements.

virtual int32 IPDFExportPrefs::GetPDFExBitmapSampling ( ) const

pure virtual

Not used.

virtual int32 IPDFExportPrefs::GetPDFExBleed ( ) const

pure virtual

Get whether to include bleed.

Returns: include bleed preference.

virtual PMReal IPDFExportPrefs::GetPDFExBleedBottom ( ) const

pure virtual

Get bleed bottom offset preference.

Returns: bleed bottom offset.

virtual PMReal IPDFExportPrefs::GetPDFExBleedInside ( ) const

pure virtual

Get bleed inside offset preference.

Returns: bleed inside offset.

virtual int32 IPDFExportPrefs::GetPDFExBleedMarks ( ) const

pure virtual

Get include bleed marks preference.

Returns: either kExportBleedMarksON or kExportBleedMarksOFF.

virtual PMReal IPDFExportPrefs::GetPDFExBleedOutside ( ) const

pure virtual

Get bleed outside offset preference.

Returns: bleed outside offset.

virtual PMReal IPDFExportPrefs::GetPDFExBleedTop ( ) const

pure virtual

Get bleed top offset preference.

Returns: bleed top offset.

virtual int32 IPDFExportPrefs::GetPDFExColorBars ( ) const

pure virtual

Get include color bars preference.

Returns: either kExportColorBarsON or kExportColorBarsOFF.

virtual int32 IPDFExportPrefs::GetPDFExColorSpace ( ) const

pure virtual

Get the PDF color space.

Returns: PDF color space, see kExportPDFColorSpace... values.

virtual int32 IPDFExportPrefs::GetPDFExCompressColorImages ( ) const

pure virtual

Get compression strategy to use for color images.

Returns: compression strategy. See kExportCompressImages... values.

virtual int32 IPDFExportPrefs::GetPDFExCompressGrayImages ( ) const

pure virtual

Get compression strategy to use for gray images.

Returns: compression strategy. See kExportCompressImages... values.

virtual int32 IPDFExportPrefs::GetPDFExCompressLineArtAndText ( ) const

pure virtual

Get compress line art and text preference.

Returns: either kExportCompressLineArtAndTextON or kExportCompressLineArtAndTextOFF.

virtual int32 IPDFExportPrefs::GetPDFExCompressMonoImages ( ) const

pure virtual

Get compression strategy to use for monochrome images.

Returns: compression strategy. See kExportCompressImages... values.

virtual int32 IPDFExportPrefs::GetPDFExCropMarks ( ) const

pure virtual

Get include copy marks preference.

Returns: either kExportCropMarksON or kExportCropMarksOFF.

virtual int32 IPDFExportPrefs::GetPDFExDisallowImageCrop ( ) const

pure virtual

Get image crop to frame preference.

Returns: either kExportDisallowImageCropON, or kExportDisallowImageCropOFF.

virtual PMString IPDFExportPrefs::GetPDFExDstProfileName ( ) const

pure virtual

Set destination profile name. This applies when the destination selector is use name.

Deprecated for InDesign 5.0.  See SetPDFExDstProfileSelectorAndName

Parameters

name	of the profile. virtual void SetPDFExDstProfileName(const PMString &name) = 0;Get destination profile name. This applies when the destination selector is use name.

Returns: name of the profile.

virtual int32 IPDFExportPrefs::GetPDFExDstProfileSelector ( ) const

pure virtual

Set destination profile selector.

Deprecated for InDesign 5.0.  See SetPDFExDstProfileSelectorAndName

Parameters

selector value. See kExportPDFDestProfile... values. virtual void SetPDFExDstProfileSelector(int32 selector) = 0;Get destination profile selector.

Returns: selector value. See kExportPDFDestProfile... values.

virtual int32 IPDFExportPrefs::GetPDFExEmbedFonts ( ) const

pure virtual

Not used.

virtual int32 IPDFExportPrefs::GetPDFExErrorControl ( ) const

pure virtual

Get error control preference.

Returns: either kExportErrorControlWarnAndContinue, kExportErrorControlIgnore, or kExportErrorControlCancelJob.

virtual UID IPDFExportPrefs::GetPDFExFlattenerStyle ( ) const

pure virtual

Get flattener preset UID for the associated flattener preset name.

Returns: UID of flattener preset.

virtual PMString IPDFExportPrefs::GetPDFExFlattenerStyleName ( ) const

pure virtual

Get the associated flattener preset name.

Returns: UID of flattener preset.

virtual bool16 IPDFExportPrefs::GetPDFExIgnoreFlattenerSpreadOverrides ( ) const

pure virtual

Get the preference to ignore flattener spread overrides.

Returns: true when ignore flattener spread overrides.

virtual int32 IPDFExportPrefs::GetPDFExIncHyperLinks ( ) const

pure virtual

Get include hyperlinks preference.

Returns: either kExportIncHyperLinksON or kExportIncHyperLinksOFF.

virtual int32 IPDFExportPrefs::GetPDFExIncludeICCProfiles ( ) const

pure virtual

Get the include ICC profile preference.

Returns: the include ICC profile. See kExportInclude... values.

virtual int32 IPDFExportPrefs::GetPDFExLaunchAcrobat ( ) const

pure virtual

Deprecated.

virtual int32 IPDFExportPrefs::GetPDFExLinearized ( ) const

pure virtual

Get linearized preference.

Returns: either either kExportLinearizedON or kExportLinearizedOFF.

virtual PMReal IPDFExportPrefs::GetPDFExMarkLineWeight ( ) const

pure virtual

Get mark line weight preference. This call will return the closest value to a legal value based on system locale. A valid Japanese value (J is a superset of R - see call above) will only be returned if the system locale is J.

Returns: line weight.

virtual PMReal IPDFExportPrefs::GetPDFExMarkLineWeightJ ( ) const

pure virtual

Get mark line weight preference including Japanese. This is done to allow scripting to get the same value as the put. Previously the put did not restrict the value to match the system locale but the get did (J has metric values in addition to Roman). If a script put a J value it would be stored but was returned as the nearest matching R value if the locale was R. The DOM now controls the legality of the enum, not the scripting methods. Bug #1147387.

Returns: line weight.

virtual PMString IPDFExportPrefs::GetPDFExOCRegistryName ( ) const

pure virtual

Get the output condition registry name.

Returns: the name of the output condition registry name.

virtual int32 IPDFExportPrefs::GetPDFExOmitBitmapImages ( ) const

pure virtual

Get omit bitmap images for OPI preference.

Returns: either kExportOmitBitmapImagesON, or kExportOmitBitmapImagesON.

virtual int32 IPDFExportPrefs::GetPDFExOmitEPS ( ) const

pure virtual

Get omit EPS for OPI preference.

Returns: either kExportOmitEPSON, or kExportOmitEPSOFF.

virtual int32 IPDFExportPrefs::GetPDFExOmitPDF ( ) const

pure virtual

Get omit PDF for OPI preference.

Returns: either kExportOmitPDFON, or kExportOmitPDFOFF.

virtual PMString IPDFExportPrefs::GetPDFExOutputConditionName ( ) const

pure virtual

Get the output condition identifier.

Returns: output condition identifier.

virtual int32 IPDFExportPrefs::GetPDFExOutputOPI ( ) const

pure virtual

Not used.

virtual int32 IPDFExportPrefs::GetPDFExPageInfo ( ) const

pure virtual

Get include page information preference.

Returns: either kExportPageInfoON or kExportPageInfoOFF.

virtual PMReal IPDFExportPrefs::GetPDFExPrinterMarksOffset ( ) const

pure virtual

Get crop mark offset preference.

Returns: crop mark offset.

virtual int32 IPDFExportPrefs::GetPDFExReaderSpreads ( ) const

pure virtual

Get reader spreads preference.

Returns: either kExportReaderSpreadsON or kExportReaderSpreadsOFF.

virtual int32 IPDFExportPrefs::GetPDFExRegistrationMarks ( ) const

pure virtual

Get include registration marks preference.

Returns: either kExportRegistrationMarksON or kExportRegistrationMarksOFF.

virtual int32 IPDFExportPrefs::GetPDFExResolution ( ) const

pure virtual

Get image resolution.

Returns: image resolution.

virtual int32 IPDFExportPrefs::GetPDFExSampleColorImages ( ) const

pure virtual

Get down sample color image preference.

Returns: color image preference. See kExportSampleImages... values.

virtual int32 IPDFExportPrefs::GetPDFExSampleColorImagesXRes ( ) const

pure virtual

Get color down sample resolution preference.

Returns: down sample resolution preference.

virtual int32 IPDFExportPrefs::GetPDFExSampleColorImagesYRes ( ) const

pure virtual

Get color down sample resolution preference.

Returns: down sample resolution preference.

virtual int32 IPDFExportPrefs::GetPDFExSampleGrayImages ( ) const

pure virtual

Get down sample gray image preference.

Returns: gray image preference. See kExportSampleImages... values.

virtual int32 IPDFExportPrefs::GetPDFExSampleGrayImagesXRes ( ) const

pure virtual

Get gray sample resolution preference.

Returns: down sample resolution preference.

virtual int32 IPDFExportPrefs::GetPDFExSampleGrayImagesYRes ( ) const

pure virtual

Get gray sample resolution preference.

Returns: down sample resolution preference.

virtual int32 IPDFExportPrefs::GetPDFExSampleMonoImages ( ) const

pure virtual

Get down sample monochrome image preference.

Returns: monochrome image preference. See kExportSampleImages... values.

virtual int32 IPDFExportPrefs::GetPDFExSampleMonoImagesXRes ( ) const

pure virtual

Get monochrome sample resolution preference.

Returns: down sample resolution preference.

virtual int32 IPDFExportPrefs::GetPDFExSampleMonoImagesYRes ( ) const

pure virtual

Get monochrome sample resolution preference.

Returns: down sample resolution preference.

virtual int32 IPDFExportPrefs::GetPDFExSpotOverPrint ( ) const

pure virtual

Get spot over print preference.

Returns: kExportLegacy, kExportSimulatePress, or kExportSimulateScreen.

virtual int32 IPDFExportPrefs::GetPDFExStandardsCompliance ( void ) const

pure virtual

Get the standard compliance level.

Returns: standard compliance level.

virtual int32 IPDFExportPrefs::GetPDFExSubsetFonts ( ) const

pure virtual

Not used.

virtual int32 IPDFExportPrefs::GetPDFExSubsetFontsThreshold ( ) const

pure virtual

Get the glyph percentage threshold.

Returns: the glyph percentage.

virtual int32 IPDFExportPrefs::GetPDFExThumbnails ( ) const

pure virtual

Get thumbnail generation preference.

Returns: either either kExportThumbnailsON or kExportThumbnailsOFF.

virtual PMString IPDFExportPrefs::GetPDFXProfileName ( ) const

pure virtual

Set PDF/X profile name. This applies when the selector is use name.

Deprecated for InDesign 5.0.  See SetPDFXProfileSelectorAndName

Parameters

name	of the profile. virtual void SetPDFXProfileName(const PMString &name) = 0;Get PDF/X profile name. This applies when the selector is use name.

Returns: name of the profile.

virtual int32 IPDFExportPrefs::GetPDFXProfileSelector ( ) const

pure virtual

Set PDF/X profile selector.

Deprecated for InDesign 5.0.  See SetPDFXProfileSelectorAndName

Parameters

selector value. See kExportPDFDestProfile... values.

virtual void SetPDFXProfileSelector(int32 selector) = 0;Get PDF/X profile selector.

Returns: selector value. See kExportPDFDestProfile... values.

virtual PMString IPDFExportPrefs::GetPresetFilename ( ) const

pure virtual

Get the associated preset filename without directory or extension information.

There are three types of preset names.

presetFilename returned from GetPresetFilename. This is the name of the preset file on disk (without the directory or extension).
uiName returned from GetUIName. This is the name you see in the UI. It has special characters replaces with underscores and Read Only presets have bracket around them. Special names get translated, for example "PDFX1a 2001" becomes "PDF/X-1a 2001".
presetName returned from PDF style list manager. This is the name you get from the manager, it is the same as the uiName.

Returns: the filename.

virtual PDFSettings* IPDFExportPrefs::GetPristineJobOptionsData ( ) const

pure virtual

Get the pristine job option preferences. These settings reflect the preferences on disk before fixups.

Returns: PDFSettings object.

virtual RangeProgressBar* IPDFExportPrefs::GetProgress ( ) const

pure virtual

Get the progress bar.

Returns: the progress bar.

virtual IGenericSettings* IPDFExportPrefs::GetSettings	(	bool16	fShowSecurity = `kFalse`,
		bool16	bShowDescriptionAndWarnings = `kFalse`,
		IDocument *	iDoc = `nil`
	)		const

pure virtual

Get the associated IGenericSettings interface.

Returns: associated IGenericSettings interface.

virtual PMString IPDFExportPrefs::GetSinglePagesPDFSuffix ( ) const

pure virtual

Gets the suffix to be used in PDF file names when exporting single pages PDF.

virtual uint64 IPDFExportPrefs::GetTimeStamp ( ) const

pure virtual

Get the associated preset file's modified time stamp.

Returns: the time stamp. See GlobalTime.h.

virtual PMString IPDFExportPrefs::GetTranslatedDescription ( int32 langid )

pure virtual

Get the description string for the specified language.

Parameters

langid of the string.

Returns: the description string.

virtual PMString IPDFExportPrefs::GetUIName ( ) const

pure virtual

Get the UI name for these preferences.

Returns: the name of these preferences.

virtual bool32 IPDFExportPrefs::GetUseDocumentBleed ( ) const

pure virtual

Get the use document bleed preference.

Returns: use the document bleed preference.

virtual bool32 IPDFExportPrefs::GetVisibleGuidesGrids ( ) const

pure virtual

Get include visible guides and grids preference.

Returns: include visible guides and grids.

virtual POSObject* IPDFExportPrefs::GetWarningList ( IDocument const * document ) const

pure virtual

Get the associated warning list object.

Parameters

document. The document used to determine working profiles. When it is non-nil, the CMS on/off state is looked up and applies to the warnings. When nil, CMS is treated as if it is on.

Returns: POSObject object.

virtual bool16 IPDFExportPrefs::IsModified ( ) const

pure virtual

Determine whether the user has modified the settings. This is reflected in the UI when (modified) is appended to the preset name.

Returns: kTrue when the preferences have been modified.

virtual bool16 IPDFExportPrefs::IsPresetUsable ( ) const

pure virtual

Determine whether these preferences are valid.

Returns: true when the preferences are valid.

virtual ErrorCode IPDFExportPrefs::ReadJobOptionsDataFromDisk ( const IDFile & presetFile )

pure virtual

Read the preferences from the given PDF preset file to this object.

Parameters

presetFile is the preset file to read.

Returns: kSuccess when successful.

virtual void IPDFExportPrefs::ReadWrite	(	IPMStream *	iPMStream,
		ImplementationID	prop
	)

pure virtual

Method to stream in/out the preferences.

Parameters

iPMStream	is the stream to read/write.
prop	is the implementation ID.

virtual void IPDFExportPrefs::SetAddStructure ( bool16 add )

pure virtual

Set whether to generate Tagged PDF.

Parameters

add	is true to generate Tagged PDF.

virtual void IPDFExportPrefs::SetColorTileSize ( int32 dpi )

pure virtual

Set the color tile size to use with JPEG2000 compression.

Parameters

dpi	is the tile size, a value from kMinJPG2000TileSize to kMaxJPG2000TileSize.

virtual void IPDFExportPrefs::SetCompressColorAbove ( int32 dpi )

pure virtual

Set the color resolution threshold. Images above this resolution are compressed.

Parameters

dpi	is the resolution to use. It is a value from the image resolution (see SetPDFExSampleColorImagesXRes) to ten times the image resolution.

virtual void IPDFExportPrefs::SetCompressGrayAbove ( int32 dpi )

pure virtual

Set the gray resolution threshold. Images above this resolution are compressed.

Parameters

dpi	is the resolution to use. It is a value from the image resolution (see SetPDFExSampleGrayImagesXRes) to ten times the image resolution.

virtual void IPDFExportPrefs::SetCompressionType ( int32 compressionType )

pure virtual

Set the compression type to apply to the PDF file.

Parameters

compressionType is kCompressNone, kCompressStructure. kCompressObjects is not used.

virtual void IPDFExportPrefs::SetCompressMonochromeAbove ( int32 dpi )

pure virtual

Set the monochrome resolution threshold. Images above this resolution are compressed.

Parameters

dpi	is the resolution to use. It is a value from the image resolution (see SetPDFExSampleMonoImagesXRes) to ten times the image resolution.

virtual void IPDFExportPrefs::SetContentToEmbed ( int32 contentToEmbed )

pure virtual

Set interactive content to embed. NOTE: as of CS5, SetContentToEmbed is obsolete since Export to PDF for Print does not output interactive elements. Instead use the IInteractivePDFExportFacade.

Parameters

contentToEmbed is kUseObjectSettings, kLinkAll, or kEmbedAll.

virtual void IPDFExportPrefs::SetDefaultDocumentLanguage ( const PMString & language )

pure virtual

Sets the default document language for the PDF being exported.

virtual void IPDFExportPrefs::SetDisplayTitle ( int32 title )

pure virtual

Sets the display title for the PDF being exported.

Parameters

title,: One of the DisplayTitle enum specifying the title to use.

virtual void IPDFExportPrefs::SetExportHiddenSpread ( bool16 exportHiddenSpread )

pure virtual

Sets whether to export document with hidden spreads.

Parameters

exportHiddenSpread Boolean. If kTrue, document is exported with hidden spreads.

virtual void IPDFExportPrefs::SetExportLayers ( const int32 exportLayers )

pure virtual

Set which layers will export

Parameters

exportLayers IN one of kExportAllLayers, kExportVisibleLayers, kExportVisiblePrintableLayers

virtual void IPDFExportPrefs::SetExportSinglePagesPDF ( bool16 exportSinglePages )

pure virtual

Sets whether to export document in single pages PDF.

Parameters

exportSinglePages Boolean. If kTrue, document is exported in single pages PDF.

virtual void IPDFExportPrefs::SetGrayTileSize ( int32 dpi )

pure virtual

Set the gray tile size to use with JPEG2000 compression.

Parameters

dpi	is the tile size, a value from kMinJPG2000TileSize to kMaxJPG2000TileSize.

virtual void IPDFExportPrefs::SetIncludeBookmarks ( bool32 add )

pure virtual

Set include bookmarks preference.

Parameters

add	is true to include bookmarks in the PDF.

virtual void IPDFExportPrefs::SetIncludeLayers ( bool32 includeLayers )

pure virtual

Set the include layers in the PDF file.

Parameters

includeLayers is true to include layers.

virtual void IPDFExportPrefs::SetIncludeSlug ( bool32 includeSlug )

pure virtual

Set include slug preference.

Parameters

includeSlug is true to include the slug area in the PDF.

virtual void IPDFExportPrefs::SetMagnification ( int32 magnification )

pure virtual

Sets the initial magnification when the PDF is opened.

Parameters

Magnification,: One of the Magnification enum specifying the initial magnification to use.

virtual void IPDFExportPrefs::SetNonprintingObjects ( bool32 checked )

pure virtual

Set include non-printing objects preference.

Parameters

checked is true to include non-printing objects in the PDF.

virtual void IPDFExportPrefs::SetOpenInFullScreenMode ( bool16 fullScreen )

pure virtual

Sets whether to open the PDF in full screen mode.

Parameters

fullScreen Boolean. If kTrue, PDF is opened in full screen mode.

virtual void IPDFExportPrefs::SetOutputConditionHumanReadable ( const PMString & id )

pure virtual

Set the output condition name.

Parameters

id	is the output condition name.

virtual void IPDFExportPrefs::SetPageLayout ( int32 pageLayout )

pure virtual

Sets the page layout for the PDF being exported.

Parameters

PageLayout,: One of the PageLayout enum specifying the page layout to use.

virtual void IPDFExportPrefs::SetPageMarkFile ( const PMString & pageMarkFile )

pure virtual

Set the name of the page mark file to use.

Parameters

pageMarkFile is the name of the page mark file.

There are three special names.

The empty string means to use the default,
"kJMarksWithCircle" means to use the Japanese mark file containing circles,
"kJMarksWithoutCircle" means to use the Japanese mark file without circles. The name must not be translated (the translated bit is 0).

For the other cases, pass the file name part without the path and extension. Page mark files reside in the common Adobe PrintSpt folder.

virtual void IPDFExportPrefs::SetPDFExAcrobatCompatibilityLevel ( int32 appVersion )

pure virtual

Set Acrobat compatibility level.

Parameters

appVersion is kPDFVersion12, kPDFVersion13, kPDFVersion14, kPDFVersion15, kPDFVersion16, or kPDFVersion17. kPDFVersion12 is for interoperbility only.

virtual void IPDFExportPrefs::SetPDFExAddInteractiveElements ( bool16 addIElems )

pure virtual

Set the include interactive elements preference. NOTE: As of CS5, Export to PDF for Print does not export interactive elements. To export create an interactive PDF, use Export PDF (Interactive). The SetPDFExAddInteractiveElements preference here now maps to the Interactive Elements choice in the UI. If TRUE, interactive elements are drawn as 'Appearance Only'. If FALSE, interactive elements are set to 'Do Not Include'.

Parameters

addIElems is true to include interactive elements.

virtual void IPDFExportPrefs::SetPDFExBitmapSampling ( int32 bitmapSampling )

pure virtual

Not used.

virtual void IPDFExportPrefs::SetPDFExBleed ( int32 bleed )

pure virtual

Set whether to include the bleed area in the PDF file.

Parameters

bleed is either kExportBleedON or kExportBleedOFF.

virtual void IPDFExportPrefs::SetPDFExBleedBottom ( const PMReal & bleedBottom )

pure virtual

Set bleed bottom offset preference.

Parameters

bleedBottom is the bottom offset.

virtual void IPDFExportPrefs::SetPDFExBleedInside ( const PMReal & bleedInside )

pure virtual

Set bleed inside offset preference.

Parameters

bleedInside is the inside offset.

virtual void IPDFExportPrefs::SetPDFExBleedMarks ( int32 bleedMarks )

pure virtual

Set whether to include the bleed marks in the PDF file.

Parameters

bleedMarks is either kExportBleedMarksON or kExportBleedMarksOFF.

virtual void IPDFExportPrefs::SetPDFExBleedOutside ( const PMReal & bleedOutside )

pure virtual

Set bleed outside offset preference.

Parameters

bleedOutside is the outside offset.

virtual void IPDFExportPrefs::SetPDFExBleedTop ( const PMReal & bleedTop )

pure virtual

Set bleed top offset preference.

Parameters

bleedTop is the top offset.

virtual void IPDFExportPrefs::SetPDFExColorBars ( int32 colorBars )

pure virtual

Set whether to include the color bars in the PDF file.

Parameters

colorBars is either kExportColorBarsON or kExportColorBarsOFF.

virtual void IPDFExportPrefs::SetPDFExColorSpace ( int32 colorSpace )

pure virtual

Set PDF color space preference. This is the color space used when exporting.

Parameters

colorSpace is one of the following values: kExportPDFColorSpaceRGB, kExportPDFColorSpaceCMYK, kExportPDFColorSpaceDIC, kExportPDFColorSpacePassthru, kExportPDFRepurposeColorSpaceRGB, kExportPDFRepurposeColorSpaceCMYK,

virtual void IPDFExportPrefs::SetPDFExCompressColorImages ( int32 compressColorImages )

pure virtual

Set the compression strategy to use for color images.

Parameters

compressColorImages see kExportCompressImages... values above.

virtual void IPDFExportPrefs::SetPDFExCompressGrayImages ( int32 compressGrayImages )

pure virtual

Set the compression strategy to use for gray images.

Parameters

compressGrayImages see kExportCompressImages... values above.

virtual void IPDFExportPrefs::SetPDFExCompressLineArtAndText ( int32 compressLineArtAndText )

pure virtual

Set compress line art and text preference. This controls whether the PDF content streams are compressed.

Parameters

compressLineArtAndText is either kExportCompressLineArtAndTextON or kExportCompressLineArtAndTextOFF.

virtual void IPDFExportPrefs::SetPDFExCompressMonoImages ( int32 compressMonoImages )

pure virtual

Set the compression strategy to use for monochrome images.

Parameters

compressMonoImages see kExportCompressImages... values above.

virtual void IPDFExportPrefs::SetPDFExCropMarks ( int32 cropMarks )

pure virtual

Set whether to include the crop marks in the PDF file.

Parameters

cropMarks is either kExportCropMarksON or kExportCropMarksOFF.

virtual void IPDFExportPrefs::SetPDFExDisallowImageCrop ( int32 disallowImageCrop )

pure virtual

Set whether to crop the image to the frame or to include the complete image.

Parameters

disallowImageCrop is either kExportDisallowImageCropON, or kExportDisallowImageCropOFF.

virtual void IPDFExportPrefs::SetPDFExDstProfileSelectorAndName	(	int32	selector,
		const PMString &	name
	)

pure virtual

Set destination profile selector and name

This is an atomic setter which replaces both the SetPDFExDstProfileSelector and SetPDFExDstProfileName interfaces which were available until InDesign 4.0. Both values must be kept in sync for proper interchange with Distiller's edits to .joboptions files.

Parameters

selector	value. See kExportPDFDestProfile... values.
name	of the profile. This value is ignored if using a selector other than kExportPDFDestProfileUseName. The effective profile is set instead.

virtual void IPDFExportPrefs::SetPDFExEmbedFonts ( int32 embedFonts )

pure virtual

Not used. InDesign embeds fonts unless they are missing or protected.

virtual void IPDFExportPrefs::SetPDFExErrorControl ( int32 errorControl )

pure virtual

Set how errors and warnings are displayed when exporting to PDF.

Parameters

errorControl is one of kExportErrorControlWarnAndContinue, kExportErrorControlIgnore, or kExportErrorControlCancelJob.

virtual void IPDFExportPrefs::SetPDFExFlattenerStyleName ( const PMString & strStyle )

pure virtual

Set the associated flattener preset name.

Parameters

strStyle is the name of a flattener preset.

virtual void IPDFExportPrefs::SetPDFExIgnoreFlattenerSpreadOverrides ( bool16 ignore )

pure virtual

Set the preference to ignore flattener spread overrides.

Parameters

ignore is true to ignore flattener spread overrides.

virtual void IPDFExportPrefs::SetPDFExIncHyperLinks ( int32 incHyperLinks )

pure virtual

Set include hyperlinks preference.

Parameters

incHyperLinks either kExportIncHyperLinksON or kExportIncHyperLinksOFF.

virtual void IPDFExportPrefs::SetPDFExIncludeICCProfiles ( int32 includeICCProfiles )

pure virtual

Set the include ICC profiles preference.

Parameters

includeICCProfiles is one of the following values: kExportIncludeICCProfilesON, kExportIncludeICCProfilesOFF, kExportIncludeTaggedSourceProfiles, kExportIncludeRGBAndTaggedCMYKSourceProfiles,

virtual void IPDFExportPrefs::SetPDFExLaunchAcrobat ( int32 launchAcrobat )

pure virtual

Deprecated. Set the launch Acrobat after exporting preference. Use IPDFPostProcessPrefs::SetViewAfterExport off the workspace instead.

Parameters

launchAcrobat is either kExportLaunchAcrobatON or kExportLaunchAcrobatOFF.

virtual void IPDFExportPrefs::SetPDFExLinearized ( int32 linearized )

pure virtual

Set linearized preference. When true the PDF file is linearized.

Parameters

linearized is either kExportLinearizedON or kExportLinearizedOFF.

virtual void IPDFExportPrefs::SetPDFExMarkLineWeight ( const PMReal & markLineWeight )

pure virtual

Set mark line weight preference.

Parameters

markLineWeight one of the following values: 0.125 0.25 0.50 (0.05 / 25.4) * 72.0) (0.07 / 25.4) * 72.0) (0.10 / 25.4) * 72.0) (0.15 / 25.4) * 72.0) (0.20 / 25.4) * 72.0) (0.30 / 25.4) * 72.0)

virtual void IPDFExportPrefs::SetPDFExOCRegistryName ( PMString name )

pure virtual

Set the output condition registry name.

Parameters

name	of the output condition registry.

virtual void IPDFExportPrefs::SetPDFExOmitBitmapImages ( int32 omitBitmapImages )

pure virtual

Set the omit bitmap images for OPI preference.

Parameters

omitBitmapImages is either kExportOmitBitmapImagesON, or kExportOmitBitmapImagesON.

virtual void IPDFExportPrefs::SetPDFExOmitEPS ( int32 omitEPS )

pure virtual

Set the omit EPS images for OPI preference.

Parameters

omitEPS is either kExportOmitEPSON, or kExportOmitEPSOFF.

virtual void IPDFExportPrefs::SetPDFExOmitPDF ( int32 omitPDF )

pure virtual

Set the omit PDF images for OPI preference.

Parameters

omitPDF is either kExportOmitPDFON, or kExportOmitPDFOFF.

virtual void IPDFExportPrefs::SetPDFExOutputConditionName ( PMString name )

pure virtual

Set the output condition identifier.

Parameters

name	of the output condition identifier.

virtual void IPDFExportPrefs::SetPDFExOutputOPI ( int32 outputOPI )

pure virtual

Not used.

virtual void IPDFExportPrefs::SetPDFExPageInfo ( int32 pageInfo )

pure virtual

Set whether to include the page information in the PDF file.

Parameters

pageInfo is either kExportPageInfoON or kExportPageInfoOFF.

virtual void IPDFExportPrefs::SetPDFExPrinterMarksOffset ( PMReal printerMarksOffset )

pure virtual

Set the distance between the crop marks and the image area.

Parameters

printerMarksOffset distance value.

virtual void IPDFExportPrefs::SetPDFExReaderSpreads ( int32 readerSpreads )

pure virtual

Set the reader spreads preference. When true each PDF page is an InDesign spread.

Parameters

readerSpreads is either kExportReaderSpreadsON or kExportReaderSpreadsOFF.

virtual void IPDFExportPrefs::SetPDFExRegistrationMarks ( int32 registrationMarks )

pure virtual

Set whether to include the registration marks in the PDF file.

Parameters

registrationMarks is either kExportRegistrationMarksON or kExportRegistrationMarksOFF.

virtual void IPDFExportPrefs::SetPDFExResolution ( int32 resolution )

pure virtual

Set image resolution.

Parameters

resolution 72 to 4000.

virtual void IPDFExportPrefs::SetPDFExSampleColorImages ( int32 sampleColorImages )

pure virtual

Set color subsampling preference. This controls the type of subsampling done for color images.

Parameters

sampleColorImages is one of the following: kExportSampleImagesNone, kExportSampleImagesByDownsampling, kExportSampleImagesBySubsampling, kExportSampleImagesByBicubicDownsampling.

virtual void IPDFExportPrefs::SetPDFExSampleColorImagesXRes ( int32 colorImagesXRes )

pure virtual

Set the resolution of down sampled color images.

Parameters

colorImagesXRes is a value from kMinSampleColorImageRes to kMaxSampleColorImageRes.

virtual void IPDFExportPrefs::SetPDFExSampleColorImagesYRes ( int32 colorImagesYRes )

pure virtual

Set the resolution of down sampled color images.

Parameters

colorImagesYRes is a value from kMinSampleColorImageRes to kMaxSampleColorImageRes.

virtual void IPDFExportPrefs::SetPDFExSampleGrayImages ( int32 sampleGrayImages )

pure virtual

Set gray subsampling preference. This controls the type of subsampling done for gray images.

Parameters

sampleGrayImages is one of the following: kExportSampleImagesNone, kExportSampleImagesByDownsampling, kExportSampleImagesBySubsampling, kExportSampleImagesByBicubicDownsampling.

virtual void IPDFExportPrefs::SetPDFExSampleGrayImagesXRes ( int32 grayImagesXRes )

pure virtual

Set the resolution of down sampled gray images.

Parameters

grayImagesXRes is a value from kMinSampleGrayImageRes to kMaxSampleGrayImageRes.

virtual void IPDFExportPrefs::SetPDFExSampleGrayImagesYRes ( int32 grayImagesYRes )

pure virtual

Set the resolution of down sampled gray images.

Parameters

grayImagesYRes is a value from kMinSampleGrayImageRes to kMaxSampleGrayImageRes.

virtual void IPDFExportPrefs::SetPDFExSampleMonoImages ( int32 sampleMonoImages )

pure virtual

Set monochrome subsampling preference. This controls the type of subsampling done for monochrome images.

Parameters

sampleMonoImages is one of the following: kExportSampleImagesNone, kExportSampleImagesByDownsampling, kExportSampleImagesBySubsampling, kExportSampleImagesByBicubicDownsampling.

virtual void IPDFExportPrefs::SetPDFExSampleMonoImagesXRes ( int32 monoImagesXRes )

pure virtual

Set the resolution of down sampled monochrome images.

Parameters

monoImagesXRes is a value from kMinSampleMonoImageRes to kMaxSampleMonoImageRes.

virtual void IPDFExportPrefs::SetPDFExSampleMonoImagesYRes ( int32 monoImagesYRes )

pure virtual

Set the resolution of down sampled monochrome images.

Parameters

monoImagesYRes is a value from kMinSampleMonoImageRes to kMaxSampleMonoImageRes.

virtual void IPDFExportPrefs::SetPDFExSpotOverPrint ( int32 spotOverPrint )

pure virtual

Set spot over print preference.

Parameters

spotOverPrint is kExportLegacy, kExportSimulatePress, or kExportSimulateScreen.

virtual void IPDFExportPrefs::SetPDFExStandardsCompliance ( int32 standardLevel )

pure virtual

Set standard compliance level to use in the PDF.

Parameters

standardLevel is the standard compliance level. One of these values: kExportNoStandardsCompliance, kExportPDFX1a2001, kExportPDFX32002, kExportPDFX1a2003, kExportPDFX32003, kExportPDFA, kExportPDFA value is for interoperbility display only. kExportPDFX42010.

virtual void IPDFExportPrefs::SetPDFExSubsetFonts ( int32 subsetFonts )

pure virtual

Not used. InDesign subsets fonts it embeds depending on the threshold.

virtual void IPDFExportPrefs::SetPDFExSubsetFontsThreshold ( int32 subsetFontsThreshold )

pure virtual

Set subset fonts threshold preference. This controls whether to embed a subset font or the complete font in the PDF file.

Parameters

subsetFontsThreshold glyph percentage. When the precent of glyphs of the font used in the PDF file exceeds the specified percentage, the completed font is embedded, otherwise a subsetted version is embedded.

virtual void IPDFExportPrefs::SetPDFExThumbnails ( int32 thumbnails )

pure virtual

Set the thumbnails preference. When true thumbnails are written to the PDF file.

Parameters

thumbnails is either kExportThumbnailsON or kExportThumbnailsOFF.

virtual void IPDFExportPrefs::SetPDFXProfileSelectorAndName	(	int32	selector,
		const PMString &	name
	)

pure virtual

Set PDFX Output Intent profile selector and name

This is an atomic setter which replaces both the SetPDFXProfileSelector and SetPDFXProfileName interfaces which were available until InDesign 4.0. Both values must be kept in sync for proper interchange with Distiller's edits to .joboptions files.

Parameters

selector	value. See kExportPDFDestProfile... values.
name	of the profile. This value is ignored if using a selector other than kExportPDFDestProfileUseName. The effective profile is set instead.

virtual void IPDFExportPrefs::SetPresetFilename ( PMString const & filename )

pure virtual

Set the associated preset filename without path or extension information. Internal use only!

Parameters

filename is the filename to use.

virtual void IPDFExportPrefs::SetProgress ( RangeProgressBar * pProgress )

pure virtual

Set the progress bar to use.

Parameters

pProgress is the progress bar.

virtual void IPDFExportPrefs::SetSinglePagesPDFSuffix ( PMString singlePagesSuffix )

pure virtual

Sets the suffix to be used in PDF file names when exporting single pages PDF.

Parameters

singlePagesSuffix PMString.

virtual void IPDFExportPrefs::SetTranslatedDescription	(	const PMString &	desc,
		int32	langid
	)

pure virtual

Set the description string.

Parameters

desc	is the description string.
langid	is the language of the string.

typedef enum { kLanguageENU = 1, kLanguageJPN, kLanguageDEU, kLanguageFRA, kLanguagePTB, kLanguageDAN, kLanguageNLD, kLanguageESP, kLanguageSUO, kLanguageITA, kLanguageNOR, kLanguageSVE, kLanguageCHS, kLanguageCHT, kLanguageKOR } LanguageID;

virtual void IPDFExportPrefs::SetUIName ( PMString const & name )

pure virtual

Set the UI name for these preferences.

Parameters

name	of these preferences.

virtual void IPDFExportPrefs::SetUseDocumentBleed ( bool32 documentBleed )

pure virtual

Set the use document bleed preference.

Parameters

documentBleed is true to use the document bleed values.

virtual void IPDFExportPrefs::SetVisibleGuidesGrids ( bool32 checked )

pure virtual

Set include visible guides and grids preference.

Parameters

checked is true to include visible guides and grids in the PDF.

virtual ErrorCode IPDFExportPrefs::WriteJobOptionsDataToDisk ( const IDFile & presetFile )

pure virtual

Write a PDF preset file using current preferences.

Parameters

presetFile is the preset file to write.

Returns: kSuccess when successful.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation