Facade::IInteractivePDF_ExportFacade Class Reference

#include <IInteractivePDFExportFacade.h>

Inheritance diagram for Facade::IInteractivePDF_ExportFacade:

Public Types
enum	{ kDefaultIID = IID_IINTERACTIVEPDFEXPORTFACADE }

Public Member Functions
virtual void	GetPageRangeInfo (PMString &pageRange, IPageRange::RangeFormat &pageRangeFormat) const =0
virtual void	GetPageRangeInfo (IPageRange *iPageRange) const =0
virtual bool	ReadersSpreads () const =0
virtual bool	ViewAfterExport () const =0
virtual bool	EmbedPageThumbnails () const =0
virtual bool	CreateAcrobatLayers () const =0
virtual bool	CreateTaggedPDF () const =0
virtual IInteractivePDFExportPrefs::Magnification	ExportMagnification () const =0
virtual IInteractivePDFExportPrefs::PageLayout	ExportPageLayout () const =0
virtual bool	OpenInFullScreenMode () const =0
virtual bool	FlipPages () const =0
virtual uint32	FlipPagesSpeed () const =0
virtual ClassID	PageTransitionOverride () const =0
virtual IInteractivePDFExportPrefs::InteractiveElements	GetInteractiveElements () const =0
virtual IInteractivePDFExportPrefs::RasterCompression	GetRasterCompression () const =0
virtual IInteractivePDFExportPrefs::JPEGQuality	GetJPEGQuality () const =0
virtual uint32	RasterResolution () const =0
virtual void	GetWorkspaceSecurityPreferences (IPDFSecurityPrefs *iSecurityPrefsData) const =0
virtual ErrorCode	SetWorkspaceSecurityPreferences (IPDFSecurityPrefs *iSecurityPrefsData)=0
virtual void	GetWorkspacePreferences (IInteractivePDFExportPrefs *iPrefsData) const =0
virtual ErrorCode	SetWorkspacePreferences (IInteractivePDFExportPrefs *iPrefsData, IPageRange *iPageRangeData)=0
virtual bool16	GetUsePDFStructureForTabs () const =0
virtual IInteractivePDFExportPrefs::DisplayTitle	GetDisplayTitle () const =0
virtual PMString	GetDefaultDocumentLanguage () const =0
virtual bool16	GetExportSinglePagesPDF () const =0
virtual PMString	GetSinglePagesPDFSuffix () const =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

This facade provides services for obtaining and modifying the preference settings for Interactive PDF export that is new to InDesign CS5. The preference is on the application workspace boss and the main interfaces in the preference are:

See Also

IInteractivePDFExportPreferences

IPDFSecurityPrefs

IPageRange

Member Function Documentation

virtual bool Facade::IInteractivePDF_ExportFacade::CreateAcrobatLayers ( ) const

pure virtual

Gets whether to create Acrobat layers in the interactive PDF.

Returns

kTrue if creating Acrobat layers.

virtual bool Facade::IInteractivePDF_ExportFacade::CreateTaggedPDF ( ) const

pure virtual

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

Returns

kTrue if creating PDF tags.

virtual bool Facade::IInteractivePDF_ExportFacade::EmbedPageThumbnails ( ) const

pure virtual

Gets whether to embed page thumbnails in the interactive PDF.

Returns

kTrue if embedding page thumnails.

virtual IInteractivePDFExportPrefs::Magnification Facade::IInteractivePDF_ExportFacade::ExportMagnification ( ) const

pure virtual

Gets the magnification setting for the exported PDF.

Returns

one of the Magnification enum defined in IInteractivePDFExportPrefs.

virtual IInteractivePDFExportPrefs::PageLayout Facade::IInteractivePDF_ExportFacade::ExportPageLayout ( ) const

pure virtual

Gets the page layout of the exported PDF.

Returns

one of the PageLayout enum defined in IInteractivePDFExportPrefs.

virtual bool Facade::IInteractivePDF_ExportFacade::FlipPages ( ) const

pure virtual

Gets whether to automatically flip pages in the exported PDF.

Returns

kTrue if flip pages is turned on.

virtual uint32 Facade::IInteractivePDF_ExportFacade::FlipPagesSpeed ( ) const

pure virtual

If FlipPages() is true, this returns the speed (in seconds) that the pages are flipped.

Returns

uint32 the flip pages speed (in seconds).

virtual PMString Facade::IInteractivePDF_ExportFacade::GetDefaultDocumentLanguage ( ) const

pure virtual

Gets the default document language of the exported PDF.

virtual IInteractivePDFExportPrefs::DisplayTitle Facade::IInteractivePDF_ExportFacade::GetDisplayTitle ( ) const

pure virtual

Gets the display title option of the exported PDF.

Returns

one of the DisplayTitle enum defined in IInteractivePDFExportPrefs.

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

pure virtual

Gets whether to export each page of the document as a single pages PDF.

virtual IInteractivePDFExportPrefs::InteractiveElements Facade::IInteractivePDF_ExportFacade::GetInteractiveElements ( ) const

pure virtual

Gets how interactive elements in the document are drawn to the interactive PDF. The choices are either Include All or Appearance Only.

Returns

One of the InteractiveElements enum defined in IInteractivePDFExportPrefs.

virtual IInteractivePDFExportPrefs::JPEGQuality Facade::IInteractivePDF_ExportFacade::GetJPEGQuality ( ) const

pure virtual

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

Returns

One of the JPEGQuality enum defined in IInteractivePDFExportPrefs.

virtual void Facade::IInteractivePDF_ExportFacade::GetPageRangeInfo ( PMString &  pageRange, IPageRange::RangeFormat &  pageRangeFormat  ) const

pure virtual

Gets the page range information from the session preferences.

Parameters

pageRange	[OUT]: contains string of page range.
pageRangeFormat	[OUT]: contains enum value of page range format.

virtual void Facade::IInteractivePDF_ExportFacade::GetPageRangeInfo ( IPageRange *  iPageRange ) const

pure virtual

Gets the page range information from the session preferences.

Parameters

iPageRange

[OUT]: contains the page range info.

virtual IInteractivePDFExportPrefs::RasterCompression Facade::IInteractivePDF_ExportFacade::GetRasterCompression ( ) const

pure virtual

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

Returns

One of the RasterCompression enum defined in IInteractivePDFExportPrefs.

virtual PMString Facade::IInteractivePDF_ExportFacade::GetSinglePagesPDFSuffix ( ) const

pure virtual

Gets the suffix to be used in exported PDF file's name if document is exported as single pages PDF.

virtual bool16 Facade::IInteractivePDF_ExportFacade::GetUsePDFStructureForTabs ( ) const

pure virtual

Gets whether to use tagged PDF structure for ordering tabs.

Returns

kTrue if using PDF structure for tab order.

virtual void Facade::IInteractivePDF_ExportFacade::GetWorkspacePreferences ( IInteractivePDFExportPrefs *  iPrefsData ) const

pure virtual

Gets the interactive PDF session workspace preferences.

Parameters

iPrefsData

[OUT]: the IInteractivePDFExportPreferences interface contains InteractivePDF export preferences.

virtual void Facade::IInteractivePDF_ExportFacade::GetWorkspaceSecurityPreferences ( IPDFSecurityPrefs *  iSecurityPrefsData ) const

pure virtual

Gets the PDF export security session workspace preferences.

Parameters

iSecurityPrefsData

[OUT]: the IPDFSecurityPrefs interface contains PDF export security preferences.

virtual bool Facade::IInteractivePDF_ExportFacade::OpenInFullScreenMode ( ) const

pure virtual

Gets whether to open the exported PDF in full screen mode.

Returns

kTrue if opening in full screen mode.

virtual ClassID Facade::IInteractivePDF_ExportFacade::PageTransitionOverride ( ) const

pure virtual

Returns the ClassID of an IPageTransition, if one is selected as an override. If this returns kPageTransitionFromDocument the page transitions will honor the page transition that is set on the spread. kInvalidClass means no page transition.

Returns

ClassID the page transition, kInvalidClass if none selected, kPageTransitionFromDocument if not overridden.

See Also

IPageTransition

IPageTransitionFacade

virtual uint32 Facade::IInteractivePDF_ExportFacade::RasterResolution ( ) const

pure virtual

Get the raster resolution used for raster data.

Returns

uint32 raster resolution (in ppi).

virtual bool Facade::IInteractivePDF_ExportFacade::ReadersSpreads ( ) const

pure virtual

Gets whether to export as reader's spreads.

Returns

kTrue if exporting as reader's spreads; otherwise kFalse.

virtual ErrorCode Facade::IInteractivePDF_ExportFacade::SetWorkspacePreferences ( IInteractivePDFExportPrefs *  iPrefsData, IPageRange *  iPageRangeData  )

pure virtual

Set the InteractivePDF export preferences for the session workspace.

Parameters

iPrefsData	[IN]: The InteractivePDF general preference data where we use for setting export preferences.
iPageRangeData	[IN]: The page preference data where we use for setting export preferences.

virtual ErrorCode Facade::IInteractivePDF_ExportFacade::SetWorkspaceSecurityPreferences ( IPDFSecurityPrefs *  iSecurityPrefsData )

pure virtual

Set the PDF export security preferences for the session workspace.

Parameters

iSecurityPrefsData

[IN]: The PDF security preference data to save in the session preferences.

virtual bool Facade::IInteractivePDF_ExportFacade::ViewAfterExport ( ) const

pure virtual

Gets whether to view generated interactive PDF after export.

Returns

kTrue if view after export.