#include <IPreflightOptions.h>

Inheritance diagram for IPreflightOptions:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTOPTIONS }

enum	PreflightProfilePolicy { kUseEmbeddedProfile = 0, kUseWorkingProfile }

enum	LayerOptions { kAllLayers = 0, kVisibleLayers, kVisiblePrintableLayers }

enum	PreflightScope { kAllPages = 0, kPageRange }

Public Member Functions
virtual void	SetPreflightOff (bool16 onOff)=0

virtual bool16	GetPreflightOff () const =0

virtual void	SetPreflightProfilePolicy (PreflightProfilePolicy profilePolicy)=0

virtual PreflightProfilePolicy	GetPreflightProfilePolicy () const =0

virtual void	SetUseProfile (const PMString &profileName)=0

virtual PMString	GetUseProfile () const =0

virtual void	SetUsingEmbeddedProfile (bool16 usingEmbedded)=0

virtual bool16	GetUsingEmbeddedProfile () const =0

virtual void	SetEmbedProfileInNewDocument (bool16 embed)=0

virtual bool16	GetEmbedProfileInNewDocument () const =0

virtual void	SetIncludeLayers (LayerOptions includeLayerOption)=0

virtual LayerOptions	GetIncludeLayers () const =0

virtual void	SetIncludeObjectsOnPasteboard (bool16 onOff)=0

virtual bool16	GetIncludeObjectsOnPasteboard () const =0

virtual void	SetIncludeNonPrintingObjects (bool16 onOff)=0

virtual bool16	GetIncludeNonPrintingObjects () const =0

virtual void	SetScope (PreflightScope scope)=0

virtual PreflightScope	GetScope () const =0

virtual void	SetPageRange (const PMString &pageRange)=0

virtual PMString	GetPageRange () const =0

virtual void	CopyFrom (const IPreflightOptions *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 preflight options. This interface sits on the document and application; the easiest way to get one is via IPreflightUtils::QueryPreflightOptions().

Use extreme caution when changing the preflight options for a document directly, because these need to be kept in sync with the active processes that are running in the background. The safest ways to update this interface are via IPreflightUtils::ApplyOptionsToDocument(), or better yet, using IPreflightFacade, which does this through a command.

Member Enumeration Documentation

enum IPreflightOptions::LayerOptions

Defines the options for including layers in the preflight. kAllLayers indicates that all layers are included. kVisibleLayers indicates that only visible layers are included. kVisibleAndPrintableLayers indicates that only visible and printable layers are included.

enum IPreflightOptions::PreflightProfilePolicy

Defines the preflight profile policy when opening a document if preflight has been set to ON. This settings kUseEmbeddedProfile indicates preflight using embedded profile if one exists. kUseWorkingProfile indicates preflight using a specified profile.

enum IPreflightOptions::PreflightScope

Defines the preflighting scope. kAllPages indicates that all pages are included for preflight. kPageRanges indicates that only the specified page ranges are preflighted. Page ranges is accessed with SetPageRange and GetPageRage.

Member Function Documentation

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

pure virtual

Copy options data.

Parameters

iOther is the preflight option data to copy from.

virtual bool16 IPreflightOptions::GetEmbedProfileInNewDocument ( ) const

pure virtual

Returns: true if to embedded the working profile (from GetUseProfile) in the new document.

See Also: GetUseProfile

virtual LayerOptions IPreflightOptions::GetIncludeLayers ( ) const

pure virtual

Returns: the preflight layer option.

virtual bool16 IPreflightOptions::GetIncludeNonPrintingObjects ( ) const

pure virtual

Returns: true if object included; otherwise false.

virtual bool16 IPreflightOptions::GetIncludeObjectsOnPasteboard ( ) const

pure virtual

Returns: true if object included; otherwise false.

virtual PMString IPreflightOptions::GetPageRange ( ) const

pure virtual

This method only applies to documents.

Returns: the string representing the page ranges for preflighting

virtual bool16 IPreflightOptions::GetPreflightOff ( ) const

pure virtual

Returns: true if preflight is disabled for all. Note that this is the application-wide preflight on/off setting.

virtual PreflightProfilePolicy IPreflightOptions::GetPreflightProfilePolicy ( ) const

pure virtual

Returns: the preflight profile policy for new/open document.

virtual PreflightScope IPreflightOptions::GetScope ( ) const

pure virtual

This method only applies to documents.

Returns: the preflighting scope.

virtual PMString IPreflightOptions::GetUseProfile ( ) const

pure virtual

Returns: the name of the working preflight profile to use.

virtual bool16 IPreflightOptions::GetUsingEmbeddedProfile ( ) const

pure virtual

Get whether the given document is using a document-embedded profile as opposed to an external (app-level) profile. This setting is only used at the document level and is nonpersistent.

Returns: kTrue for embedded; kFalse for application level.

virtual void IPreflightOptions::SetEmbedProfileInNewDocument ( bool16 embed )

pure virtual

Set whether to embed the working document in the new documet. Note that this setting only applies at the application-level.

Parameters

embed is true if the working profile (from GetUseProfile) should be embeded when creating a new document.

See Also: GetUseProfile

virtual void IPreflightOptions::SetIncludeLayers ( LayerOptions includeLayerOption )

pure virtual

Sets the layer optoins for preflight. Note that this setting only applies at the application-level.

Parameters

includLayerOption specified the layer option to use.

virtual void IPreflightOptions::SetIncludeNonPrintingObjects ( bool16 onOff )

pure virtual

Sets to true if include non-printing objects for preflight. Note that this setting is only persistent at the application-level.

Parameters

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

virtual void IPreflightOptions::SetIncludeObjectsOnPasteboard ( bool16 onOff )

pure virtual

Sets to true if include objects on the pasteboard for preflight. Note that this setting is only persistent at the application-level.

Parameters

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

virtual void IPreflightOptions::SetPageRange ( const PMString & pageRange )

pure virtual

Sets the page range to preflight if the scope is set to kPageRanges. To specify a range, separate page numbers in the string with a hyphen (-). To specify separate pages, separate page numbers in the string with a comma (,). This method only applies to documents.

Parameters

pageRange specified page ranges.

virtual void IPreflightOptions::SetPreflightOff ( bool16 onOff )

pure virtual

Sets to true if disable preflight for all new/open and currently open documents. Note that this setting is only persistent at the application-level.

Parameters

onOff is true if to disable all preflights and false if to enable all preflights.

virtual void IPreflightOptions::SetPreflightProfilePolicy ( PreflightProfilePolicy profilePolicy )

pure virtual

Set the preflight profile policy for new/open documents when the preflight is enabled for all documents. Note that this setting only applies at the application-level.

Parameters

openPolicy specifies the policy to use.

virtual void IPreflightOptions::SetScope ( PreflightScope scope )

pure virtual

Sets the preflighting scope. This method only applies to documents.

Parameters

scope specified either to preflight all pages or a page range.

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

pure virtual

Set the working preflight profile to use. Note that this setting only applies at the application-level.

See Also: PreflightProfilePolicy; SetPreflightProfilePolicy

Parameters

profileName specifies the name of the working preflight profile to use.

virtual void IPreflightOptions::SetUsingEmbeddedProfile ( bool16 usingEmbedded )

pure virtual

Set whether the given document is using a document-embedded profile as opposed to an external (app-level) profile. This setting is only used at the document level and is nonpersistent.

Parameters

usingEmbedded IN kTrue for embedded; kFalse for application level.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation