#include <IInkResourceData.h>
Records the ink usage for different types of page items. This is the data interface that is passed through the GetUsedInks() method of IInkResources, to store off ink usage results.
- See Also
- IInkResources
| virtual void IInkResourceData::AddInk | ( | UIDRef | inkUIDRef | ) | |
| pure virtual |
Add a used ink. The implementation of this interface guarantees that only one instance of an ink is stored. Implementations of this interface and users of this interface assume that the ink UID exists in the ink list that was passed into Setup.
- Parameters
| inkUIDRef | IN the ink being used by the page item |
| virtual void IInkResourceData::AddProcessBlack | ( | | ) | |
| pure virtual |
Shortcut method for adding process Black.
| virtual void IInkResourceData::AddProcessCyan | ( | | ) | |
| pure virtual |
Shortcut method for adding process Cyan.
| virtual void IInkResourceData::AddProcessMagenta | ( | | ) | |
| pure virtual |
Shortcut method for adding process Magenta.
| virtual void IInkResourceData::AddProcessYellow | ( | | ) | |
| pure virtual |
Shortcut method for adding process Yellow.
| virtual bool8 IInkResourceData::AllProcessInksUsed | ( | | ) | const |
| pure virtual |
Performance improving method that tells clients if all process inks are already used. If true, the client can skip adding it's resources as it already knows. they all exist.
- Returns
- bool8 - kTrue if all process inks already registered as being used, kFalse otherwise
| virtual void IInkResourceData::Clear | ( | | ) | |
| pure virtual |
Remove all entries from the list and remove the reference to the doc ink list.
Copy an existing ink resource data list into this list.
- Parameters
| srcData | IN source ink resource data |
| virtual bool8 IInkResourceData::GetGradientMeshUsed | ( | | ) | const |
| pure virtual |
Tells whether a gradient mesh paint server is used in the pub - print code will not download the gradient mesh paint server procset if this is false
- Returns
- bool8 - kTrue if gradient mesh used, kFalse otherwise
| virtual bool8 IInkResourceData::GetGradientUsed | ( | | ) | const |
| pure virtual |
Tells whether a gradient paint server is used in the pub - print code will not download the gradient paint server procset if this is false.
- Returns
- bool8 kTrue if gradient used, kFalse otherwise
| virtual UID IInkResourceData::GetNthInk | ( | int32 | n | ) | const |
| pure virtual |
Retrieve the UID of the Nth ink being used.
- Parameters
| n | IN which ink to retrieve |
- Returns
- UID the UID of the Nth ink
| virtual int32 IInkResourceData::GetNumInks | ( | | ) | const |
| pure virtual |
Retrieve the number of inks being used.
- Returns
- int32 - the number of inks being used
| virtual IInkList* IInkResourceData::QueryInkList | ( | | ) | const |
| pure virtual |
Returns the ink list that the resource data is using.
- Returns
- IInkList* - pointer to the IInkList being used
| virtual IPrintData* IInkResourceData::QueryPrintData | ( | | ) | const |
| pure virtual |
Returns the print data that the resource data is using.
- Returns
- IPrintData* - pointer to the IPrintData being used - maybe nil
| virtual void IInkResourceData::SetGradientMeshUsed | ( | const bool8 | bGradientMeshUsed | ) | |
| pure virtual |
Set whether a gradient mesh paint server is used in the pub
- Parameters
| bGradientUsed | IN kTrue if gradient mesh used, kFalse otherwise |
| virtual void IInkResourceData::SetGradientUsed | ( | const bool8 | bGradientUsed | ) | |
| pure virtual |
Set whether a gradient paint server is used in the pub.
- Parameters
| bGradientUsed | IN kTrue if gradient used, kFalse otherwise |
The creating code needs to call Setup with the current IInkList. If printing, pass the IPrintData for the second parameter, or nil otherwise.
- Parameters