IPDFAttributes Class Reference

#include <IPDFAttributes.h>

Inheritance diagram for IPDFAttributes:

Public Types
enum	{ kDefaultIID = IID_IPDFATTRIBUTES }
enum	{   kDeviceBlendingNone = 0, kDeviceBlendingCMYK, kDeviceBlendingRGB, kDeviceBlendingGray,   kExportAuto = 0, kExportDL, kExportForm, kCyanUsed = 0x01,   kMagentaUsed = 0x02, kYellowUsed = 0x04, kBlackUsed = 0x08, kAllProcessColorsUsed = 0x0F }

Public Member Functions
virtual uint32	GetPageIndex () const =0
virtual void	SetPageIndex (uint32 pageIndex)=0
virtual bool16	GetTransparentBackground () const =0
virtual void	SetTransparentBackground (bool16 fTransparent)=0
virtual bool16	GetPreserveScreens () const =0
virtual void	SetPreserveScreens (bool16 fPreserve)=0
virtual void	SetUserEnteredPassword (bool16 enteredPassword)=0
virtual bool16	GetUserEnteredPassword () const =0
virtual const UIDList *	CreateUsedColorUIDList (const UIDList *pUIDList)=0
virtual const UIDList *	GetUsedColorUIDList () const =0
virtual uint32	GetCropTo () const =0
virtual void	SetCropTo (uint32 cropTo)=0
virtual bool16	GetContainsTransparency () const =0
virtual void	SetContainsTransparency (bool16 containsXP)=0
virtual bool16	GetContainsOPIReferences () const =0
virtual void	SetContainsOPIReferences (bool16 containsOPI)=0
virtual bool16	GetContainsOverprint () const =0
virtual void	SetContainsOverprint (bool16 opd)=0
virtual bool16	GetContainsNIPBlendingModes () const =0
virtual void	SetContainsNIPBlendingModes (bool16 nips)=0
virtual bool16	GetXPPreviouslyFlattened () const =0
virtual void	SetXPPreviouslyFlattened (bool16 flat)=0
virtual bool16	HasPageBlending () const =0
virtual CAGMColorSpace	GetBlendingColorSpace (bool16 *isOverride=nil)=0
virtual void	SetBlendingColorSpace (CAGMColorSpace cs, bool16 isOverride)=0
virtual bool16	GetPageIsolation (bool16 *isOverride=nil) const =0
virtual void	SetPageIsolation (bool16 isolate, bool16 isOverride)=0
virtual bool16	GetPageKnockout (bool16 *isOverride=nil) const =0
virtual void	SetPageKnockout (bool16 knockout, bool16 isOverride)=0
virtual void	SetApplyColorAliases (bool16 apply)=0
virtual bool16	GetApplyColorAliases () const =0
virtual int32	GetExportStrategy () const =0
virtual void	SetExportStrategy (int32 strategy)=0
virtual bool16	IsFromClipboard () const =0
virtual void	SetFromClipboard (bool16 fromClipboard)=0
virtual int32	CalculateHasTransparency (bool16 &bTransparency)=0
virtual bool16	GetHasGradient () const =0
virtual void	SetHasGradient (bool16 hasGradient)=0
virtual bool16	GetHasGradientMesh () const =0
virtual void	SetHasGradientMesh (bool16 hasGradientMesh)=0
virtual int32	GetExpectedPDFLibCancelCallbackCount () const =0
virtual void	SetExpectedPDFLibCancelCallbackCount (int32 n)=0
virtual bool16	GetIsTrapped () const =0
virtual void	SetIsTrapped (bool16 bIsTrapped)=0
virtual uint32	GetProcessColorsUsed () const =0
virtual void	SetProcessColorsUsed (uint32 processColorsUsed)=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

The IPDFAttributes interface stores information about a placed PDF file.

Member Function Documentation

virtual int32 IPDFAttributes::CalculateHasTransparency ( bool16 &  bTransparency )

pure virtual

Calculate whether this PDF has transparency.

Note: This method will do a fairly expensive calculation to determine if the associated PDF has transparency or not. In general, it should not be used. Instead, IPDFAttributes.GetContainsTransparency should be used. We use it during document conversion, because in that case the value returned by GetHasTransparency flag is not set correctly, since 1.5 docs didn't support transparency. After the 1.5 document is converted, however, everything should be fine.

Parameters

bTransparency

OUT Set to kTrue if PDF has transparency, else kFalse

Returns

kSuccess if method succeeds, else kFailure

virtual const UIDList* IPDFAttributes::CreateUsedColorUIDList ( const UIDList *  pUIDList )

pure virtual

Creates a UIDList of color swatches used by the PDF. The existing list, if any, is deleted and a new list is created. If a valid list is passed in, the new list contains it as its single entry; otherwise, the new list is empty.

Parameters

pUIDList

IN Swatch UID list to create, or nil if the list is to be created empty

Returns

the newly created UIDList used to store color swatch UIDs for this PDF

virtual bool16 IPDFAttributes::GetApplyColorAliases ( ) const

pure virtual

Returns kTrue if the user chose to allow color aliasing, else kFalse

virtual CAGMColorSpace IPDFAttributes::GetBlendingColorSpace ( bool16 *  isOverride = nil )

pure virtual

Gets blending color space for this PDF.

Note: necessarily unusable by third-party developers due to use of internal type CAGMColorSpace

Parameters

isOverride

OUT If non-nil, set to kTrue if color space is an override, else kFalse

Returns

the blending color space for this PDF.

virtual bool16 IPDFAttributes::GetContainsNIPBlendingModes ( ) const

pure virtual

Returns kTrue if this PDF contains non-ink-preserving blend modes, else kFalse

virtual bool16 IPDFAttributes::GetContainsOPIReferences ( ) const

pure virtual

Returns kTrue if this PDF contains OPI references, else kFalse

virtual bool16 IPDFAttributes::GetContainsOverprint ( ) const

pure virtual

Returns kTrue if this PDF contains overprint, else kFalse

virtual bool16 IPDFAttributes::GetContainsTransparency ( ) const

pure virtual

Returns kTrue if this PDF contains transparency, else kFalse

virtual uint32 IPDFAttributes::GetCropTo ( ) const

pure virtual

Gets the "crop to" setting for this PDF.

Returns

the current crop to setting to use for this PDF

See Also

IPDFPlacePrefs for the list of acceptable values

virtual int32 IPDFAttributes::GetExpectedPDFLibCancelCallbackCount ( ) const

pure virtual

Internal use only. Intentionally undocumented.

virtual int32 IPDFAttributes::GetExportStrategy ( ) const

pure virtual

Note: This API will be obsoleted in a future version. Do not use.

Returns

the export strategy for this PDF file

virtual bool16 IPDFAttributes::GetHasGradient ( ) const

pure virtual

Returns kTrue if PDF contains one or more gradients, else kFalse

virtual bool16 IPDFAttributes::GetHasGradientMesh ( ) const

pure virtual

Returns kTrue if PDF contains one or more gradient meshes, else kFalse

virtual bool16 IPDFAttributes::GetIsTrapped ( ) const

pure virtual

Gets whether the PDF has been trapped. This is determined by reading the /Trapped key in the PDF.

Returns

kTrue if the PDF was trapped, else kFalse

virtual uint32 IPDFAttributes::GetPageIndex ( ) const

pure virtual

Returns the index number of currently referenced page

virtual bool16 IPDFAttributes::GetPageIsolation ( bool16 *  isOverride = nil ) const

pure virtual

Parameters

isOverride

OUT If non-nil, set to kTrue if page isolation setting is an override, else kFalse

Returns

kTrue if this PDF uses page isolation, else kFalse

virtual bool16 IPDFAttributes::GetPageKnockout ( bool16 *  isOverride = nil ) const

pure virtual

Parameters

isOverride

OUT If non-nil, set to kTrue if page knockout setting is an override, else kFalse

Returns

kTrue if this PDF uses page knockout, else kFalse

virtual bool16 IPDFAttributes::GetPreserveScreens ( ) const

pure virtual

Returns the "preserve halftone screens" setting for this PDF item.

virtual uint32 IPDFAttributes::GetProcessColorsUsed ( ) const

pure virtual

Gets which process colors are used in the PDF. Return value is a bitfield and will consist of a combination of one or more of the following values: kCyanUsed, kMagentaUsed, kYellowUsed, or kBlackUsed, or it may be the special value kAllProcessColorsUsed.

Returns

bitfield indicating which process colors are used

virtual bool16 IPDFAttributes::GetTransparentBackground ( ) const

pure virtual

Returns the background transparency for this PDF item.

virtual const UIDList* IPDFAttributes::GetUsedColorUIDList ( ) const

pure virtual

Gets the existing UIDList of color swatches used by this PDF. If the list does not exist, nil is returned.

Returns

the existing UIDList used to store color swatch UIDs for this PDF

virtual bool16 IPDFAttributes::GetUserEnteredPassword ( ) const

pure virtual

Internal use only. Intentionally undocumented.

virtual bool16 IPDFAttributes::GetXPPreviouslyFlattened ( ) const

pure virtual

Returns kTrue if this PDF was previously flattened, else kFalse

virtual bool16 IPDFAttributes::HasPageBlending ( ) const

pure virtual

Returns kTrue if this PDF has page-level blending, else kFalse

virtual bool16 IPDFAttributes::IsFromClipboard ( ) const

pure virtual

Returns kTrue if page item was pasted from the system clipboard, else kFalse

virtual void IPDFAttributes::SetApplyColorAliases ( bool16  apply )

pure virtual

Set the user's choice for whether to allow color aliasing.

Parameters

apply

IN The new apply color aliases setting

virtual void IPDFAttributes::SetBlendingColorSpace ( CAGMColorSpace  cs, bool16  isOverride  )

pure virtual

Sets the blending color space for this PDF.

Note: necessarily unusable by third-party developers due to use of internal type CAGMColorSpace

Parameters

cs	IN The new blending color space
isOverride	IN The new is-override flag

virtual void IPDFAttributes::SetContainsNIPBlendingModes ( bool16  nips )

pure virtual

Sets whether this PDF contains non-ink-preserving blend modes.

Parameters

nips	IN The new value for whether this PDF contains non-ink-preserving blend modes

virtual void IPDFAttributes::SetContainsOPIReferences ( bool16  containsOPI )

pure virtual

Sets whether this PDF contains OPI references

Parameters

containsOPI

IN The new value for whether this PDF contains OPI references

virtual void IPDFAttributes::SetContainsOverprint ( bool16  opd )

pure virtual

Sets whether this PDF contains overprint.

Parameters

opd	IN The new value for whether this PDF contains overprint

virtual void IPDFAttributes::SetContainsTransparency ( bool16  containsXP )

pure virtual

Sets whether this PDF contains transparency.

Parameters

containsXP

IN The new value for whether this PDF contains transparency

virtual void IPDFAttributes::SetCropTo ( uint32  cropTo )

pure virtual

Sets the "crop to" setting for this PDF.

Parameters

cropTo

IN The new crop to setting to use for this PDF

See Also

IPDFPlacePrefs for the list of acceptable values

virtual void IPDFAttributes::SetExpectedPDFLibCancelCallbackCount ( int32  n )

pure virtual

Internal use only. Intentionally undocumented.

virtual void IPDFAttributes::SetExportStrategy ( int32  strategy )

pure virtual

Note: This API will be obsoleted in a future version. Do not use.

Sets the export strategy for this PDF.

Parameters

strategy

IN The new export strategy

virtual void IPDFAttributes::SetFromClipboard ( bool16  fromClipboard )

pure virtual

Sets whether this page item was pasted from system clipboard.

Parameters

fromClipboard

IN The new is from clipboard setting

virtual void IPDFAttributes::SetHasGradient ( bool16  hasGradient )

pure virtual

Sets whether PDF contains one or more gradients.

Parameters

hasGradient

IN The new value for has gradient setting

virtual void IPDFAttributes::SetHasGradientMesh ( bool16  hasGradientMesh )

pure virtual

Sets whether PDF contains one or more gradient meshes.

Parameters

hasGradientMesh

IN The new value for has gradient mesh setting

virtual void IPDFAttributes::SetIsTrapped ( bool16  bIsTrapped )

pure virtual

Sets whether PDF was trapped. Should be based on whether /Trapped key in the PDF is set to true.

Parameters

bIsTrapped

IN The new is trapped setting

virtual void IPDFAttributes::SetPageIndex ( uint32  pageIndex )

pure virtual

Sets the index number of the currently referenced page.

Parameters

pageIndex

IN The page number of currently referenced page

virtual void IPDFAttributes::SetPageIsolation ( bool16  isolate, bool16  isOverride  )

pure virtual

Sets page isolation setting for this PDF.

Parameters

isolate	IN The new uses page isolation setting
isOverride	IN kTrue if setting is an override, else kFalse

virtual void IPDFAttributes::SetPageKnockout ( bool16  knockout, bool16  isOverride  )

pure virtual

Sets page knockout setting for this PDF.

Parameters

knockout	IN The new uses page knockout setting
isOverride	IN kTrue if setting is an override, else kFalse

virtual void IPDFAttributes::SetPreserveScreens ( bool16  fPreserve )

pure virtual

Sets the "preserve halftone screens" setting for this PDF item.

Parameters

fPreserve

IN Flag indicating whether to preserve halftone screens

virtual void IPDFAttributes::SetProcessColorsUsed ( uint32  processColorsUsed )

pure virtual

Sets which process colors are used in the PDF. Input is a bitfield and should consist of a combination of one or more of the following values: kCyanUsed, kMagentaUsed, kYellowUsed, or kBlackUsed, or it may be the special value kAllProcessColorsUsed.

Parameters

processColorsUsed

IN Bitfield indicating which process colors are used

virtual void IPDFAttributes::SetTransparentBackground ( bool16  fTransparent )

pure virtual

Sets the background transparency for this PDF item.

Parameters

fTransparent

IN Flag indicating whether background is transparent

virtual void IPDFAttributes::SetUserEnteredPassword ( bool16  enteredPassword )

pure virtual

Internal use only. Intentionally undocumented.

virtual void IPDFAttributes::SetXPPreviouslyFlattened ( bool16  flat )

pure virtual

Sets whether this PDF was previously flattened.

Parameters

flat	IN The new value for whether this PDF was previously flattened