#include <IInteractivePDFExportPrefs.h>

Inheritance diagram for IInteractivePDFExportPrefs:

Public Types
enum	{ kDefaultIID = IID_IINTERACTIVEPDFEXPORTPREFS }

enum	Magnification { kDefaultMagnification = 0, kActualSize, kFitPage, kFitWidth, kFitHeight, kFitVisible, k25percent, k50percent, k75percent, k100percent }

enum	PageLayout { kDefaultPageLayout = 0, kSinglePage, kSinglePageContinuous, kTwoUpFacing, kTwoUpFacingContinuous, kTwoUpCoverPage, kTwoUpCoverPageContinuous }

enum	InteractiveElements { kIncludeAll = 0, kAppearanceOnly }

enum	RasterCompression { kJPEGCompression = 0, kLosslessCompression, kAutomaticCompression }

enum	JPEGQuality { kJPEGQuality_Minimum = 0, kJPEGQuality_Low, kJPEGQuality_Medium, kJPEGQuality_High, kJPEGQuality_Maximum }

enum	DisplayTitle { kFileName = 0, kDocumentTitle }

Public Member Functions
virtual void	Copy (IInteractivePDFExportPrefs const *other)=0

virtual void	SetReadersSpreads (bool16 spreads)=0

virtual bool16	GetReadersSpreads () const =0

virtual void	SetViewAfterExport (bool16 viewAfterExport)=0

virtual bool16	GetViewAfterExport () const =0

virtual void	SetEmbedPageThumbnails (bool16 embedPageThumbnails)=0

virtual bool16	GetEmbedPageThumbnails () const =0

virtual void	SetAcrobatLayers (bool16 acrobatLayers)=0

virtual bool16	GetAcrobatLayers () const =0

virtual void	SetTaggedPDF (bool16 taggedPDF)=0

virtual bool16	GetTaggedPDF () const =0

virtual void	SetMagnification (Magnification magnification)=0

virtual Magnification	GetMagnification () const =0

virtual void	SetPageLayout (PageLayout pageLayout)=0

virtual PageLayout	GetPageLayout () const =0

virtual void	SetOpenInFullScreenMode (bool16 fullScreen)=0

virtual bool16	GetOpenInFullScreenMode () const =0

virtual void	SetFlipPages (bool16 flipPages)=0

virtual bool16	GetFlipPages () const =0

virtual void	SetFlipPagesSpeed (uint32 speed)=0

virtual uint32	GetFlipPagesSpeed () const =0

virtual void	SetPageTransitionOverride (const ClassID &pageTransition)=0

virtual ClassID	GetPageTransitionOverride () const =0

virtual void	SetInteractiveElements (InteractiveElements iElements)=0

virtual InteractiveElements	GetInteractiveElements () const =0

virtual void	SetRasterCompression (RasterCompression compression)=0

virtual RasterCompression	GetRasterCompression () const =0

virtual void	SetJPEGQuality (JPEGQuality quality)=0

virtual JPEGQuality	GetJPEGQuality () const =0

virtual void	SetResolution (uint32 resolution)=0

virtual uint32	GetResolution () const =0

virtual void	SetUsePDFStructureForTabs (bool16 useStructure)=0

virtual bool16	GetUsePDFStructureForTabs () const =0

virtual void	SetDisplayTitle (DisplayTitle title)=0

virtual DisplayTitle	GetDisplayTitle () const =0

virtual void	SetDefaultDocumentLanguage (const PMString &language)=0

virtual PMString	GetDefaultDocumentLanguage () const =0

virtual void	SetExportSinglePagesPDF (bool16 exportSinglePagesPDF)=0

virtual bool16	GetExportSinglePagesPDF () const =0

virtual void	SetSinglePagesPDFSuffix (PMString suffix)=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

Export preferences for interactive PDF exports.

IInteractivePDFExportPrefs is used to configure the parameters for an export to the PDF format specifically targetted to Acrobat 9 and above.

In order to export InDesign content to an interactive PDF, you will typically create an instance of the interactive PDF export command (kInteractivePDFExportCmdBoss), set its IOutputPages interface to the pages to be exported, and set up the output file (ISysFileData) and UI flags (IUIFlagData) to be used. You can then use the IInteractivePDFExportPrefs aggregated on the command boss to set up various parameters for the export, including how to treat raster images, video, etc. There is also an interface off of the command boss to set the security settings for the exported PDF (IPDFSecurityPrefs).

IInteractivePDFExportPrefs is also aggregated on the app workspace, where it is used to ensure that default export settings are preserved from export to export. You might consider using this instance as the base for your export settings. You might also consider using kSetInteractivePDFExportPrefsCmdBoss to update the default export settings for subsequent exports. There is also a facade available (IInteractivePDFExportFacade.h) to assist in retrieving the application workspace settings.

Member Enumeration Documentation

enum IInteractivePDFExportPrefs::DisplayTitle

Display Title - Options for display title.

enum IInteractivePDFExportPrefs::InteractiveElements

Button and Media

enum IInteractivePDFExportPrefs::JPEGQuality

JPEGQuality - JPEG quality

enum IInteractivePDFExportPrefs::Magnification

Magnification - Options for magnification

enum IInteractivePDFExportPrefs::PageLayout

Page Layout - Options for page layout

enum IInteractivePDFExportPrefs::RasterCompression

RasterCompression - Compression for rasters

Member Function Documentation

virtual void IInteractivePDFExportPrefs::Copy ( IInteractivePDFExportPrefs const * other )

pure virtual

Copies one set of prefs into another

Parameters

other IN The preferences to copy

virtual bool16 IInteractivePDFExportPrefs::GetAcrobatLayers ( ) const

pure virtual

Gets whether to create Acrobat layers in the PDF.

Returns: kTrue if creating Acrobat layers.

virtual PMString IInteractivePDFExportPrefs::GetDefaultDocumentLanguage ( ) const

pure virtual

Gets the default document language for the PDF being exported.

virtual DisplayTitle IInteractivePDFExportPrefs::GetDisplayTitle ( ) const

pure virtual

Gets the display title for the PDF being exported.

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

virtual bool16 IInteractivePDFExportPrefs::GetEmbedPageThumbnails ( ) const

pure virtual

Gets whether to embed page thumbnails in the exported PDF file.

Returns: kTrue if page thumbnails are to be embedded.

virtual bool16 IInteractivePDFExportPrefs::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 bool16 IInteractivePDFExportPrefs::GetExportSinglePagesPDF ( ) const

pure virtual

Gets the exportSinglePagesPDF preference.

virtual bool16 IInteractivePDFExportPrefs::GetFlipPages ( ) const

pure virtual

Gets whether to automatically flip pages in the PDF.

Returns: kTrue if pages will automatically flip.

virtual uint32 IInteractivePDFExportPrefs::GetFlipPagesSpeed ( ) const

pure virtual

Gets the flip pages speed, in seconds.

Returns: the flip pages speed, in seconds.

virtual InteractiveElements IInteractivePDFExportPrefs::GetInteractiveElements ( ) const

pure virtual

Gets the setting for how to handle interactive elements such as buttons and media.

Returns: One of the InteractiveElements enum specifying what to do with buttons and media

virtual JPEGQuality IInteractivePDFExportPrefs::GetJPEGQuality ( ) const

pure virtual

Gets the quality to be used for JPEG compressed images during the export.

Returns: One of the JPEGQuality enum

virtual Magnification IInteractivePDFExportPrefs::GetMagnification ( ) const

pure virtual

Gets the initial magnification setting.

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

virtual bool16 IInteractivePDFExportPrefs::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 PageLayout IInteractivePDFExportPrefs::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 ClassID IInteractivePDFExportPrefs::GetPageTransitionOverride ( ) const

pure virtual

Gets the page transition ClassID that will be used for all pages exported, overriding any page transition on a spread. If the ClassID is kInvalidClass then no page transition will be used. If the ClassID is kPageTransitionFromDocument, the spread's page transition will be used.

Returns: ClassID of the page transition.

See Also: IPageTransitionFacade; IPageTransition

virtual RasterCompression IInteractivePDFExportPrefs::GetRasterCompression ( ) const

pure virtual

Gets the preferred raster compression to be used for the export.

Returns: One of the RasterCompression enum specifying the preferred raster compression

virtual bool16 IInteractivePDFExportPrefs::GetReadersSpreads ( ) const

pure virtual

Gets whether to export as reader's spreads.

Returns: kTrue if exporting as reader's spreads; otherwise kFalse

virtual uint32 IInteractivePDFExportPrefs::GetResolution ( ) const

pure virtual

Gets the resolution to use for the PDF export, in pixels per inch.

Returns: The resolution to use (ppi).

virtual PMString IInteractivePDFExportPrefs::GetSinglePagesPDFSuffix ( ) const

pure virtual

Gets single pages PDF suffix to be used at the end of filename.

virtual bool16 IInteractivePDFExportPrefs::GetTaggedPDF ( ) const

pure virtual

Gets whether to create a tagged (structured) interactive PDF.

Returns: kTrue if creating tagged PDF.

virtual bool16 IInteractivePDFExportPrefs::GetUsePDFStructureForTabs ( ) const

pure virtual

Gets whether to use tagged PDF structure for ordering tabs.

Returns: kTrue if using PDF structure for tab order.

virtual bool16 IInteractivePDFExportPrefs::GetViewAfterExport ( ) const

pure virtual

Gets whether to view the generated PDF file after exporting.

Returns: kTrue if viewing the generated PDF file after exporting.

virtual void IInteractivePDFExportPrefs::SetAcrobatLayers ( bool16 acrobatLayers )

pure virtual

Sets whether to create Acrobat layers in the PDF.

Parameters

acrobatLayers Boolean. If kTrue, create Acrobat layers.

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

pure virtual

Sets the default document language for the PDF being exported.

virtual void IInteractivePDFExportPrefs::SetDisplayTitle ( DisplayTitle title )

pure virtual

Sets the display title for the PDF being exported.

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

virtual void IInteractivePDFExportPrefs::SetEmbedPageThumbnails ( bool16 embedPageThumbnails )

pure virtual

Sets whether to embed page thumbnails in the exported PDF file.

Parameters

embedPageThumbnails Boolean. If kTrue, page thumbnails are embedded.

virtual void IInteractivePDFExportPrefs::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 IInteractivePDFExportPrefs::SetExportSinglePagesPDF ( bool16 exportSinglePagesPDF )

pure virtual

Sets whether to export single page PDF or not.

virtual void IInteractivePDFExportPrefs::SetFlipPages ( bool16 flipPages )

pure virtual

Sets whether to automatically flip pages in the PDF. If this is true, the set/get flip pages speed will determine the speed that the pages flip.

Parameters

flipPages Boolean. If kTrue, pages will automatically flip.

virtual void IInteractivePDFExportPrefs::SetFlipPagesSpeed ( uint32 speed )

pure virtual

Sets the flip pages speed, in seconds. If GetFlipPages() is true, the speed that the pages flip is controlled by the flip pages speed setting.

Parameters

speed uint32: the speed that the pages flip, in seconds.

virtual void IInteractivePDFExportPrefs::SetInteractiveElements ( InteractiveElements iElements )

pure virtual

Sets how to handle interactive elements such as buttons and media.

Parameters

iElements,: One of the InteractiveElements enum specifying how to handle buttons and media

virtual void IInteractivePDFExportPrefs::SetJPEGQuality ( JPEGQuality quality )

pure virtual

Sets the quality to be used for JPEG compressed images during the export.

Parameters

quality One of the JPEGQuality enum

virtual void IInteractivePDFExportPrefs::SetMagnification ( Magnification magnification )

pure virtual

Sets the initial magnification when the PDF is opened.

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

virtual void IInteractivePDFExportPrefs::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 IInteractivePDFExportPrefs::SetPageLayout ( PageLayout pageLayout )

pure virtual

Sets the page layout for the PDF being exported.

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

virtual void IInteractivePDFExportPrefs::SetPageTransitionOverride ( const ClassID & pageTransition )

pure virtual

Sets the page transition to use for all pages, overriding any page tranition set on a spread. If the parameter passed is kInvalidClass then no page transition will be used. If the parameter passed is kPageTransitionFromDocument then the spread's page transition will be honored.

Parameters

pageTransition ClassID: the ClassID of the page tranition to use.

See Also: IPageTransitionFacade; IPageTransition

virtual void IInteractivePDFExportPrefs::SetRasterCompression ( RasterCompression compression )

pure virtual

Sets the preferred raster compression to be used for the export. Note that some compression types will be required in certain scenarios and that those will take precedence over the setting specified here. This will be used when no particular compression type is required.

Parameters

compression,: One of the RasterCompression enum specifying the preferred raster compression

virtual void IInteractivePDFExportPrefs::SetReadersSpreads ( bool16 spreads )

pure virtual

Sets whether to export as reader's spreads.

Parameters

spreads Boolean. If kTrue, export as reader's spread; if kFalse, export as pages

virtual void IInteractivePDFExportPrefs::SetResolution ( uint32 resolution )

pure virtual

Sets the resolution to use for the PDF export, in pixels per inch.

Parameters

resolution uint32: The resolution to use (ppi).

virtual void IInteractivePDFExportPrefs::SetSinglePagesPDFSuffix ( PMString suffix )

pure virtual

Sets single pages PDF suffix to be used at the end of filenames.

virtual void IInteractivePDFExportPrefs::SetTaggedPDF ( bool16 taggedPDF )

pure virtual

Sets whether to create a tagged (structured) interactive PDF.

Parameters

taggedPDF Boolean. If kTrue, create structured PDF.

virtual void IInteractivePDFExportPrefs::SetUsePDFStructureForTabs ( bool16 useStructure )

pure virtual

Sets whether to use tagged PDF structure for ordering tabs.

Parameters

useStructure whether to use PDF structure for tab order.

virtual void IInteractivePDFExportPrefs::SetViewAfterExport ( bool16 viewAfterExport )

pure virtual

Sets whether to view the generated PDF file after exporting.

Parameters

viewAfterExport Boolean. If kTrue, view the generated PDF file after exporting.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation