#include <IInkList.h>
|
| enum | { kDefaultIID = IID_IINKLIST } |
| |
| enum | { kExcludeNonPrintingInks = (1L<<0) } |
| |
| enum | { kExcludeProcessInks = (1L<<1) } |
| |
| enum | { kExcludeAliasedInks = (1L<<2) } |
| |
| enum | { kExcludeAsProcessInks = (1L<<3) } |
| |
| enum | { kNotFound = -1 } |
| |
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
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.
Specifies all process inks and all converted to process inks should be excluded from the list.
Specifies all aliased inks should be excluded from the list.
Specifies all converted to process inks (but not normal process inks) should be excluded from the list.
| virtual void IInkList::AddInk | ( | const UID & | inkUID | ) | |
| pure virtual |
Add the specified inkUID in the list. If the specified ink already exists, the ink's ref-count is incremented.
- Parameters
Find the ink with the specified IPMInkBossData.
- Parameters
| InkData | the ink data to find. |
- Returns
- ink UIDRef for the ink data. If not found, returns UIDRef::gNull.
- See Also
- IPMInkBossData
Find the ink with the specified inkName in the ink list.
- Parameters
| inkname | the ink name to find. |
- Returns
- ink UIDRef for the ink name. If not found, returns UIDRef::gNull.
| virtual int32 IInkList::FindInk | ( | const UID & | inkUID | ) | const |
| pure virtual |
Find the ink location index in the list with the specified ink UID.
- Parameters
| inkUID | the 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
| index | the 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
| flags | defines 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 UID & | inkUID | ) | |
| 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