IEPubExportPrefs Class Reference

Inheritance diagram for IEPubExportPrefs:

Public Types
enum	{ kDefaultIID = IID_IEPUBEXPORTPREFS }

Public Member Functions
virtual HTMLExport::EBookFormat	GetEBookFormat () const =0
virtual void	SetEBookFormat (HTMLExport::EBookFormat format)=0
virtual HTMLExport::EBookCover	GetEBookCoverOption () const =0
virtual void	SetEBookCoverOption (HTMLExport::EBookCover option)=0
virtual PMString	GetCoverImage () const =0
virtual void	SetCoverImage (const PMString &image)=0
virtual PMString	GetTOCStyleName () const =0
virtual void	SetTOCStyleName (const PMString &name)=0
virtual PMReal	GetMarginLeft () const =0
virtual void	SetMarginLeft (const PMReal &left)=0
virtual PMReal	GetMarginRight () const =0
virtual void	SetMarginRight (const PMReal &right)=0
virtual PMReal	GetMarginTop () const =0
virtual void	SetMarginTop (const PMReal &top)=0
virtual PMReal	GetMarginBottom () const =0
virtual void	SetMarginBottom (const PMReal &bottom)=0
virtual HTMLExport::ExportOrder	GetExportOrder () const =0
virtual void	SetExportOrder (HTMLExport::ExportOrder order)=0
virtual bool16	GetFootnoteAfterPara () const =0
virtual void	SetFootnoteAfterPara (bool16 ft)=0
virtual bool16	GetRemoveSoftReturn () const =0
virtual void	SetRemoveSoftReturn (bool16 sr)=0
virtual HTMLExport::BulletOption	GetBulletOption () const =0
virtual void	SetBulletOption (HTMLExport::BulletOption option)=0
virtual HTMLExport::NumberingOption	GetNumberingOption () const =0
virtual void	SetNumberingOption (HTMLExport::NumberingOption option)=0
virtual bool16	GetLayoutAppearance () const =0
virtual void	SetLayoutAppearance (bool16 layoutFormat)=0
virtual uint32	GetImagePPI () const =0
virtual void	SetImagePPI (uint32 ppi)=0
virtual HTMLExport::ImageSize	GetImageSize () const =0
virtual void	SetImageSize (HTMLExport::ImageSize option)=0
virtual HTMLExport::ImageAlignment	GetImageAlignment () const =0
virtual void	SetImageAlignment (HTMLExport::ImageAlignment align)=0
virtual PMReal	GetImageSpaceBefore () const =0
virtual void	SetImageSpaceBefore (const PMReal &before)=0
virtual PMReal	GetImageSpaceAfter () const =0
virtual void	SetImageSpaceAfter (const PMReal &after)=0
virtual bool16	GetUseImagePageBreak () const =0
virtual void	SetUseImagePageBreak (bool16 use)=0
virtual HTMLExport::PageBreak	GetImagePageBreak () const =0
virtual void	SetImagePageBreak (HTMLExport::PageBreak imageBreak)=0
virtual bool16	GetApplyImageASToAnchoredObject () const =0
virtual void	SetApplyImageASToAnchoredObject (bool16 apply)=0
virtual IXMLExportOptions::ImageType	GetImageType () const =0
virtual void	SetImageType (IXMLExportOptions::ImageType type)=0
virtual IXMLExportOptions::PaletteType	GetGIFPaletteType () const =0
virtual void	SetGIFPaletteType (IXMLExportOptions::PaletteType type)=0
virtual bool16	GetGIFInterlaced () const =0
virtual void	SetGIFInterlaced (bool16 gif)=0
virtual IXMLExportOptions::JPEGEncoding	GetJPEGEncoding () const =0
virtual void	SetJPEGEncoding (IXMLExportOptions::JPEGEncoding encoding)=0
virtual IXMLExportOptions::JPEGQuality	GetJPEGQuality () const =0
virtual void	SetJPEGQuality (IXMLExportOptions::JPEGQuality quality)=0
virtual HTMLExport::SVGExportType	GetSVGExportType () const =0
virtual void	SetSVGExportType (HTMLExport::SVGExportType type)=0
virtual uint32	GetPNGCompression () const =0
virtual void	SetPNGCompression (uint32 compression)=0
virtual bool16	GetIgnorePageitemImageSetting () const =0
virtual void	SetIgnorePageitemImageSetting (bool16 setting)=0
virtual bool16	GetBreakDocument () const =0
virtual void	SetBreakDocument (bool16 chunk)=0
virtual PMString	GetBreakDocParaStyleName () const =0
virtual void	SetBreakDocParaStyleName (const PMString &name)=0
virtual bool16	GetIncludeDocMetadata () const =0
virtual void	SetIncludeDocMetadata (bool16 include)=0
virtual PMString	GetPublisherEntry () const =0
virtual void	SetPublisherEntry (const PMString &entry)=0
virtual PMString	GetMetadataIdentifier () const =0
virtual void	SetMetadataIdentifier (const PMString &uuid)=0
virtual bool16	GetGenerateCSS () const =0
virtual void	SetGenerateCSS (bool16 content)=0
virtual bool16	GetIncludeOverrides () const =0
virtual void	SetIncludeOverrides (bool16 overrides)=0
virtual bool16	GetEmbedFont () const =0
virtual void	SetEmbedFont (bool16 embed)=0
virtual K2Vector< PMString >	GetCascadeStyleSheets () const =0
virtual void	SetCascadeStyleSheets (const K2Vector< PMString > &sheets)=0
virtual K2Vector< PMString >	GetJavascripts () const =0
virtual void	SetJavascripts (const K2Vector< PMString > &scripts)=0
virtual void	Copy (IEPubExportPrefs const *other)=0
virtual HTMLExport::ImageOption	GetImageOption () const =0
virtual void	SetImageOption (HTMLExport::ImageOption option)=0
virtual HTMLExport::FootnotePlacement	GetFootnotePlacement () const =0
virtual void	SetFootnotePlacement (HTMLExport::FootnotePlacement footnotePlacement)=0
virtual PMString	GetMetadataTitle () const =0
virtual void	SetMetadataTitle (const PMString &title)=0
virtual PMString	GetMetadataCreator () const =0
virtual void	SetMetadataCreator (const PMString &creator)=0
virtual PMString	GetMetadataDate () const =0
virtual void	SetMetadataDate (const PMString &date)=0
virtual PMString	GetMetadataDescription () const =0
virtual void	SetMetadataDescription (const PMString &description)=0
virtual PMString	GetMetadataRights () const =0
virtual void	SetMetadataRights (const PMString &rights)=0
virtual PMString	GetMetadataSubject () const =0
virtual void	SetMetadataSubject (const PMString &subject)=0
virtual bool16	GetIncludeClassesInHTML () const =0
virtual void	SetIncludeClassesInHTML (bool16 includeClassesInHTML)=0
virtual PMString	GetMetadataAccessibilityFeature () const =0
virtual void	SetMetadataAccessibilityFeature (const PMString &feature)=0
virtual PMString	GetMetadataAccessibilityHazard () const =0
virtual void	SetMetadataAccessibilityHazard (const PMString &hazard)=0
virtual PMString	GetMetadataAccessibilityMode () const =0
virtual void	SetMetadataAccessibilityMode (const PMString &mode)=0
virtual PMString	GetMetadataAccessibilityModeSufficient () const =0
virtual void	SetMetadataAccessibilityModeSufficient (const PMString &modeSufficient)=0
virtual PMString	GetMetadataAccessibilitySummary () const =0
virtual void	SetMetadataAccessibilitySummary (const PMString &summary)=0
virtual PMString	GetMetadataAccessibilityConformsTo () const =0
virtual void	SetMetadataAccessibilityConformsTo (const PMString &conformTo)=0
virtual PMString	GetMetadataAccessibilityCertifiedBy () const =0
virtual void	SetMetadataAccessibilityCertifiedBy (const PMString &certifiedBy)=0
virtual PMString	GetMetadataAccessibilityCredentials () const =0
virtual void	SetMetadataAccessibilityCredentials (const PMString &credentials)=0
virtual PMString	GetMetadataAccessibilityReportLink () const =0
virtual void	SetMetadataAccessibilityReportLink (const PMString &reportLink)=0
virtual bool16	GetCreatePageNavigation () const =0
virtual void	SetCreatePageNavigation (bool16 enable)=0
virtual PMString	GetCoverAltText () const =0
virtual void	SetCoverAltText (const PMString &coverAltText)=0
virtual PMString	GetPageBreakSourceText () const =0
virtual void	SetPageBreakSourceText (const PMString &sourceText)=0
virtual HTMLExport::EPageBreakSourceType	GetPageBreakSourceType () const =0
virtual void	SetPageBreakSourceType (HTMLExport::EPageBreakSourceType type)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

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

pure virtual

Copies one set of prefs into another

Parameters

other

IN The preferences to copy

virtual bool16 IEPubExportPrefs::GetApplyImageASToAnchoredObject ( ) const

pure virtual

The GetApplyImageASToAnchoredObject and SetApplyImageASToAnchoredObject methods are deprecated now. Apply image space and alignment option to anchored object. This will cause image not exported as inline HTML.

virtual PMString IEPubExportPrefs::GetBreakDocParaStyleName ( ) const

pure virtual

Paragraph style used to split indd document. If style name is empty and split flag is true, use setting on tag mapping panel.

virtual bool16 IEPubExportPrefs::GetBreakDocument ( ) const

pure virtual

Split indd document into multiple html files if true.

virtual HTMLExport::BulletOption IEPubExportPrefs::GetBulletOption ( ) const

pure virtual

Bullet export option. HTML unordered list or convert to text

virtual K2Vector<PMString> IEPubExportPrefs::GetCascadeStyleSheets ( ) const

pure virtual

User specified cascade style sheets.

virtual PMString IEPubExportPrefs::GetCoverAltText ( ) const

pure virtual

EPub alt text for cover image.

virtual PMString IEPubExportPrefs::GetCoverImage ( ) const

pure virtual

EPub cover image. Full path to external cover image file.

virtual bool16 IEPubExportPrefs::GetCreatePageNavigation ( ) const

pure virtual

Enable Page Navigation.

virtual HTMLExport::EBookCover IEPubExportPrefs::GetEBookCoverOption ( ) const

pure virtual

EPub cover option. None, first page, and external image.

virtual HTMLExport::EBookFormat IEPubExportPrefs::GetEBookFormat ( ) const

pure virtual

EPub version. epub2, epub3, and epub3+layout

virtual bool16 IEPubExportPrefs::GetEmbedFont ( ) const

pure virtual

Embed font into epub if true.

virtual HTMLExport::ExportOrder IEPubExportPrefs::GetExportOrder ( ) const

pure virtual

Content order. Layout, XML structure, and article panel.

virtual bool16 IEPubExportPrefs::GetFootnoteAfterPara ( ) const

pure virtual

Export ID footnote after paragraph. Only applied to epub2 and epub3

virtual bool16 IEPubExportPrefs::GetGenerateCSS ( ) const

pure virtual

Generate cascade style sheet

virtual bool16 IEPubExportPrefs::GetIgnorePageitemImageSetting ( ) const

pure virtual

Ignore image export setting specified on pageitem.

virtual HTMLExport::ImageAlignment IEPubExportPrefs::GetImageAlignment ( ) const

pure virtual

Specify image alignment (left/center/right).

virtual HTMLExport::PageBreak IEPubExportPrefs::GetImagePageBreak ( ) const

pure virtual

Page break type for image (before/after/both).

virtual uint32 IEPubExportPrefs::GetImagePPI ( ) const

pure virtual

Specify image PPI (pixel per inch).

virtual HTMLExport::ImageSize IEPubExportPrefs::GetImageSize ( ) const

pure virtual

Specify image size, fixed or relative. Relative is restricted to certain case, eg it won't work if image is in table

virtual PMReal IEPubExportPrefs::GetImageSpaceAfter ( ) const

pure virtual

Space after image in pixel.

virtual PMReal IEPubExportPrefs::GetImageSpaceBefore ( ) const

pure virtual

Space before image in pixel.

virtual IXMLExportOptions::ImageType IEPubExportPrefs::GetImageType ( ) const

pure virtual

Please refer to IXMLExportOptions for detail for following functions.

virtual bool16 IEPubExportPrefs::GetIncludeClassesInHTML ( ) const

pure virtual

For excluding class & id names, as well as remove extra div containers while exporting HTML and Reflowable EPUB, corresponding to the "Don't Include Classes in HTML" check in HTML and EBook Export

virtual bool16 IEPubExportPrefs::GetIncludeDocMetadata ( ) const

pure virtual

If true, use metadata stored in indd file to generate epub opf.

virtual bool16 IEPubExportPrefs::GetIncludeOverrides ( ) const

pure virtual

Generate CSS for text formatting applied as override.

virtual K2Vector<PMString> IEPubExportPrefs::GetJavascripts ( ) const

pure virtual

User specified javascript (epub3 only).

virtual bool16 IEPubExportPrefs::GetLayoutAppearance ( ) const

pure virtual

Keep image appearance in layout.

virtual PMReal IEPubExportPrefs::GetMarginLeft ( ) const

pure virtual

EPub margin. Unit is pixels.

virtual PMString IEPubExportPrefs::GetMetadataAccessibilityCertifiedBy ( ) const

pure virtual

User specified metadata's accessibility certifier of the EPub.

virtual PMString IEPubExportPrefs::GetMetadataAccessibilityConformsTo ( ) const

pure virtual

User specified metadata's accessibility standard it conforms to of the EPub.

virtual PMString IEPubExportPrefs::GetMetadataAccessibilityCredentials ( ) const

pure virtual

User specified metadata's accessibility credentials of the EPub.

virtual PMString IEPubExportPrefs::GetMetadataAccessibilityFeature ( ) const

pure virtual

User specified metadata's accessibility feature of the EPub (this is a list of comma separated values).

virtual PMString IEPubExportPrefs::GetMetadataAccessibilityHazard ( ) const

pure virtual

User specified metadata's accessibility hazards of the EPub (this is a list of comma separated values).

virtual PMString IEPubExportPrefs::GetMetadataAccessibilityMode ( ) const

pure virtual

User specified metadata's accessibility mode of the EPub (this is a list of comma separated values).

virtual PMString IEPubExportPrefs::GetMetadataAccessibilityModeSufficient ( ) const

pure virtual

User specified metadata's accessibility mode sufficient of the EPub (this is a list of comma separated values).

virtual PMString IEPubExportPrefs::GetMetadataAccessibilityReportLink ( ) const

pure virtual

User specified metadata's accessibility certifier report link of the EPub.

virtual PMString IEPubExportPrefs::GetMetadataAccessibilitySummary ( ) const

pure virtual

User specified metadata's accessibility summary of the EPub.

virtual PMString IEPubExportPrefs::GetMetadataCreator ( ) const

pure virtual

User specified creator of the epub. If not specified by user, taken from XMP (if available).

virtual PMString IEPubExportPrefs::GetMetadataDate ( ) const

pure virtual

User specified date of the epub.

virtual PMString IEPubExportPrefs::GetMetadataDescription ( ) const

pure virtual

User specified description of the epub. If not specified by user, taken from XMP (if available).

virtual PMString IEPubExportPrefs::GetMetadataIdentifier ( ) const

pure virtual

Specify epub uuid.

virtual PMString IEPubExportPrefs::GetMetadataRights ( ) const

pure virtual

User specified rights of the epub. If not specified by user, taken from XMP (if available).

virtual PMString IEPubExportPrefs::GetMetadataSubject ( ) const

pure virtual

User specified subject of the epub. If not specified by user, taken from XMP (if available).

virtual PMString IEPubExportPrefs::GetMetadataTitle ( ) const

pure virtual

User specified title of the epub. If not specified by user, taken from XMP (if available).

virtual HTMLExport::NumberingOption IEPubExportPrefs::GetNumberingOption ( ) const

pure virtual

Numbering export option. HTML ordered list or convert to text

virtual PMString IEPubExportPrefs::GetPageBreakSourceText ( ) const

pure virtual

EPub page break source of page navigation.

virtual HTMLExport::EPageBreakSourceType IEPubExportPrefs::GetPageBreakSourceType ( ) const

pure virtual

Set page break source type

virtual uint32 IEPubExportPrefs::GetPNGCompression ( ) const

pure virtual

PNG compression level. Not exposed via UI. Internally set to 5.

virtual PMString IEPubExportPrefs::GetPublisherEntry ( ) const

pure virtual

Specify epub publisher.

virtual bool16 IEPubExportPrefs::GetRemoveSoftReturn ( ) const

pure virtual

Strip soft return. If not, soft return convert to

virtual PMString IEPubExportPrefs::GetTOCStyleName ( ) const

pure virtual

InDesign TOC style used in generating EPub TOC.

virtual bool16 IEPubExportPrefs::GetUseImagePageBreak ( ) const

pure virtual

Apply page break to image if true.