IMixedInkGroupOptionCmdData Class Reference

#include <IMixedInkGroupOptionCmdData.h>

Inheritance diagram for IMixedInkGroupOptionCmdData:

Public Types
enum	{ kDefaultIID = IID_IMIXEDINKGROUPOPTIONCMDDATA }

Public Member Functions
virtual void	SetOldInkUIDList (const UIDList &oldInkUIDList)=0
virtual const UIDList *	GetOldInkUIDListRef (void)=0
virtual void	SetInkReplacementUIDList (const UIDList &replacementInkUIDList)=0
virtual const UIDList *	GetInkReplacementUIDListRef (void)=0
virtual void	SetSpotInksReplacementSwatchUIDList (const UIDList &replacedSpotInkUIDList, const UIDList &replacementSwatchUIDList)=0
virtual const UIDList *	GetReplacementSwatchUIDListRef (void)=0
virtual const UIDList *	GetReplacedSpotInkUIDListRef (void)=0
virtual void	SetConvertToProcess (bool16)=0
virtual bool16	GetConvertToProcess (void)=0
virtual void	SetInkGroupName (const PMString &name)=0
virtual PMString	GetInkGroupName (void)=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 NewMixedInkGroupCmd. This interface sets and retrieve data required creating mixed ink swatch group. Mixed ink swatch group is created based on an ink list. Each ink has an initial value, a step value, and a repeat count.

Member Function Documentation

virtual bool16 IMixedInkGroupOptionCmdData::GetConvertToProcess ( void  )

pure virtual

Returns convert to process flag.

Returns

kTrue if converting mixed ink group to proces.

virtual PMString IMixedInkGroupOptionCmdData::GetInkGroupName ( void  )

pure virtual

Returns the name for the new mixed ink group.

Returns

the name for the new mixed ink group.

virtual const UIDList* IMixedInkGroupOptionCmdData::GetInkReplacementUIDListRef ( void  )

pure virtual

Returns the mixed ink group's replacement ink UID list..

Returns

a const UIDList* to the mixed ink group's replacement ink UIDList.

virtual const UIDList* IMixedInkGroupOptionCmdData::GetOldInkUIDListRef ( void  )

pure virtual

Returns the mixed ink group's old ink UID list..

Returns

a const UIDList* to the mixed ink group's old ink UID list..

virtual const UIDList* IMixedInkGroupOptionCmdData::GetReplacedSpotInkUIDListRef ( void  )

pure virtual

Returns the list of spot ink UIDs to be replaced.

Returns

a const UIDList* to list of spot ink UIDs that will be replaced.

virtual const UIDList* IMixedInkGroupOptionCmdData::GetReplacementSwatchUIDListRef ( void  )

pure virtual

Returns the mixed ink group's replacement swatch UID list.

Returns

a const UIDList* to the mixed ink group's replacement swatch UIDList. This UID list contains kInkUIDNotChanged, spot color swatch, process color swatch and/or kInvalidUID.

virtual void IMixedInkGroupOptionCmdData::SetConvertToProcess ( bool16  )

pure virtual

Sets convert to process flag. If this is set to kTrue, then ink list replacement settings are ignored.

virtual void IMixedInkGroupOptionCmdData::SetInkGroupName ( const PMString &  name )

pure virtual

Sets the name for the new mixed ink group. If this is set, then the names of all the mixed ink swatches that are linked to the parent swatch will be changed.

Parameters

name	is the new name for the mixed ink group.

virtual void IMixedInkGroupOptionCmdData::SetInkReplacementUIDList ( const UIDList &  replacementInkUIDList )

pure virtual

Set the replacement ink UIDs for the ink list specified by call to SetOldInkUIDList. Inks that are not replaced are specified in the same location by kInkUIDNotChanged. Inks that are removed are specified in the same location by kInvalidUID. The size of the list should match the size of the oldInkUIDList specified.

Parameters

replacementInkUIDList

the replacement ink UID list..

virtual void IMixedInkGroupOptionCmdData::SetOldInkUIDList ( const UIDList &  oldInkUIDList )

pure virtual

Specify the old ink UID list. to be changed. This should match the exising mixed ink parent swatch's ink UID list.

Parameters

oldInkUIDList

the old ink UID list..

virtual void IMixedInkGroupOptionCmdData::SetSpotInksReplacementSwatchUIDList ( const UIDList &  replacedSpotInkUIDList, const UIDList &  replacementSwatchUIDList  )

pure virtual

Set the replacement swatch UIDs for the ink list specified by call to SetOldInkUIDList. Inks can be (1) unchanged, (2) converted to process, (3) replaced by spot color UID, and (4) replaced by a process color swatch. (1) Inks that are not replaced are specified in the same location by kInkUIDNotChanged. (2) Inks that are converted to process are specified in the same location by kInvalidUID. (3) Inks that are repalced by another spot color swatch are specifiec in the same location by the spot color swatch UID. (4) Inks replaced by a process color swatch are specified in the same location by the process color UID. The size of the list should match the size of the oldInkUIDList specified.

Parameters

replacedSpotInkUIDList	is the list of spot inks to be replaced.
replacementSwatchUIDList	is the list of swatch replacement UIDs.