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

#include <IInkList.h>

Inheritance diagram for IInkList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINKLIST }
 
enum  { kExcludeNonPrintingInks = (1L<<0) }
 
enum  { kExcludeProcessInks = (1L<<1) }
 
enum  { kExcludeAliasedInks = (1L<<2) }
 
enum  { kExcludeAsProcessInks = (1L<<3) }
 
enum  { kNotFound = -1 }
 

Public Member Functions

virtual void Init () const =0
 
virtual UIDRef FindInk (IPMInkBossData *inkBossData) const =0
 
virtual UIDRef FindInk (const PMString &inkname) const =0
 
virtual int32 FindInk (const UID &inkUID) const =0
 
virtual int32 GetNumInks () const =0
 
virtual UIDRef GetNthInk (int32 index) const =0
 
virtual void AddInk (const UID &inkUID)=0
 
virtual void RemoveInk (const UID &inkUID)=0
 
virtual UIDList GetPlateOrderInkList (int32 flags) const =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

An interface for managing InDesign ink list. InDesign inks are kPMInkDataBoss objects with reqruied IPMInkBossData interface. Ink list consists of at least 4 process inks and zero of more spot inks. Inks are ref-counted.

See Also
ColorSystemID.h

Member Enumeration Documentation

anonymous enum

Defines which inks are included and how inks are ordered in the list. They are flag bits used in GetPlatOrderInkList.

See Also
GetPlatOrderInkListSpecifies non-printing inks should be excluded from the list.
anonymous enum

Specifies all process inks and all converted to process inks should be excluded from the list.

anonymous enum

Specifies all aliased inks should be excluded from the list.

anonymous enum

Specifies all converted to process inks (but not normal process inks) should be excluded from the list.

Member Function Documentation

virtual void IInkList::AddInk (const UIDinkUID)
pure virtual

Add the specified inkUID in the list. If the specified ink already exists, the ink's ref-count is incremented.

Parameters
inkUIDthe ink to add.
virtual UIDRef IInkList::FindInk (IPMInkBossDatainkBossData) const
pure virtual

Find the ink with the specified IPMInkBossData.

Parameters
InkDatathe ink data to find.
Returns
ink UIDRef for the ink data. If not found, returns UIDRef::gNull.
See Also
IPMInkBossData
virtual UIDRef IInkList::FindInk (const PMStringinkname) const
pure virtual

Find the ink with the specified inkName in the ink list.

Parameters
inknamethe ink name to find.
Returns
ink UIDRef for the ink name. If not found, returns UIDRef::gNull.
virtual int32 IInkList::FindInk (const UIDinkUID) const
pure virtual

Find the ink location index in the list with the specified ink UID.

Parameters
inkUIDthe ink UID to find.
Returns
the index in the list starting with index 0. If no such UID is found, returns -1.
virtual UIDRef IInkList::GetNthInk (int32 index) const
pure virtual

Returns the nth ink in the list.

Parameters
indexthe nth ink starting from 0.
Returns
the nth ink in the list. If index is not in the range, returns -1.
virtual int32 IInkList::GetNumInks () const
pure virtual

Returns the number of inks in the list.

Returns
the number of inks in the list.
virtual UIDList IInkList::GetPlateOrderInkList (int32 flags) const
pure virtual

Returns a UIDList that has been pre-sorted in plate order.

Parameters
flagsdefines how inks should be included in this list.
Returns
the ink UIDList containing the requested inks in the specified order.
virtual void IInkList::Init () const
pure virtual

Bootstrap the ink list. This initializes the ink list with the four process inks: Cyan, Magenta, Yellow, and Black.

virtual void IInkList::RemoveInk (const UIDinkUID)
pure virtual

Remove the specified inkUID in the list. If the specified ink exists, the ink's ref-count is decremented first. When the ref-count is 0, the ink is removed from the list. If ink deos not exist, it does nothing.

Parameters
inkUIDthe ink to remove.