Facade::IDigitalPublishingFacade2 Class Reference

Inheritance diagram for Facade::IDigitalPublishingFacade2:

Public Types
enum	{ kDefaultIID = IID_IDIGITALPUBLISHINGFACADE2 }
Public Types inherited from Facade::IDigitalPublishingFacade
enum	{ kDefaultIID = IID_IDIGITALPUBLISHINGFACADE }
enum	FolioOrientation {   kOrientationAuto = 0x0, kOrientationPortrait = 0x1, kOrientationLandscape = 0x2, kOrientationBoth = kOrientationPortrait | kOrientationLandscape,   kInvalidFolioOrientation = 0xffffffff }
enum	FolioBindingDirection { kLeftEdgeBinding = 0x0, kRightEdgeBinding = 0x1 }
enum	ObjectFormat { kXMLObjectFormat, kBinaryObjectFormat, kInvalidObjectFormat = 0xffffffff }

Public Member Functions
virtual id_digpub::ObjectPtr	GetDigitalPublishingVersion () const =0
virtual ErrorCode	GetAllOverlays (IDocument const *portrait, IDocument const *landscape, id_digpub::ObjectPtr const &options, id_digpub::ObjectPtr &overlayDict) const =0
virtual ErrorCode	CreateArticleFolio (IDocument const *portrait, IDocument const *landscape, id_digpub::ObjectPtr const &options, DigitalPublishingMetadata const *metadata, IDFile const &folioFile) const =0
virtual ErrorCode	AddDocumentPairToMagazineFolio (DigitalPublishingFolio *folio, IDocument const *portrait, IDocument const *landscape, id_digpub::ObjectPtr const &options, DigitalPublishingMetadata const *metadata) const =0
Public Member Functions inherited from Facade::IDigitalPublishingFacade
virtual DigitalPublishingMetadata *	CreateMetadata () const =0
virtual ErrorCode	SetMetadataDate (DigitalPublishingMetadata *metadata, DigitalPublishingDateTime const &date) const =0
virtual ErrorCode	SetMetadataUpdateDate (DigitalPublishingMetadata *metadata, DigitalPublishingDateTime const &date) const =0
virtual ErrorCode	SetMetadataFolioNumber (DigitalPublishingMetadata *metadata, WideString const &number) const =0
virtual ErrorCode	SetMetadataMagazineTitle (DigitalPublishingMetadata *metadata, WideString const &title) const =0
virtual ErrorCode	SetMetadataDescription (DigitalPublishingMetadata *metadata, WideString const &desc) const =0
virtual ErrorCode	SetMetadataCategory (DigitalPublishingMetadata *metadata, WideString const &category) const =0
virtual ErrorCode	SetMetadataArticleTitle (DigitalPublishingMetadata *metadata, WideString const &title) const =0
virtual ErrorCode	SetMetadataArticleAuthor (DigitalPublishingMetadata *metadata, WideString const &author) const =0
virtual ErrorCode	SetMetadataArticleKicker (DigitalPublishingMetadata *metadata, WideString const &kicker) const =0
virtual ErrorCode	SetMetadataArticleIsAdvertisement (DigitalPublishingMetadata *metadata, bool16 isAd) const =0
virtual ErrorCode	SetMetadataArticleTags (DigitalPublishingMetadata *metadata, K2Vector< WideString > const &tags) const =0
virtual ErrorCode	AddMetadataKeyValue (DigitalPublishingMetadata *metadata, WideString const &key, WideString const &value) const =0
virtual bool16	GetMetadataValueForKey (DigitalPublishingMetadata *metadata, WideString const &key, WideString &value) const =0
virtual void	DisposeMetadata (DigitalPublishingMetadata *metadata) const =0
virtual ErrorCode	CreateMiniFolio (IDocument const *portrait, IDocument const *landscape, MiniFolioOptions const &options, DigitalPublishingMetadata const *metadata, IDFile const &folioFile) const =0
virtual DigitalPublishingFolio *	CreateFolio () const =0
virtual ErrorCode	SetFolioMetadata (DigitalPublishingFolio *folio, DigitalPublishingMetadata const *metadata) const =0
virtual ErrorCode	SetFolioOrientation (DigitalPublishingFolio *folio, FolioOrientation orientation=kOrientationBoth) const =0
virtual ErrorCode	SetFolioTargetDimensions (DigitalPublishingFolio *folio, uint32 wideDimension, uint32 narrowDimension) const =0
virtual ErrorCode	SetContentStackIDMap (DigitalPublishingFolio *folio, id_digpub::ObjectPtr const &contentStackIDMap) const =0
virtual ErrorCode	AddDirectoryToFolio (DigitalPublishingFolio *folio, IDFile const &directory) const =0
virtual ErrorCode	SetFolioBindingDirection (DigitalPublishingFolio *folio, FolioBindingDirection direction) const =0
virtual ErrorCode	AddMiniFolioToFolio (DigitalPublishingFolio *folio, IDFile const &miniFolio) const =0
virtual ErrorCode	AddDocumentPairToFolio (DigitalPublishingFolio *folio, IDocument const *portrait, IDocument const *landscape, MiniFolioOptions const &options, DigitalPublishingMetadata const *metadata) const =0
virtual ErrorCode	ExportFolioToPackage (DigitalPublishingFolio *folio, IDFile const &packageFile) const =0
virtual ErrorCode	ExportFolioToDirectory (DigitalPublishingFolio *folio, IDFile const &manifestFile, IDPath const &articleDirectory) const =0
virtual ErrorCode	ExportFolioToDirectoryPackage (DigitalPublishingFolio *folio, IDFile const &packageFile) const =0
virtual void	DisposeFolio (DigitalPublishingFolio *folio) const =0
virtual id_digpub::ObjectPtr	CreateEmptyDictionary () const =0
virtual bool	WriteDigPubObjectToStream (id_digpub::ObjectPtr const &obj, IPMStream *s, ObjectFormat format=kBinaryObjectFormat) const =0
virtual bool	ReadDigPubObjectFromStream (id_digpub::ObjectPtr &obj, IPMStream *s, ObjectFormat format=kInvalidObjectFormat) 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

Additional Inherited Members
Static Public Member Functions inherited from Facade::IDigitalPublishingFacade
static ErrorCode	SetMetadataArticleHideFromTOC (DigitalPublishingMetadata *metadata, bool16 hideFromTOC)
static ErrorCode	SetMetadataArticleIntent (DigitalPublishingMetadata *metadata, WideString const &intent)
static ErrorCode	SetMetadataArticleSection (DigitalPublishingMetadata *metadata, WideString const &section)
static ErrorCode	SetMetadataArticleIsTrustedContent (DigitalPublishingMetadata *metadata, bool16 isTrustedContent)

Member Function Documentation

virtual ErrorCode Facade::IDigitalPublishingFacade2::AddDocumentPairToMagazineFolio ( DigitalPublishingFolio *  folio, IDocument const *  portrait, IDocument const *  landscape, id_digpub::ObjectPtr const &  options, DigitalPublishingMetadata const *  metadata  ) const

pure virtual

Adds a pair of documents, assumed to represent a single article in its two orientations, to a folio.

Parameters

folio	The folio the pair of documents will be added to
portrait	The document representing the folio's portrait orientation
landscape	The document representing the folio's landscape orientation
options	The options to use while creating the folio file
metadata	The metadata to associate with the article

Returns

an ErrorCode indicating whether the call succeeded

virtual ErrorCode Facade::IDigitalPublishingFacade2::CreateArticleFolio ( IDocument const *  portrait, IDocument const *  landscape, id_digpub::ObjectPtr const &  options, DigitalPublishingMetadata const *  metadata, IDFile const &  folioFile  ) const

pure virtual

Creates a 'mini' folio for a pair of InDesign documents, using the specified options

Parameters

portrait	The document representing the folio's portrait orientation
landscape	The document representing the folio's landscape orientation
options	The options to use while creating the folio file
metadata	The metadata to associate with the folio
folioFile	The location in which to create the folio file
return	an ErrorCode describing the status of the call

virtual ErrorCode Facade::IDigitalPublishingFacade2::GetAllOverlays ( IDocument const *  portrait, IDocument const *  landscape, id_digpub::ObjectPtr const &  options, id_digpub::ObjectPtr &  overlayDict  ) const

pure virtual

Returns the list of overlays contained in a pair of InDesign documents, using the specified options.

Parameters

portrait	The document representing the folio's portrait orientation
landscape	The document representing the folio's landscape orientation
options	The options to use while creating the folio file
overlayDict	[OUT] On successful exit, an array of dictionaries describing the identified overlays
return	an ErrorCode describing the status of the call

virtual id_digpub::ObjectPtr Facade::IDigitalPublishingFacade2::GetDigitalPublishingVersion ( ) const

pure virtual

Returns a dictionary object containing version information about the Digital Publishing plug-in version. The dictionary will have the following key/values:

Key Value PlugInVersion: array of integers representing [InDesign major version, InDesign minor version, DPS plug-in minor version, Sprint version]

FolioVersion: array of integers representing [Folio major version, Folio minor version, Folio revision]

PListVersion: array of integers representing [PList major version, PList minor version, PList revision]

SupportedViewerVersions: array of supported viewer version strings. The strings are in the form "Viewer major version.Viewer minor version.Viewer revision"

Returns

the version information for the DPS plug-in as a dictionary