IInkData Class Reference

#include <IInkData.h>

Inheritance diagram for IInkData:

Public Types
enum	{ kDefaultIID = IID_IINKDATA }
enum	InkType {   kUndefinedInk = -1, kProcessInk, kSpotInk, kRegistrationInk,   kDeviceNInk }

Public Member Functions
virtual PersistUIDList	GetInkUIDList () const =0
virtual int32	GetNumInkComponents () const =0
virtual InkType	GetInkType () const =0
virtual void	SetInkUIDList (const PersistUIDList &uidInkList)=0
virtual void	SetInkType (InkType inkType)=0
virtual bool16	IsEqual (const IInkData *iInkData) const =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

An interface for InDesign color object.

Member Enumeration Documentation

enum IInkData::InkType

Identifies the ink types

Enumerator
kUndefinedInk	Used to specified an undefined ink type or ink type unchanged.
kProcessInk	Used to specified a process ink type,
kSpotInk	Used to specified a spot ink type.
kRegistrationInk	Used to specified a registration ink type.
kDeviceNInk	Used to specified an mixed-ink ink type. There should be only one such ink type in a swatch list.

Member Function Documentation

virtual InkType IInkData::GetInkType ( ) const

pure virtual

Returns the color definition's ink type. This is one of kProcessInk, kSpotInk, kDeviceNInk, or kRegistrationInk.

Returns

the ink type.

virtual PersistUIDList IInkData::GetInkUIDList ( ) const

pure virtual

Returns the list of ink UIDs associated with the color definition. If color definition is a process ink, then this list should be empty. If color definition is a spot ink, then this list should have only one entry. If color definition is a deviceN ink, then this list should contain 2 or more inks.

Returns

the color definition's ink UID list.

virtual int32 IInkData::GetNumInkComponents ( ) const

pure virtual

Returns the number of ink components associated with the color definition. For process ink, this is 0. For spot ink, this number should be 1. For deviceN inks, this number is >= 2.

Returns

the number of ink components.

virtual bool16 IInkData::IsEqual ( const IInkData *  iInkData ) const

pure virtual

Returns kTrue if both IInkData* are equal.

Parameters

iInkData

to compare with.

Returns

kTrue if both IInkData* are equal.

virtual void IInkData::SetInkType ( InkType  inkType )

pure virtual

Sets the ink type for the color definition. Ink type should be one of kProcessInk, kSpotInk, kDeviceNInk, or kRegistrationInk. Ink type should remained as kUndefinedInk if defining a color that is based on another.

Parameters

inkType

the new ink type to set. Typically SetInkUIDList is set through either NewColorCmdBoss, ChangeColorCmdBoss, kNewMixedInkGroupCmdBoss, or kChangeMixedInkGroupCmdBoss.

virtual void IInkData::SetInkUIDList ( const PersistUIDList &  uidInkList )

pure virtual

Sets the new inks associated for this color definition. If color definition is a process ink, then this list should be empty. If color definition is a spot ink, then this list should have only one entry. If color definition is a deviceN ink, then this list should contain 2 or more inks.

Parameters

uidInkList

the ink list to set. Typically SetInkUIDList is set through either NewColorCmdBoss, ChangeColorCmdBoss, kNewMixedInkGroupCmdBoss, or kChangeMixedInkGroupCmdBoss. For deviceN ink, the client would specify a list of ink UIDs and set through command's IInkData interface. For spot ink, this should be left empty. The appropriate commands (NewColorCmdBoss or ChangeColorCmdBoss) will set this field.