Inheritance diagram for IDigitalPublishingSetupProvider2:

Public Types
enum	{ kDefaultIID = IID_IDIGITALPUBLISHINGSETUPPROVIDER2 }

Public Types inherited from IDigitalPublishingSetupProvider
enum	{ kDefaultIID = IID_IDIGITALPUBLISHINGSETUPPROVIDER }

enum	Orientation { kPortraitOrientation, kLandscapeOrientation, kInvalidOrientation = 0xffffffff }

enum	DrawPass { kScrubberDrawPass, kAssetDrawPass, kThumbnailDrawPass, kTOCImageDrawPass, kOverlayCollectionPass, kPDFGenerationPass, kInvalidDrawPass = 0xffffffff }

enum	DrawBehavior { kDrawBehaviorIncludeItem, kDrawBehaviorOmitItem, kDrawBehaviorAbortDrawing, kDrawBehaviorInvalidOption = 0xffffffff }

Public Member Functions
virtual DrawBehavior	HandlePageItemOverlayCollection (IPMUnknown const thisThing, DrawPass pass, OverlayCreator overlayCreator, IPMUnknown *contextData=nil)=0

Public Member Functions inherited from IDigitalPublishingSetupProvider
virtual ErrorCode	BeginFolioCreation ()=0

virtual void	EndFolioCreation (bool folioWasCreated)=0

virtual ErrorCode	BeginOverlayCollection ()=0

virtual void	EndOverlayCollection ()=0

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

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

virtual DrawBehavior	HandlePageItemDraw (IPMUnknown const thisThing, DrawPass pass, OverlayCreator overlayCreator)=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 DrawBehavior IDigitalPublishingSetupProvider2::HandlePageItemOverlayCollection	(	IPMUnknown const *	thisThing,
		DrawPass	pass,
		OverlayCreator *	overlayCreator,
		IPMUnknown *	contextData = `nil`
	)

pure virtual

Called if GetShouldNotifyOnPageItemDraw returned true for the overlay collection pass, indicating that the setup provider wants to hook into the page item drawing pipeline for assets. This will only be called for DrawPass kOverlayCollectionPass pass.

The overlayCreator parameter is set for overlay collection pass.

Parameters

thisThing	The page item being drawn. Use ::GetUIDRef(pageitem) to get the UIDRef this page item. Note that for text, this may not be an UID-based item, so UIDRef may be null.
pass	The current DrawPass. This should be set to kOverlayCollectionPass.
overlayCreator	An instance of an overlay creator that can be used to generate overlay instances for the page, or nil if not supported
contextData	An data interface for the draw event context. NOTE: This is optional and to be used internally only.

Returns: one of the DrawBehavior values indicating how to handle the page item

Public Types

Public Member Functions

Member Function Documentation