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

#include <IDuotoneInfo.h>

Inheritance diagram for IDuotoneInfo:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDUOTONEINFO }
 

Public Member Functions

virtual void AppendDuotoneInk (const PMString &inkName, int32 colorSpace, const ColorArray &colorData, uint8 *clut)=0
 
virtual void RemoveInk (uint32 index)=0
 
virtual void Clear ()=0
 
virtual void SetInkName (uint32 index, const PMString &newName)=0
 
virtual void SetInkColor (uint32 index, int32 colorSpace, const ColorArray &colorData)=0
 
virtual void SetInkCLUT (uint32 index, uint8 *clut)=0
 
virtual uint32 GetNumberInks () const =0
 
virtual PMString GetNthInkName (uint32 index) const =0
 
virtual int32 GetNthInkColorSpace (uint32 index) const =0
 
virtual ColorArray GetNthInkColorData (uint32 index) const =0
 
virtual ErrorCode GetNthInkCLUT (uint32 index, uint8 *clut) 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 holding the duotone ink information for placed graphics such as Photoshop (PSD) files.

Member Function Documentation

virtual void IDuotoneInfo::AppendDuotoneInk (const PMStringinkName,
int32 colorSpace,
const ColorArraycolorData,
uint8 * clut 
)
pure virtual

Append an ink into the interface.

Parameters
inkNameIN a PMString containing a ink name.
colorSpaceIN the color space of the ink, i.e. kPMCsCalCMYK
colorDataIN the color space's color data information
clutIN a pointer to a 256 byte array containing the inks CLUT. The information is copied out of the CLUT that is passed in.
virtual void IDuotoneInfo::Clear ()
pure virtual

Clear all inks out of the interface.

virtual ErrorCode IDuotoneInfo::GetNthInkCLUT (uint32 index,
uint8 * clut 
) const
pure virtual

Get the ink CLUT of a given ink index.

Parameters
indexIN the index (0 based) of the ink to get.
clutOUT a pointer to a 256 byte array to recieve CLUT values.
Returns
ErrorCode - kSuccess if successful, kFailure otherwise
virtual ColorArray IDuotoneInfo::GetNthInkColorData (uint32 index) const
pure virtual

Get the ink color data of a given ink index.

Parameters
indexIN the index (0 based) of the ink to get.
Returns
ColorArray of the ink color data - see IColorData.h
virtual int32 IDuotoneInfo::GetNthInkColorSpace (uint32 index) const
pure virtual

Get the ink color space of a given ink index.

Parameters
indexIN the index (0 based) of the ink to get.
Returns
int32 of the ink color space, i.e. kPMCsCalCMYK
virtual PMString IDuotoneInfo::GetNthInkName (uint32 index) const
pure virtual

Get the ink name of a given ink index.

Parameters
indexIN the index (0 based) of the ink to get.
Returns
PMString of the ink name.
virtual uint32 IDuotoneInfo::GetNumberInks () const
pure virtual

Get the number of inks currently stored in the interface. For use when iterating through the inks, setting or getting specific information. 1 ink == Monotone image, 2 inks == Duotone image, 3 inks == Tritone image, 4 inks == Quadtone image.

Returns
int32 of the number of inks.
virtual void IDuotoneInfo::RemoveInk (uint32 index)
pure virtual

Remove a ink from the interface.

Parameters
indexIN the index (0 based) of the ink to remove.
virtual void IDuotoneInfo::SetInkCLUT (uint32 index,
uint8 * clut 
)
pure virtual

Set the ink CLUT information of a given ink index.

Parameters
indexIN the index (0 based) of the ink to change.
clutIN a pointer to an array of 256 entries ranging from 0x00 to 0xFF. The CLUT data is copied out of the array that is passed in.
virtual void IDuotoneInfo::SetInkColor (uint32 index,
int32 colorSpace,
const ColorArraycolorData 
)
pure virtual

Set the ink color information of a given ink index.

Parameters
indexIN the index (0 based) of the ink to change.
colorSpaceIN the new color space to be given to the ink, i.e. kPMCsCalCMYK
colorDataIN the color space's color data information
virtual void IDuotoneInfo::SetInkName (uint32 index,
const PMStringnewName 
)
pure virtual

Set the ink name of a given ink index.

Parameters
indexIN the index (0 based) of the ink to rename.
newNameIN the new name to be given to the ink