IPreflightBookOptions Class Reference

#include <IPreflightBookOptions.h>

Inheritance diagram for IPreflightBookOptions:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTBOOKOPTIONS }

Public Member Functions
virtual void	SetCheckAllDocs (bool allDocs)=0
virtual bool	GetCheckAllDocs () const =0
virtual void	SetLayerOptions (const IPreflightOptions::LayerOptions layerOptions)=0
virtual IPreflightOptions::LayerOptions	GetLayerOptions () const =0
virtual void	SetIncludeObjectsOnPasteboard (const bool16 onOff)=0
virtual bool16	GetIncludeObjectsOnPasteboard () const =0
virtual void	SetIncludeNonPrintingObjects (const bool16 onOff)=0
virtual bool16	GetIncludeNonPrintingObjects () const =0
virtual void	SetPreflightProfilePolicy (IPreflightOptions::PreflightProfilePolicy profilePolicy)=0
virtual IPreflightOptions::PreflightProfilePolicy	GetPreflightProfilePolicy () const =0
virtual void	SetUseProfile (const PMString &profileName)=0
virtual PMString	GetUseProfile () const =0
virtual void	SetGenerateReportOnly (const bool16 reportOnly)=0
virtual bool16	GetGenerateReportOnly () const =0
virtual void	CopyFrom (const IPreflightBookOptions *iOther)=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

Data interface for book preflight options. Similar to IPreflightOptions but there's not a 1:1 correspondence and it would be kind of irritating to overload the other interface. Persisted at the application level for defaults purposes.

This interface sits on both the book root object to establish defaults; and on the in-memory book preflight object to represent the settings used for a particular book preflight operation. (See IPreflightBookRef.)

Member Function Documentation

virtual void IPreflightBookOptions::CopyFrom ( const IPreflightBookOptions *  iOther )

pure virtual

Copy options data.

Parameters

iOther

is the preflight option data to copy from.

virtual bool IPreflightBookOptions::GetCheckAllDocs ( ) const

pure virtual

Returns

whether to check all docs (true) or only selected docs (false).

virtual bool16 IPreflightBookOptions::GetGenerateReportOnly ( ) const

pure virtual

Returns

whether to generate a report when the preflight is done.

virtual bool16 IPreflightBookOptions::GetIncludeNonPrintingObjects ( ) const

pure virtual

Returns

true if object included; otherwise false.

virtual bool16 IPreflightBookOptions::GetIncludeObjectsOnPasteboard ( ) const

pure virtual

Returns

true if object included; otherwise false.

virtual IPreflightOptions::LayerOptions IPreflightBookOptions::GetLayerOptions ( ) const

pure virtual

Returns

the preflight layer option.

virtual IPreflightOptions::PreflightProfilePolicy IPreflightBookOptions::GetPreflightProfilePolicy ( ) const

pure virtual

Returns

the preflight profile policy for new/open document.

virtual PMString IPreflightBookOptions::GetUseProfile ( ) const

pure virtual

Returns

the name of the preflight profile to use by default or in the absence of a doc profile (

See Also

SetPreflightProfilePolicy).

virtual void IPreflightBookOptions::SetCheckAllDocs ( bool  allDocs )

pure virtual

Sets whether to check all docs (as opposed to the selected docs).

Parameters

allDocs

IN True for all docs, false for selection (ignored if no selection).

virtual void IPreflightBookOptions::SetGenerateReportOnly ( const bool16  reportOnly )

pure virtual

Set whether to generate a report when the preflight is done.

Parameters

reportOnly

IN True to generate a report; false to simply exit back to user control.

virtual void IPreflightBookOptions::SetIncludeNonPrintingObjects ( const bool16  onOff )

pure virtual

Sets to true if include non-printing objects for preflight.

Parameters

onOff

specifies either to include or exclude non-printing objects. true if to include, otherwise excluded.

virtual void IPreflightBookOptions::SetIncludeObjectsOnPasteboard ( const bool16  onOff )

pure virtual

Sets to true if include objects on the pasteboard for preflight.

Parameters

onOff

specifies either to include or exclude objects on the pasteboard. true if to include, otherwise excluded.

virtual void IPreflightBookOptions::SetLayerOptions ( const IPreflightOptions::LayerOptions  layerOptions )

pure virtual

Sets the layer options for preflight.

Parameters

layerOptions

specified the layer option to use.

virtual void IPreflightBookOptions::SetPreflightProfilePolicy ( IPreflightOptions::PreflightProfilePolicy  profilePolicy )

pure virtual

Set the preflight profile policy when preflighting book docs. Note that this setting only applies at the application-level.

Parameters

openPolicy

specifies the policy to use.

virtual void IPreflightBookOptions::SetUseProfile ( const PMString &  profileName )

pure virtual

Set the preflight profile to use by default or in the absence of a doc profile (

See Also

SetPreflightProfilePolicy).

Parameters

profileName

specifies the name of the preflight profile to use.