#include <IPreflightBookUtils.h>

Inheritance diagram for IPreflightBookUtils:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTBOOKUTILS }

Public Member Functions
virtual IPreflightBookData *	QueryActivePreflight (IBook *iBook) const =0

virtual IPreflightBookData *	QueryActivePreflight (IDataBase *iBookDB) const =0

virtual IPreflightBookOptions *	QueryActivePreflightOptions (IBook *iBook) const =0

virtual IPreflightBookOptions *	QueryActivePreflightOptions (IDataBase *iBookDB) const =0

virtual bool	AreBookAndDocOptionsCompatible (const IPreflightBookOptions iBookOpts, const IPreflightOptions iDocOpts, IDataBase *iDocDB) const =0

virtual IPreflightOptions *	CreateDocOptionsFromBookOptions (const IPreflightBookOptions iBookOpts, IDataBase iDocDB) const =0

virtual void	UpdateBookAssociations (IBook *iBook) const =0

virtual void	UpdateBookAssociations (IDataBase *iDocDB) const =0

virtual UID	FindDocumentInBook (IBook iBook, IDataBase iDocDB) const =0

virtual void	VerifyBookContentFileStates (IBook *iBook) const =0

virtual void	VerifyBookContentFileStates () const =0

virtual void	DisassociateContentProcess (const UIDRef &contentRef) const =0

virtual void	GetBooksUsingProcess (uint32 processID, K2Vector< IBook * > &books) const =0

virtual ErrorCode	ApplyOptionsToBook (IDataBase iBookDB, const IPreflightBookOptions iNewOpts) const =0

virtual IPreflightBookData *	DoBookPreflight (IBook iBook, const UIDList &bookContentList, const IPreflightBookOptions iOptsToUse, RangeProgressBar *pProgressBar=nil) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Utilities related to book preflight.

Member Function Documentation

virtual ErrorCode IPreflightBookUtils::ApplyOptionsToBook	(	IDataBase *	iBookDB,
		const IPreflightBookOptions *	iNewOpts
	)		const

pure virtual

Analogous to ApplyOptionsToDocument; handles all internal status changes as a result.

virtual bool IPreflightBookUtils::AreBookAndDocOptionsCompatible	(	const IPreflightBookOptions *	iBookOpts,
		const IPreflightOptions *	iDocOpts,
		IDataBase *	iDocDB
	)		const

pure virtual

Determines whether a given set of document preflight options are set up compatibly with the specified book options. Compatible means the layer, pasteboard, and nonprinting options are identical, and the options call for using the document's embedded profile if it has one.

Parameters

iBookOpts	IN The book options to use as the baseline.
iDocOpts	IN The document options to compare. Can come from a document or process.
iDocDB	IN The document, if it is available. Slightly different rules apply if it is not, because we can't determine whether a document has an embedded profile if it's not available.

Returns: kTrue if the options are compatible; kFalse if not.

virtual IPreflightOptions* IPreflightBookUtils::CreateDocOptionsFromBookOptions	(	const IPreflightBookOptions *	iBookOpts,
		IDataBase *	iDocDB
	)		const

pure virtual

Given a document and some book options, create a new set of preflight options that should be used to configure the document for preflight for that book.

Parameters

iBookOpts	IN The book options to use.
iDocDB	IN The document you're creating the options for. (Needed to get profile names and embedded profile information.)

Returns: A refcounted in-memory preflight options set.

virtual void IPreflightBookUtils::DisassociateContentProcess ( const UIDRef & contentRef ) const

pure virtual

Given a book content identifier, break the connection between the preflight book content data and the process supplying it. This will also delete the process if it's no longer needed (ie the document itself isn't open and this is the only book that was using the process).

Parameters

contentRef IN The book content.

virtual IPreflightBookData* IPreflightBookUtils::DoBookPreflight	(	IBook *	iBook,
		const UIDList &	bookContentList,
		const IPreflightBookOptions *	iOptsToUse,
		RangeProgressBar *	pProgressBar = `nil`
	)		const

pure virtual

Preflight a book

Parameters

iBook	is the book to preflight.
bookContentList	is the list of book documents to preflight. This could be one or more document in the book or the entire book content.
iOptsToUse	is the book preflight options to use.
pProgressBar	if not nil, a progress bar is shown and updated.

Returns: the interface pointer to IPreflightBookData.

See Also: IPreflightBookData.h

virtual UID IPreflightBookUtils::FindDocumentInBook	(	IBook *	iBook,
		IDataBase *	iDocDB
	)		const

pure virtual

Determines whether the given document is in the given book, and if so, returns its content UID.

Parameters

iBook	IN The book.
iDocDB	IN The document.

Returns: The content UID in the book, or kInvalidUID if the document is not in the book.

virtual void IPreflightBookUtils::GetBooksUsingProcess	(	uint32	processID,
		K2Vector< IBook * > &	books
	)		const

pure virtual

Returns a list of the books that are using a given process, ie have content for which the process is providing results.

Parameters

processID	IN The ID of the process you're interested in.
books	OUT Receives the list of books. (These are not refcounted.)

virtual IPreflightBookData* IPreflightBookUtils::QueryActivePreflight ( IBook * iBook ) const

pure virtual

Given a book, get its active preflight data if there is an active preflight.

Parameters

iBook IN The book.

Returns: A refcounted book data interface, or nil if there is no active preflight.

virtual IPreflightBookData* IPreflightBookUtils::QueryActivePreflight ( IDataBase * iBookDB ) const

pure virtual

Given a book database, get its active preflight data if there is an active preflight.

Parameters

iBookDB IN The database of the book.

Returns: A refcounted book data interface, or nil if there is no active preflight.

virtual IPreflightBookOptions* IPreflightBookUtils::QueryActivePreflightOptions ( IBook * iBook ) const

pure virtual

Given a book, get its active preflight options if there is an active preflight.

Parameters

iBook IN The book.

Returns: A refcounted book options interface, or nil if there is no active preflight.

virtual IPreflightBookOptions* IPreflightBookUtils::QueryActivePreflightOptions ( IDataBase * iBookDB ) const

pure virtual

Given a book database, get its active preflight options if there is an active preflight.

Parameters

iBookDB IN The database of the book.

Returns: A refcounted book options interface, or nil if there is no active preflight.

virtual void IPreflightBookUtils::UpdateBookAssociations ( IBook * iBook ) const

pure virtual

Updates associations between a book's contents and the processes related to that book. This is called if you've made changes to the process or book state and want to re-sync.

Parameters

iBook IN The book that changed (or its processes).

virtual void IPreflightBookUtils::UpdateBookAssociations ( IDataBase * iDocDB ) const

pure virtual

Updates associations between a document and any books it relates to. This is called when you've modified something about the database that the book should update in response to.

Parameters

iDocDB IN The affected document.

virtual void IPreflightBookUtils::VerifyBookContentFileStates ( IBook * iBook ) const

pure virtual

Examines the contents of the book, and if any have gone out of date or have come back into existence, updates the book preflight status accordingly.

Parameters

iBook IN The affected book.

virtual void IPreflightBookUtils::VerifyBookContentFileStates ( ) const

pure virtual

Examines the contents of all open books, and if any have gone out of date or have come back into existence, updates the book preflight status accordingly.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation