InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IReplaceFPOImage Class Referenceabstract
Inheritance diagram for IReplaceFPOImage:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IREPLACEFPOIMAGE }
 
enum  Mode { kReplaceIfInteract, kReplaceAlways, kNeverReplace, kUnsupportedImage }
 

Public Member Functions

virtual Mode GetReplaceModeForImage (UIDRef const &image) const =0
 
virtual IPMStream * ReplaceFPOImage (UIDRef const &fpoImage)=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 Mode IReplaceFPOImage::GetReplaceModeForImage (UIDRef const & image) const
pure virtual

Asks implementation how given image should be treated. If the impl can handle the specified image, it should return one of kReplaceIfInteract, kReplaceAlways, or kNeverReplace to indicate how the image should be handled. If it cannot handle the specified image, it should return kUnsupportedImage to indicate that another service be given a chance to replace the image

Parameters
imageUIDRef for the image
Returns
a value from the Mode enum
virtual IPMStream* IReplaceFPOImage::ReplaceFPOImage (UIDRef const & fpoImage)
pure virtual

Queries for the replacement IPMStream for the specified image. This will be called if the impl previously indicated that it wanted to replace the given image (by returning either kReplaceIfInteract or kReplaceAlways)

If an error occurs, the impl should return a nil interface. This will abort the print/export operation.

Parameters
fpoImageUIDRef for the FPO image. The service should use this to identify the image to be replaced.
Returns
an addref'd pointer to an IPMStream interface, or nil if an error occurs