IDigitalPublishingSetupProvider.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Systems Inc.
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 1997-2012 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe Systems Incorporated and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe Systems Incorporated and its
// suppliers and may be covered by U.S. and Foreign Patents,
// patents in process, and are protected by trade secret or copyright law.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe Systems Incorporated.
// 
//========================================================================================


#include "DigitalPublishingID.h"

#include "DigitalPublishingDictionary.h"
#include "MiniFolioOptions.h"

class IDocument;

class IDigitalPublishingSetupProvider : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDIGITALPUBLISHINGSETUPPROVIDER };
 
 class OverlayCreator
 {
 public:
 virtual ~OverlayCreator() {}
 
 virtual id_digpub::ObjectPtr CreateEmptyOverlayDictionary() const = 0;
 
 virtual ErrorCode CreateOverlay(id_digpub::ObjectPtr const &overlayParams) = 0;
 };
 
 virtual ErrorCode BeginFolioCreation() = 0;
 
 virtual void EndFolioCreation(bool folioWasCreated) = 0;
 
 virtual ErrorCode BeginOverlayCollection() = 0;
 
 virtual void EndOverlayCollection() = 0;

 enum Orientation
 {
 kPortraitOrientation,
 kLandscapeOrientation,
 
 kInvalidOrientation = 0xffffffff
 };
 
 virtual ErrorCode BeginContentStack(IDocument const *doc, Orientation orientation, const MiniFolioOptions& folioOptions) = 0;
 
 virtual ErrorCode EndContentStack(IDocument const *doc, Orientation orientation) = 0;
 
 virtual ErrorCode BeginPage(
 IDocument const *doc,
 UIDRef const &page,
 uint32 index,
 OverlayCreator *overlayCreator
 ) = 0;
 
 virtual ErrorCode EndPage(
 IDocument const *doc,
 UIDRef const &page,
 uint32 index,
 OverlayCreator *overlayCreator
 ) = 0;
 
 enum DrawPass
 {
 kScrubberDrawPass,
 kAssetDrawPass,
 kThumbnailDrawPass,
 
 // Note: This pass will occur outside the normal BeginPage/EndPage
 // pair of notifications.
 kTOCImageDrawPass,
 
 kOverlayCollectionPass,
 
 kPDFGenerationPass,
 
 kInvalidDrawPass = 0xffffffff
 };
 
 virtual ErrorCode BeginDrawingPass(
 IDocument const *doc,
 UIDRef const &page,
 DrawPass pass
 ) = 0;

 virtual ErrorCode EndDrawingPass(
 IDocument const *doc,
 UIDRef const &page,
 DrawPass pass
 ) = 0;

 virtual bool GetShouldNotifyOnPageItemDraw(DrawPass pass) const = 0;
 
 enum DrawBehavior
 {
 kDrawBehaviorIncludeItem,
 kDrawBehaviorOmitItem,
 kDrawBehaviorAbortDrawing,
 
 kDrawBehaviorInvalidOption = 0xffffffff
 };
 
 virtual DrawBehavior HandlePageItemDraw(
 IPMUnknown const *thisThing,
 DrawPass pass,
 OverlayCreator *overlayCreator
 ) = 0;
};

class IDigitalPublishingSetupProvider2 : public IDigitalPublishingSetupProvider
{
public:
 enum { kDefaultIID = IID_IDIGITALPUBLISHINGSETUPPROVIDER2 }; 

 virtual DrawBehavior HandlePageItemOverlayCollection(
 IPMUnknown const *thisThing,
 DrawPass pass,
 OverlayCreator *overlayCreator,
 IPMUnknown *contextData = nil
 ) = 0;
};

namespace digpub
{

inline InterfacePtr<IDigitalPublishingSetupProvider> QueryIDigitalPublishingSetupProvider(IPMUnknown *boss)
{
 InterfacePtr<IDigitalPublishingSetupProvider> provider(boss, UseDefaultIID());
 
 if (!provider)
 {
 provider = InterfacePtr<IDigitalPublishingSetupProvider2>(boss, UseDefaultIID());
 }
 
 return provider;
}

}