#include <IEPSTagTable.h>

Inheritance diagram for IEPSTagTable:

Public Member Functions
virtual ErrorCode	GetFontNeeded (uint32 item, PMString *name)=0

virtual ErrorCode	GetFontSupplied (uint32 item, PMString *name)=0

virtual ErrorCode	GetProcSetNeeded (uint32 item, PMString name, ProcSetInfo pProc)=0

virtual ErrorCode	GetProcSetSupplied (uint32 item, PMString name, ProcSetInfo pProc)=0

virtual ErrorCode	GetNInkColor (uint32 item, PMString name, MultiInkColor pHifi)=0

virtual ErrorCode	GetInk (uint32 item, PMString name, uint16 pNeutralDensity)=0

virtual ErrorCode	GetProcessColorsUsed (bool8 pCyan, bool8 pMagenta, bool8 pYellow, bool8 pBlack)=0

virtual ErrorCode	GetRGBCustomColor (uint32 item, PMString name, RGBApprox pRGB)=0

virtual ErrorCode	GetCMYKCustomColor (uint32 item, PMString name, CMYKApprox pCMYK)=0

virtual ErrorCode	GetCMYKProcessColor (uint32 item, PMString name, CMYKApprox pCMYK)=0

virtual ErrorCode	GetImageFileName (uint32 item, PMString *fileName)=0

virtual ErrorCode	GetImage2FileName (uint32 item, PMString *fileName)=0

virtual ErrorCode	GetHasDCSPlates (uint32 item, bool8 *bHasDCSPlates)=0

virtual ErrorCode	GetDCSPlateFile (uint32 item, PMString plateName, PMString fileName)=0

virtual ErrorCode	GetDCSPlateFile (uint32 item, PMString plateName, uint32 offset, uint32 *length)=0

virtual ErrorCode	GetImageBounds (uint32 item, PMRect &imageBounds)=0

virtual ErrorCode	GetCreator (uint32 item, PMString *creator)=0

virtual ErrorCode	GetLanguageLevel (uint32 item, uint16 *langLevel)=0

virtual ErrorCode	GetDocumentData (uint32 item, PMString *docData)=0

virtual ErrorCode	GetImageData (uint32 item, ImageDataData imageData, PMString dataStart)=0

virtual ErrorCode	GetArchImageData (uint32 item, ImageDataData imageData, PMString dataStart)=0

virtual ErrorCode	GetContainsXMP (uint32 item, PMString *containsXMP)=0

virtual ErrorCode	GetPhotoShopClipData (uint32 item, PMString pPSClipData, uint32 pPSClipDataSize)=0

virtual ErrorCode	MatchFile (const PMString &fileToFind, PMString *fileFound)=0

virtual void	AppendTagData (int16 tag, int32 DataSize=0, void Data=nil, int32 varibleData1Size=0, void varibleData1=nil, int32 varibleData2Size=0, void *varibleData2=nil)=0

virtual void	Reset (void)=0

virtual ErrorCode	GetPhotoShopClipData (uint32 item, std::string pPSClipData, uint32 pPSClipDataSize)=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

This interface allows access EPSTagTable data. EPSTagTable is a collection of EPS Tag data. An EPS tag data is from the result of EPS comment parsing. EPS tag data contains information from the EPS image, such as font, color usage, image replacement info. etc. The get methods query EPS resources. They return kFailure if no more such resource is found, otherwise they return kSuccess. The item parameter specifies which block to get, 0 the first one, 1, the second one, etc.

Member Function Documentation

virtual void IEPSTagTable::AppendTagData	(	int16	tag,
		int32	DataSize = `0`,
		void *	Data = `nil`,
		int32	varibleData1Size = `0`,
		void *	varibleData1 = `nil`,
		int32	varibleData2Size = `0`,
		void *	varibleData2 = `nil`
	)

pure virtual

Append data to the tag table - NOTE: This method should only be called by code internal to the EPSImport plugin - don't use.

virtual ErrorCode IEPSTagTable::GetArchImageData	(	uint32	item,
		ImageDataData *	imageData,
		PMString *	dataStart
	)

pure virtual

Get image data information - from ArchImageData comment.

Parameters

item	IN zero based iterant
imageData	OUT more information about the image data - see EPSTagTableData.h
dataStart	OUT the data start marker string

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetCMYKCustomColor	(	uint32	item,
		PMString *	name,
		CMYKApprox *	pCMYK
	)

pure virtual

Get the CMYK spot colors - from %CMYKCustomColor comment. NOTE: tags are only produced for CMYKCustomColors that appear in the %DocumentCustomColors list.

Parameters

item	IN zero based iterant
name	OUT the name of the Nth (item) ink
pCMYK	OUT more information about the ink - see EPSTagTableData.h

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetCMYKProcessColor	(	uint32	item,
		PMString *	name,
		CMYKApprox *	pCMYK
	)

pure virtual

Get the CMYK process colors - from %CMYKProcessColor (only if option turned on). NOTE: this option is not supported - don't use.

Parameters

item	IN zero based iterant
name	OUT the name of the Nth (item) ink
pCMYK	OUT more information about the ink - see EPSTagTableData.h

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetContainsXMP	(	uint32	item,
		PMString *	containsXMP
	)

pure virtual

Get the contains XMP string - from ADO_ContainsXMP comment.

Parameters

item	IN zero based iterant
containsXMP	OUT the contains XMP string (i.e. NoMain, MainFirst or MainLast)

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetCreator	(	uint32	item,
		PMString *	creator
	)

pure virtual

Get the creator - from %Creator comment.

Parameters

item	IN zero based iterant
creator	OUT the creator string

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetDCSPlateFile	(	uint32	item,
		PMString *	plateName,
		PMString *	fileName
	)

pure virtual

Get DCS plate file information - from %CyanPlate (DCS 1.0) or %PlateFile (DCS 2.0 - multi file).

Parameters

item	IN zero based iterant
plateName	OUT plate name found
fileName	OUT plate file name found

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetDCSPlateFile	(	uint32	item,
		PMString *	plateName,
		uint32 *	offset,
		uint32 *	length
	)

pure virtual

Get DCS plate file information - from %PlateFile (DCS 2.0 - single file).

Parameters

item	IN zero based iterant
plateName	OUT plate name found
offset	OUT plate offset
length	OUT plate length

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetDocumentData	(	uint32	item,
		PMString *	docData
	)

pure virtual

Get the document data - from %DocumentData comment.

Parameters

item	IN zero based iterant
docData	OUT the document data string

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetFontNeeded	(	uint32	item,
		PMString *	name
	)

pure virtual

Get font needed information - from %DocumentNeededFonts comment.

Parameters

item	IN zero based iterant
name	OUT the name of the Nth (item) font needed

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetFontSupplied	(	uint32	item,
		PMString *	name
	)

pure virtual

Get font supplied information - from %DocumentSuppliedFonts comment.

Parameters

item	IN zero based iterant
name	OUT the name of the Nth (item) font supplied

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetHasDCSPlates	(	uint32	item,
		bool8 *	bHasDCSPlates
	)

pure virtual

Get whether file has DCS plates. True if %CyanPlate (DCS 1.0) or %PlateFile (DCS 2.0) was seen.

Parameters

item	IN zero based iterant
bHasDCSPlates	OUT kTrue if DCS plates found, kFalse otherwise

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetImage2FileName	(	uint32	item,
		PMString *	fileName
	)

pure virtual

Get OPI image name - from ImageFileName (OPI 2.0). NOTE: OPI tags are not created unless the option is turned on when importing.

Parameters

item	IN zero based iterant
fileName	OUT the name of the Nth (item) image

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetImageBounds	(	uint32	item,
		PMRect &	imageBounds
	)

pure virtual

Get the bounding box for the EPS - from the %BoundingBox comment.

Parameters

item	IN zero based iterant
imageBounds	OUT the bounding box rect

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetImageData	(	uint32	item,
		ImageDataData *	imageData,
		PMString *	dataStart
	)

pure virtual

Get image data information - from %ImageData comment.

Parameters

item	IN zero based iterant
imageData	OUT more information about the image data - see EPSTagTableData.h
dataStart	OUT the data start marker string

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetImageFileName	(	uint32	item,
		PMString *	fileName
	)

pure virtual

Get OPI image name - from ALDImageFileName (OPI 1.3). NOTE: OPI tags are not created unless the option is turned on when importing.

Parameters

item	IN zero based iterant
fileName	OUT the name of the Nth (item) image

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetInk	(	uint32	item,
		PMString *	name,
		uint16 *	pNeutralDensity
	)

pure virtual

Get ink information - from ADBDocumentInks comment.

Parameters

item	IN zero based iterant
name	OUT the name of the Nth (item) ink
pNeutralDensity	OUT the neutral density for the ink

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetLanguageLevel	(	uint32	item,
		uint16 *	langLevel
	)

pure virtual

Get the language level - from %LanguageLevel comment

Parameters

item	IN zero based iterant
langLevel	OUT the language level

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetNInkColor	(	uint32	item,
		PMString *	name,
		MultiInkColor *	pHifi
	)

pure virtual

Get NInk color information - from ADBDocumentMultiInkColors comment. NOTE: InDesign currently does not support hifi colors.

Parameters

item	IN zero based iterant
name	OUT the name of the Nth (item) ink
pHifi	OUT more information about the ink - see EPSTagTableData.h

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetPhotoShopClipData	(	uint32	item,
		PMString *	pPSClipData,
		uint32 *	pPSClipDataSize
	)

pure virtual

OBSOLETE. Use GetPhotoShopClipData with std::string instead Get the Photoshop clipping data - data between BeginPhotoshop and EndPhotoshop comments.

Parameters

item	IN zero based iterant
pPSClipData	OUT the clipping data
pPSClipDataSize	OUT the clipping data size

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetPhotoShopClipData	(	uint32	item,
		std::string *	pPSClipData,
		uint32 *	pPSClipDataSize
	)

pure virtual

Get the Photoshop clipping data - data between BeginPhotoshop and EndPhotoshop comments.

Parameters

item	IN zero based iterant
pPSClipData	OUT the clipping data
pPSClipDataSize	OUT the clipping data size

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetProcessColorsUsed	(	bool8 *	pCyan,
		bool8 *	pMagenta,
		bool8 *	pYellow,
		bool8 *	pBlack
	)

pure virtual

Get the process colors used - from %DocumentProcessColors comment.

Parameters

pCyan	OUT kTrue if Cyan is used
pMagenta	OUT kTrue if Magenta is used
pYellow	OUT kTrue if Yello is used
pBlack	OUT kTrue if Black is used

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetProcSetNeeded	(	uint32	item,
		PMString *	name,
		ProcSetInfo *	pProc
	)

pure virtual

Get proc set needed information - from %DocumentNeededProcSets or %DocumentNeededResource procset comment.

Parameters

item	IN zero based iterant
name	OUT the name of the Nth (item) proc set needed
pProc	OUT more information about the proc set - see EPSTagTableData.h

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetProcSetSupplied	(	uint32	item,
		PMString *	name,
		ProcSetInfo *	pProc
	)

pure virtual

Get proc set supplied information - from %DocumentSuppliedProcSets or %DocumentSuppliedResource procset comment.

Parameters

item	IN zero based iterant
name	OUT the name of the Nth (item) proc set supplied
pProc	OUT more information about the proc set - see EPSTagTableData.h

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::GetRGBCustomColor	(	uint32	item,
		PMString *	name,
		RGBApprox *	pRGB
	)

pure virtual

Get the RGB spot colors - from %RGBCustomColor comment.

Parameters

item	IN zero based iterant
name	OUT the name of the Nth (item) ink
pRGB	OUT more information about the ink - see EPSTagTableData.h

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual ErrorCode IEPSTagTable::MatchFile	(	const PMString &	fileToFind,
		PMString *	fileFound
	)

pure virtual

File matching method for file replacement. Caller will be able to find the matching file name given the file name (such as DCS plate file and OPI image file) in the original EPS file.

Parameters

fileToFind	IN the file to find
fileFound	OUT the matching name

Returns: ErrorCode - kSuccess if successful, kFailure otherwise

virtual void IEPSTagTable::Reset ( void )

pure virtual

Reset the tag table - NOTE: This method should only be called by code internal to the EPSImport plugin - don't use.

Public Member Functions

Detailed Description

Member Function Documentation