IPMInkBossData Class Reference

#include <IPMInkBossData.h>

Inheritance diagram for IPMInkBossData:

Public Types
enum	{ kDefaultIID = IID_IPMINKBOSSDATA }
enum	{ kAGMPrintTrapInkNormal = 0, kAGMPrintTrapInkTransp, kAGMPrintTrapInkOpaque, kAGMPrintTrapInkOpaqueIgnore }

Public Member Functions
virtual const PMString &	GetInkName () const =0
virtual bool16	GetInkIsProcess () const =0
virtual bool16	GetInkPrintInk () const =0
virtual bool16	GetInkOverprintInk () const =0
virtual PMReal	GetInkOverprintThold () const =0
virtual PMReal	GetInkNeutralDensity () const =0
virtual uint32	GetInkAGMPrintInkTrapType () const =0
virtual int32	GetInkTrapOrder () const =0
virtual bool16	GetInkOverridePPD () const =0
virtual PMReal	GetInkFrequency () const =0
virtual PMReal	GetInkAngle () const =0
virtual const ColorArray &	GetRGBValue () const =0
virtual PMReal	GetInkSolidity () const =0
virtual bool16	GetInkAsProcess () const =0
virtual UID	GetInkAliasUID () const =0
virtual void	SetInkName (const PMString &inkName)=0
virtual void	SetInkIsProcess (bool16 isProcess)=0
virtual void	SetInkPrintInk (bool16 printInk)=0
virtual void	SetInkOverprintInk (bool16 overprintInk)=0
virtual void	SetInkOverprintThold (PMReal overprintThold)=0
virtual void	SetInkNeutralDensity (PMReal neutralDensity)=0
virtual void	SetInkAGMPrintInkTrapType (uint32 trapType)=0
virtual void	SetInkTrapOrder (int32 trapOrder)=0
virtual void	SetInkOverridePPD (bool16 overridePPD)=0
virtual void	SetInkFrequency (PMReal frequency)=0
virtual void	SetInkAngle (PMReal angle)=0
virtual void	SetRGBValue (const ColorArray &rgbValue)=0
virtual void	SetInkSolidity (PMReal solidity)=0
virtual void	SetInkAsProcess (bool16 asProcess)=0
virtual void	SetInkAliasUID (UID inkAliasUID)=0
virtual void	CopyInkData (IPMInkBossData *iSourceData)=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

A data interface for InDesign's ink objects. InDesign inks are kPMInkDataBoss objects.

See Also

also IInkList.h.

Member Enumeration Documentation

anonymous enum

AGM trapping ink types

Enumerator
kAGMPrintTrapInkNormal	kAGMPrintTrapInkNormal indicates traditional process inks and most spot inks.
kAGMPrintTrapInkTransp	kAGMPrintTrapInkTransp indicates trapping for varnishes and die line inks
kAGMPrintTrapInkOpaque	kAGMPrintTrapInkOpaque indicates trapping for heavy, non-transparent inks, e.g., metallic inks.

Member Function Documentation

virtual void IPMInkBossData::CopyInkData ( IPMInkBossData *  iSourceData )

pure virtual

Copy the ink data.

Parameters

iSourceData

specifies the source ink data to copy data from.

virtual uint32 IPMInkBossData::GetInkAGMPrintInkTrapType ( ) const

pure virtual

Returns ink's trapping type.

virtual UID IPMInkBossData::GetInkAliasUID ( ) const

pure virtual

Returns the ink's ink alias UID.

virtual PMReal IPMInkBossData::GetInkAngle ( ) const

pure virtual

Returns ink's angle setting.

virtual bool16 IPMInkBossData::GetInkAsProcess ( ) const

pure virtual

Returns true if spot ink is treated as process ink.

virtual PMReal IPMInkBossData::GetInkFrequency ( ) const

pure virtual

Returns ink's frequency setting.

virtual bool16 IPMInkBossData::GetInkIsProcess ( ) const

pure virtual

Returns true if ink is a process ink.

virtual const PMString& IPMInkBossData::GetInkName ( ) const

pure virtual

Returns the ink name.

virtual PMReal IPMInkBossData::GetInkNeutralDensity ( ) const

pure virtual

Returns ink's neutral density.

virtual bool16 IPMInkBossData::GetInkOverprintInk ( ) const

pure virtual

Returns true if ink is set to overprint.

virtual PMReal IPMInkBossData::GetInkOverprintThold ( ) const

pure virtual

Returns ink's overprint threshhold.

virtual bool16 IPMInkBossData::GetInkOverridePPD ( ) const

pure virtual

Returns true if overrideing PPD.

virtual bool16 IPMInkBossData::GetInkPrintInk ( ) const

pure virtual

Returns true if ink is set to print.

virtual PMReal IPMInkBossData::GetInkSolidity ( ) const

pure virtual

Returns ink's solidity setting.

virtual int32 IPMInkBossData::GetInkTrapOrder ( ) const

pure virtual

Returns ink's trapping order.

virtual const ColorArray& IPMInkBossData::GetRGBValue ( ) const

pure virtual

Returns ink's RGB value representation.

virtual void IPMInkBossData::SetInkAGMPrintInkTrapType ( uint32  trapType )

pure virtual

Set ink's trapping type.

Parameters

trapType

specifies the trapping type.

virtual void IPMInkBossData::SetInkAliasUID ( UID  inkAliasUID )

pure virtual

Set the ink's ink alias UID.

Parameters

inkAliasUID

specifies the ink alias UID.

virtual void IPMInkBossData::SetInkAngle ( PMReal  angle )

pure virtual

Set ink's angle.

Parameters

angle

specifies the angle.

virtual void IPMInkBossData::SetInkAsProcess ( bool16  asProcess )

pure virtual

Set whether or not spot ink should be treated as process ink.

Parameters

asProcess

is true if spot ink is treated as process ink.

virtual void IPMInkBossData::SetInkFrequency ( PMReal  frequency )

pure virtual

Set ink's frequency.

Parameters

frequency

specifies the ink frequency.

virtual void IPMInkBossData::SetInkIsProcess ( bool16  isProcess )

pure virtual

Set whether or not ink is a process ink.

Parameters

isProcess

is true if ink is a process ink.

virtual void IPMInkBossData::SetInkName ( const PMString &  inkName )

pure virtual

Set the ink name.

Parameters

inkName

specifies the ink name to set.

virtual void IPMInkBossData::SetInkNeutralDensity ( PMReal  neutralDensity )

pure virtual

Set ink's neutral density.

Parameters

neutralDensity

specifies the neutral density.

virtual void IPMInkBossData::SetInkOverprintInk ( bool16  overprintInk )

pure virtual

Set whether or not should overprint ink.

Parameters

overprintInk

is true if ink should be overprinted.

virtual void IPMInkBossData::SetInkOverprintThold ( PMReal  overprintThold )

pure virtual

Set the ink's overprint threshhold.

Parameters

overprintThold

is the overprint threshhold to set.

virtual void IPMInkBossData::SetInkOverridePPD ( bool16  overridePPD )

pure virtual

Set whether or not ink should override PPD.

Parameters

overridePPD

is true if to override PPD.

virtual void IPMInkBossData::SetInkPrintInk ( bool16  printInk )

pure virtual

Set whether or not this ink should be printed.

Parameters

printInk

is true if ink should be printed.

virtual void IPMInkBossData::SetInkSolidity ( PMReal  solidity )

pure virtual

Set ink's solidity.

Parameters

solidity

specifies the solidity.

virtual void IPMInkBossData::SetInkTrapOrder ( int32  trapOrder )

pure virtual

Set ink's trapping order.

Parameters

trapOrder

specifies the trapping order.

virtual void IPMInkBossData::SetRGBValue ( const ColorArray &  rgbValue )

pure virtual

Set the ink's RGB color representation.

Parameters

rgbValue

specifies the RGB color values.