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

#include <IEPSAttributes.h>

Inheritance diagram for IEPSAttributes:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IEPSATTRIBUTES }
 
enum  DrawEPSOption { kDrawEPSNormal, kDrawEPSGrayBox, kDrawEPSProxy, kDrawEPSDispList }
 

Public Member Functions

virtual void SetBoundingBox (const PMRect &bbox)=0
 
virtual void SetTargetRes (const PMReal &targetRes)=0
 
virtual void SetAddProcessColors (const bool16 bAddProColor)=0
 
virtual void SetImportDCS (const bool16 bImportDCS)=0
 
virtual void SetReadOPI (const bool16 bReadOPI)=0
 
virtual void SetCreateFrame (const bool16 bCreateFrame)=0
 
virtual void SetEPSFlags (const EPSPSFlags flags)=0
 
virtual void SetDrawEPSOption (DrawEPSOption drawOption)=0
 
virtual PMRect GetBoundingBox () const =0
 
virtual PMReal GetTargetRes () const =0
 
virtual bool16 GetAddProcessColors () const =0
 
virtual bool16 GetImportDCS () const =0
 
virtual bool16 GetReadOPI () const =0
 
virtual bool16 GetCreateFrame () const =0
 
virtual EPSPSFlags GetEPSFlags () const =0
 
virtual DrawEPSOption GetDrawEPSOption () const =0
 
virtual const UIDListCreateUsedColorUIDList (const UIDList *pUIDList)=0
 
virtual void AppendToUsedColorUIDList (const UID colorUID)=0
 
virtual const UIDListGetUsedColorUIDList () const =0
 
virtual void ReplaceUsedColorUID (const UID, const UID)=0
 
virtual K2Vector< PMString > * GetEPSOriginalyImportedColorNameList ()=0
 
virtual PMString GetEPSColorName (const PMString &)=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

Primarily this interface holds the settings that were used when the EPS was imported. These settings are reused when the link is updated.

Member Enumeration Documentation

drawing options for the EPS
Enumerator
kDrawEPSNormal 

draw as normal

kDrawEPSGrayBox 

draw as gray box

kDrawEPSProxy 

draw EPS proxy

kDrawEPSDispList 

draw EPS display list

Member Function Documentation

virtual void IEPSAttributes::AppendToUsedColorUIDList (const UID colorUID)
pure virtual

Append a color swatch UID to the colors used list on the EPS

Parameters
colorUIDthe UID of the swatch color to append
virtual const UIDList* IEPSAttributes::CreateUsedColorUIDList (const UIDListpUIDList)
pure virtual

The following 4 methods are used to manage the color swatches used by the EPS. Create/Append methods are only used during import. The two Get methods are to get the used color UID list and to get the name of the color originally imported. If the returned UIDList is nil, then there aren't any color used in the EPS.Creates a UIDList of color swatches used by the EPS. The existing list, if any, is deleted and a new list is created. If a valid list is passed in, the new list contains it as its single entry; otherwise, the new list is empty.

Parameters
pUIDListIN Swatch UID list to create, or nil if the list is to be created empty
Returns
the newly created UIDList used to store color swatch UIDs for this EPS
virtual bool16 IEPSAttributes::GetAddProcessColors () const
pure virtual

Get add process colors - currently unsupported don't use.

Returns
bool16 kTrue if adding the process colors, kFalse otherwise
virtual PMRect IEPSAttributes::GetBoundingBox () const
pure virtual

Get the bounding box.

Returns
PMRect of the bounding box of the EPS
virtual bool16 IEPSAttributes::GetCreateFrame () const
pure virtual

Get whether to create frame from clipping path.

Returns
bool16 kTrue if creating frame from clipping path, kFalse otherwise
virtual DrawEPSOption IEPSAttributes::GetDrawEPSOption () const
pure virtual

Get the EPS draw option - see DrawEPSOption enum in this header file for more information.

Returns
DrawEPSOption draw option to use
virtual PMString IEPSAttributes::GetEPSColorName (const PMString)
pure virtual

Given the original color name, return the current swatch name mapped to this swatch. In none of the color used were merged, then the name returned should be the same as the name given.

Parameters
PMString&the original color name
Returns
PMString current swatch name mapped to this swatch
virtual EPSPSFlags IEPSAttributes::GetEPSFlags () const
pure virtual

Get the EPSFlags about the EPS - see EPSPSFlags enum in this header file for more information.

Returns
EPSPSFlags settings
virtual K2Vector<PMString>* IEPSAttributes::GetEPSOriginalyImportedColorNameList ()
pure virtual

Get the list of color names originally imported. Pointer may be nil if no colors imported. Caller needs to call delete on the returned string list.

Returns
K2Vector<PMString>* pointer to a vector of original color names.
virtual bool16 IEPSAttributes::GetImportDCS () const
pure virtual

Get import nested DCS - currently unsupported don't use.

Returns
bool16 kTrue if importing the nested DCS, kFalse otherwise
virtual bool16 IEPSAttributes::GetReadOPI () const
pure virtual

Get whether to read nested OPI comments.

Returns
bool16 kTrue if reading OPI comments in EPS, kFalse otherwise
virtual PMReal IEPSAttributes::GetTargetRes () const
pure virtual

Get the target display resolution.

Returns
PMReal of the target display resolution
virtual const UIDList* IEPSAttributes::GetUsedColorUIDList () const
pure virtual

Gets the existing UIDList of color swatches used by this EPS. If the list does not exist, nil is returned.

Returns
the existing UIDList used to store color swatch UIDs for this EPS
virtual void IEPSAttributes::ReplaceUsedColorUID (const UID ,
const UID  
)
pure virtual

Replace a used color UID with a new used color UID - this API is not supported - don't use

Parameters
UIDthe from color UID
UIDthe to color UID
virtual void IEPSAttributes::SetAddProcessColors (const bool16 bAddProColor)
pure virtual

Set add process colors - currently unsupported don't use.

Parameters
bAddProColorIN whether to add the process colors
virtual void IEPSAttributes::SetBoundingBox (const PMRectbbox)
pure virtual

Set the bounding box.

Parameters
bboxIN the bounding box of the EPS
virtual void IEPSAttributes::SetCreateFrame (const bool16 bCreateFrame)
pure virtual

Set whether to create frame from clipping path.

Parameters
bCreateFrameIN kTrue to create frame from clipping path, kFalse otherwise
virtual void IEPSAttributes::SetDrawEPSOption (DrawEPSOption drawOption)
pure virtual

Set the EPS draw option - see DrawEPSOption enum in this header file for more information.

Parameters
drawOptionIN the draw option to use
virtual void IEPSAttributes::SetEPSFlags (const EPSPSFlags flags)
pure virtual

Set the information about the EPS - see EPSPSFlags enum in this header file for more information.

Parameters
flagsIN the EPSPSFlags settings
virtual void IEPSAttributes::SetImportDCS (const bool16 bImportDCS)
pure virtual

Set import nested DCS - currently unsupported don't use.

Parameters
bImportDCSIN whether to import the nested DCS
virtual void IEPSAttributes::SetReadOPI (const bool16 bReadOPI)
pure virtual

Set whether to read nested OPI comments.

Parameters
bReadOPIIN kTrue to read OPI comments in EPS, kFalse otherwise
virtual void IEPSAttributes::SetTargetRes (const PMRealtargetRes)
pure virtual

Set the target display resolution.

Parameters
targetResIN the target display resolution