InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
IDigitalPublishingSetupProvider::OverlayCreator Class Referenceabstract

#include <IDigitalPublishingSetupProvider.h>

Public Member Functions

virtual id_digpub::ObjectPtr CreateEmptyOverlayDictionary () const =0
 
virtual ErrorCode CreateOverlay (id_digpub::ObjectPtr const &overlayParams)=0
 

Detailed Description

Interface to be used to create instances of interactive overlays during creation of a folio file.

Note: This is not a standard InDesign interface and does not have AddRef/Release or QueryInterface methods. This implies that instances cannot be safely stored between method invocations.

Member Function Documentation

virtual id_digpub::ObjectPtr IDigitalPublishingSetupProvider::OverlayCreator::CreateEmptyOverlayDictionary () const
pure virtual

Factory method for creating an instance of an empty overlay dictionary. The dictionary should be populated using the Object interface and then passed to CreateOverlay.

Returns
a new instance of an empty dictionary object
virtual ErrorCode IDigitalPublishingSetupProvider::OverlayCreator::CreateOverlay (id_digpub::ObjectPtr const & overlayParams)
pure virtual

Creates a new overlay based on the parameters passed in.

Parameters
overlayParamsA dictionary defining the parameter for the overlay
Returns
an ErrorCode indicating the success/failure of the call