InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPreflightBookRef Class Referenceabstract

#include <IPreflightBookRef.h>

Inheritance diagram for IPreflightBookRef:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPREFLIGHTBOOKREF }
 

Public Member Functions

virtual IPreflightBookDataQueryActivePreflight () const =0
 
virtual void SetActivePreflight (IPreflightBookData *iData)=0
 
virtual IPreflightBookDataCreateActivePreflight ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

When we preflight or package a book we create a book preflight boss. We need some way to associate that boss with the book that 'owns' it, which is the purpose of this interface. It sits on the book itself and maintains the short list of book-preflight bosses. This way we know that when the book is closed we're also going to get rid of any related preflight data.

Member Function Documentation

virtual IPreflightBookData* IPreflightBookRef::CreateActivePreflight ()
pure virtual

Create a new current/active preflight for this book. The existing data is released (and therefore typically deleted since these are nonpersistent bosses). The new interface is initialized with a pointer back to the book but no content data is configured.

Returns
A refcounted preflight book data, which is also the new preflight book data (ie, this is the same interface that would then be returned by QueryActivePreflight).
virtual IPreflightBookData* IPreflightBookRef::QueryActivePreflight () const
pure virtual

Query the current/active preflight for this book. This is the preflight that is created as a consequence of the user requesting preflight for a book.

Returns
The refcounted data interface for the book preflight boss.
virtual void IPreflightBookRef::SetActivePreflight (IPreflightBookDataiData)
pure virtual

Set the current/active preflight for this book. The existing data is released (and therefore typically deleted since these are nonpersistent bosses).

Parameters
Thedata interface for the book-preflight boss. This is refcounted by this method.