IPreflightBookContentData Class Reference

#include <IPreflightBookContentData.h>

Inheritance diagram for IPreflightBookContentData:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTBOOKCONTENTDATA }
enum	Status {   kNoPreflightDone, kPreflightDoneButNowInvalid, kCurrentlyPreflighting, kCouldNotOpen,   kCouldNotPreflight, kPreflightSuccessful }

Public Member Functions
virtual void	SetParent (IPreflightBookData *iParent)=0
virtual IPreflightBookData *	QueryParent () const =0
virtual void	SetStatus (Status newStatus)=0
virtual Status	GetStatus () const =0
virtual void	SetAggregatedResults (const IPreflightAggregatedResults *iResults)=0
virtual const IPreflightAggregatedResults *	QueryAggregatedResults () const =0
virtual void	SetSelected (bool selected)=0
virtual bool	GetSelected () const =0
virtual void	SetProcessID (uint32 newUniqueID)=0
virtual uint32	GetProcessID () const =0
virtual IPreflightProcess *	QueryProcess () 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

This interface maintains the data/status for a particular book preflight operation.

See Also

IPreflightBookOptions for the options used for this preflight.

Member Enumeration Documentation

enum IPreflightBookContentData::Status

Enumerator
kNoPreflightDone	Preflight has never been requested for this entry.
kPreflightDoneButNowInvalid	Preflight was done at one point; but the results are no longer valid, so it's back to square one. Still, it's good to know this as opposed to the previous enum value.
kCurrentlyPreflighting	Currently preflighting this document.
kCouldNotOpen	Tried to preflight but couldn't open the document.
kCouldNotPreflight	Could open the document but preflight failed for some reason.
kPreflightSuccessful	Preflight has been selected and it's all done.

Member Function Documentation

virtual uint32 IPreflightBookContentData::GetProcessID ( ) const

pure virtual

Get the ID of the process associated with the preflight operation.

Returns

The preflight process ID.

See Also

IPreflightProcess

IPreflightProcessManager

virtual bool IPreflightBookContentData::GetSelected ( ) const

pure virtual

Get the selection state for this content. This is used to indicate whether the content is still slated for preflight in the current operation. Goes false as soon as the document is opened.

virtual Status IPreflightBookContentData::GetStatus ( ) const

pure virtual

Returns

the status of this data entry.

virtual const IPreflightAggregatedResults* IPreflightBookContentData::QueryAggregatedResults ( ) const

pure virtual

Returns

a refcounted aggregated results for this content, or nil if there are no results attached.

virtual IPreflightBookData* IPreflightBookContentData::QueryParent ( ) const

pure virtual

Get the parent book data.

Returns

Refcounted parent, or nil if no parent.

virtual IPreflightProcess* IPreflightBookContentData::QueryProcess ( ) const

pure virtual

Query the process associated with the preflight operation. This is a convenience method; it calls IPreflightProcessManager::QueryProcessByUniqueID.

Returns

The preflight process. Might be nil depending on what stage the preflight is in.

virtual void IPreflightBookContentData::SetAggregatedResults ( const IPreflightAggregatedResults *  iResults )

pure virtual

Attach (or detach) an aggregated results to this content.

Parameters

iResults

IN The new results, or nil to clear the results.

virtual void IPreflightBookContentData::SetParent ( IPreflightBookData *  iParent )

pure virtual

Set the parent book data. Needed to get proper notification of changes. Should be done once as part of initialization.

Parameters

iParent

IN The parent.

virtual void IPreflightBookContentData::SetProcessID ( uint32  newUniqueID )

pure virtual

Set the process ID for this book preflight operation.

Parameters

newUniqueID

IN The new process unique ID.

virtual void IPreflightBookContentData::SetSelected ( bool  selected )

pure virtual

Set the selection state for this content. This is used to indicate whether the content is still slated for preflight in the current operation. Goes false as soon as the document is opened.

virtual void IPreflightBookContentData::SetStatus ( Status  newStatus )

pure virtual

Set the status of this data entry.

Parameters

newStatus

IN The new status.