IDigitalPublishingFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Systems Inc.
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================


#ifndef __IDigitalPublishingFacade_h__
#define __IDigitalPublishingFacade_h__

#include "DigitalPublishingID.h"

#include "IDTime.h"
#include "MiniFolioOptions.h"
#include "Utils.h"

class IDocument;

#include <boost/shared_ptr.hpp>

namespace id_digpub
{

class Object;
typedef boost::shared_ptr<Object> ObjectPtr;

}

class DigitalPublishingFolio;

class DigitalPublishingMetadata;

typedef IDTime DigitalPublishingDateTime;

namespace Facade
{
 class IDigitalPublishingFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_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;

 static inline ErrorCode SetMetadataArticleHideFromTOC(DigitalPublishingMetadata *metadata, bool16 hideFromTOC)
 {
 Utils<Facade::IDigitalPublishingFacade> dpFacade;
 ASSERT(dpFacade);

 return dpFacade->AddMetadataKeyValue( metadata,
 WideString("hideFromTOC"),
 WideString(hideFromTOC ? "true" : "false")
 );
 }

 static inline ErrorCode SetMetadataArticleIntent(DigitalPublishingMetadata *metadata, WideString const &intent)
 {
 Utils<Facade::IDigitalPublishingFacade> dpFacade;
 ASSERT(dpFacade);

 return dpFacade->AddMetadataKeyValue( metadata,
 WideString("intent"),
 intent
 );
 }

 static inline ErrorCode SetMetadataArticleSection(DigitalPublishingMetadata *metadata, WideString const &section)
 {
 Utils<Facade::IDigitalPublishingFacade> dpFacade;
 ASSERT(dpFacade);

 return dpFacade->AddMetadataKeyValue( metadata,
 WideString("section"),
 section
 );
 }

 static inline ErrorCode SetMetadataArticleIsTrustedContent(DigitalPublishingMetadata *metadata, bool16 isTrustedContent)
 {
 Utils<Facade::IDigitalPublishingFacade> dpFacade;
 ASSERT(dpFacade);

 return dpFacade->AddMetadataKeyValue( metadata,
 WideString("isTrustedContent"),
 WideString(isTrustedContent ? "true" : "false")
 );
 }

 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;
 
 enum FolioOrientation
 {
 kOrientationAuto = 0x0,
 kOrientationPortrait = 0x1,
 kOrientationLandscape = 0x2,
 kOrientationBoth = kOrientationPortrait | kOrientationLandscape,
 
 kInvalidFolioOrientation = 0xffffffff
 };

 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;

 enum FolioBindingDirection
 {
 kLeftEdgeBinding = 0x0,
 kRightEdgeBinding = 0x1
 };
 
 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;
 
 enum ObjectFormat
 {
 kXMLObjectFormat,
 kBinaryObjectFormat,
 
 kInvalidObjectFormat = 0xffffffff
 };
 
 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;
 };

 class IDigitalPublishingRasterizerFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IDIGITALPUBLISHINGRASTERIZERFACADE };
 
 virtual void GetBoundingBoxForItemsInSpreadCoords(UIDList const &items, PMRect &bounds) const = 0;
 
 virtual ErrorCode RasterizePageitemsToStream(
 UIDList const &items, 
 uint32 width, uint32 height,
 PMRect const *explicitBounds,
 id_digpub::ObjectPtr const &settings,
 IPMStream *out
 ) = 0;
 };

 class IDigitalPublishingVectorExportFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IDIGITALPUBLISHINGVECTOREXPORTFACADE };
 
 virtual ErrorCode ExportPageitemsAsPDF(
 UIDList const &items, 
 UIDList const &pageItemsToSuppress,
 id_digpub::ObjectPtr const &settings,
 id_digpub::ObjectPtr *results,
 IDFile const &out
 ) = 0;
 };
}

#endif