InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IInkResourceData Class Referenceabstract

#include <IInkResourceData.h>

Inheritance diagram for IInkResourceData:
IPMUnknown

Public Member Functions

virtual void Setup (IInkList *iInkList, IPrintData *iPrintData)=0
 
virtual void CopyInkResouceData (IInkResourceData *srcData)=0
 
virtual void AddInk (UIDRef inkUIDRef)=0
 
virtual void AddProcessCyan ()=0
 
virtual void AddProcessMagenta ()=0
 
virtual void AddProcessYellow ()=0
 
virtual void AddProcessBlack ()=0
 
virtual bool8 AllProcessInksUsed () const =0
 
virtual IInkListQueryInkList () const =0
 
virtual IPrintDataQueryPrintData () const =0
 
virtual int32 GetNumInks () const =0
 
virtual UID GetNthInk (int32 n) const =0
 
virtual void Clear ()=0
 
virtual bool8 GetGradientUsed () const =0
 
virtual void SetGradientUsed (const bool8 bGradientUsed)=0
 
virtual bool8 GetGradientMeshUsed () const =0
 
virtual void SetGradientMeshUsed (const bool8 bGradientMeshUsed)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Records the ink usage for different types of page items. This is the data interface that is passed through the GetUsedInks() method of IInkResources, to store off ink usage results.

See Also
IInkResources

Member Function Documentation

virtual void IInkResourceData::AddInk (UIDRef inkUIDRef)
pure virtual

Add a used ink. The implementation of this interface guarantees that only one instance of an ink is stored. Implementations of this interface and users of this interface assume that the ink UID exists in the ink list that was passed into Setup.

Parameters
inkUIDRefIN the ink being used by the page item
virtual void IInkResourceData::AddProcessBlack ()
pure virtual

Shortcut method for adding process Black.

virtual void IInkResourceData::AddProcessCyan ()
pure virtual

Shortcut method for adding process Cyan.

virtual void IInkResourceData::AddProcessMagenta ()
pure virtual

Shortcut method for adding process Magenta.

virtual void IInkResourceData::AddProcessYellow ()
pure virtual

Shortcut method for adding process Yellow.

virtual bool8 IInkResourceData::AllProcessInksUsed () const
pure virtual

Performance improving method that tells clients if all process inks are already used. If true, the client can skip adding it's resources as it already knows. they all exist.

Returns
bool8 - kTrue if all process inks already registered as being used, kFalse otherwise
virtual void IInkResourceData::Clear ()
pure virtual

Remove all entries from the list and remove the reference to the doc ink list.

virtual void IInkResourceData::CopyInkResouceData (IInkResourceDatasrcData)
pure virtual

Copy an existing ink resource data list into this list.

Parameters
srcDataIN source ink resource data
virtual bool8 IInkResourceData::GetGradientMeshUsed () const
pure virtual

Tells whether a gradient mesh paint server is used in the pub - print code will not download the gradient mesh paint server procset if this is false

Returns
bool8 - kTrue if gradient mesh used, kFalse otherwise
virtual bool8 IInkResourceData::GetGradientUsed () const
pure virtual

Tells whether a gradient paint server is used in the pub - print code will not download the gradient paint server procset if this is false.

Returns
bool8 kTrue if gradient used, kFalse otherwise
virtual UID IInkResourceData::GetNthInk (int32 n) const
pure virtual

Retrieve the UID of the Nth ink being used.

Parameters
nIN which ink to retrieve
Returns
UID the UID of the Nth ink
virtual int32 IInkResourceData::GetNumInks () const
pure virtual

Retrieve the number of inks being used.

Returns
int32 - the number of inks being used
virtual IInkList* IInkResourceData::QueryInkList () const
pure virtual

Returns the ink list that the resource data is using.

Returns
IInkList* - pointer to the IInkList being used
virtual IPrintData* IInkResourceData::QueryPrintData () const
pure virtual

Returns the print data that the resource data is using.

Returns
IPrintData* - pointer to the IPrintData being used - maybe nil
virtual void IInkResourceData::SetGradientMeshUsed (const bool8 bGradientMeshUsed)
pure virtual

Set whether a gradient mesh paint server is used in the pub

Parameters
bGradientUsedIN kTrue if gradient mesh used, kFalse otherwise
virtual void IInkResourceData::SetGradientUsed (const bool8 bGradientUsed)
pure virtual

Set whether a gradient paint server is used in the pub.

Parameters
bGradientUsedIN kTrue if gradient used, kFalse otherwise
virtual void IInkResourceData::Setup (IInkListiInkList,
IPrintDataiPrintData 
)
pure virtual

The creating code needs to call Setup with the current IInkList. If printing, pass the IPrintData for the second parameter, or nil otherwise.

Parameters
iInkListIN current IInkList being used
iPrintDataIN current IPrintData being used, or nil