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

#include <INewMixedInkGroupCmdData.h>

Inheritance diagram for INewMixedInkGroupCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_INEWMIXEDINKGROUPCMDDATA }
 

Public Member Functions

virtual const UIDListGetInkUIDListRef (void)=0
 
virtual void AddInk (const UIDRef &inkRef, const PMReal &initialValue, const PMReal &stepValue, int32 repeatCount)=0
 
virtual PMReal GetInkStartValue (UID inkUID)=0
 
virtual PMReal GetInkStepValue (UID inkUID)=0
 
virtual int32 GetInkRepeatCount (UID inkUID)=0
 
virtual void SetInkGroupName (const PMString &name)=0
 
virtual PMString GetInkGroupName (void)=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

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 void INewMixedInkGroupCmdData::AddInk (const UIDRefinkRef,
const PMRealinitialValue,
const PMRealstepValue,
int32 repeatCount 
)
pure virtual

Add a ink and the corresponding data to the command's ink UIDList.

Parameters
inkRefthe ink UIDRef to add to the list.
initialValuethe initial value for this ink. The initial value should be between 0% and 100%.
stepValuethe incremental value for this ink each time it is repeated. The step value should be between 0% and 100%.
repeatCountthe number of increments for this ink. The repeat count should be between 1 and 100.
virtual PMString INewMixedInkGroupCmdData::GetInkGroupName (void )
pure virtual

Returns the name for the new mixed ink group.

Returns
the name for the new mixed ink group.
virtual int32 INewMixedInkGroupCmdData::GetInkRepeatCount (UID inkUID)
pure virtual

Get the repeat count for the specified ink.

Parameters
inkUIDis the specified ink.
Returns
the repeat count for this ink. If value is -1, this means the specified ink is not in the ink list.
virtual PMReal INewMixedInkGroupCmdData::GetInkStartValue (UID inkUID)
pure virtual

Get the initial value for the specified ink.

Parameters
inkUIDis the specified ink.
Returns
the initial value for this ink. If value is -1, this means the specified ink is not in the ink list.
virtual PMReal INewMixedInkGroupCmdData::GetInkStepValue (UID inkUID)
pure virtual

Get the step value for the specified ink.

Parameters
inkUIDis the specified ink.
Returns
the step value for this ink. If value is -1, this means the specified ink is not in the ink list.
virtual const UIDList* INewMixedInkGroupCmdData::GetInkUIDListRef (void )
pure virtual

Returns the ink UIDList for the creation of the mixed ink group.

virtual void INewMixedInkGroupCmdData::SetInkGroupName (const PMStringname)
pure virtual

Sets the name for the new mixed ink group.

Parameters
nameis the name for the new mixed ink group.