AINativeAction.h File Reference

#include "AIActionManager.h"

Go to the source code of this file.

Defines
#define	kAINativeFileFormat   "Adobe Illustrator Any Format Writer"
	File format for saving as a native file in kAISaveDocumentAsAction.
#define	kAINativeFileFormatExtension   "ai"
	File extension for saving as a native file in kAISaveDocumentAsAction.
#define	kAIEPSFileFormat   "Adobe Illustrator EPSF"
#define	kAIEPSFileFormatExtension   "eps"
	File extension for saving as an EPS file in kAISaveDocumentAsAction.
Typedefs
typedef enum _AIFileFormatScriptCompatibility	AIFileFormatScriptCompatibility
	Dictionary key values for kAINativeScriptKey and kAIEPSScriptKey.
typedef enum _AIFileFormatFlattening	AIFileFormatFlattening
	Dictionary key values for kAINativeFlatteningOptionKey and kAIEPSFlatteningOptionKey.
typedef enum _AIEPSFilePreview	AIEPSFilePreview
	Dictionary key values for kAIEPSFormatKey.
typedef enum _AIEPSOverprints	AIEPSOverprints
	Dictionary key values for kAIEPSOverprintsKey.
Enumerations
enum	_AIFileFormatScriptCompatibility { kAIFileFormatScriptCompatibleEnglish = 0, kAIFileFormatScriptCompatibleCJK }
	Dictionary key values for kAINativeScriptKey and kAIEPSScriptKey. More...
enum	_AIFileFormatFlattening { kAIFileFormatFlatteningPreservePaths = 0, kAIFileFormatFlatteningPreserveAppearance = 1, kAIFileFormatFlatteningPreserveAppearanceAndOverprints = 2 }
	Dictionary key values for kAINativeFlatteningOptionKey and kAIEPSFlatteningOptionKey. More...
enum	_AIEPSFilePreview {   kAIEPSFilePreviewNone = 1, kAIEPSFilePreviewBWPICT, kAIEPSFilePreviewColorPICT, kAIEPSFilePreviewBWTIFF,   kAIEPSFilePreviewColorTIFF, kAIEPSFilePreviewSimpleColor }
	Dictionary key values for kAIEPSFormatKey. More...
enum	_AIEPSOverprints { kAIEPSFileOverprints_Preserve = 1, kAIEPSFileOverprints_Discard, kAIEPSFileOverprints_Simulate }
	Dictionary key values for kAIEPSOverprintsKey. More...
Variables
const ActionParamKeyID	kAINativeVersionKey = 'crtr'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeScriptKey = 'ext.'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeIncludeImagesKey = 'incl'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeEmbedAllFontsKey = 'embd'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeSubsetFontsBelowKey = 'sbst'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeSubsetFontsRatioKey = 'rato'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeEmbedProfileKey = 'prfl'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeFlatteningOptionKey = 'flat'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeCompressionKey = 'cmpr'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativePDFCompatibilityKey = 'pdf '
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeSaveMultipleArtboardsKey = 'smab'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeSaveAllKey = 'sall'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAINativeSaveRangeKey = 'sran'
	Additional parameter for kAISaveDocumentAsAction when saving as a native file.
const ActionParamKeyID	kAIEPSFormatKey = 'wfmt'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSVersionKey = 'crtr'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSScriptKey = 'ext.'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSIncludePlacedKey = 'iplc'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSIncludeThumbnailKey = 'ithm'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSCompatibleGradientPrintKey = 'cgpt'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSImageFormatKey = 'ifmt'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSCMYKPostScriptKey = 'cmyk'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSIncludeCJKFontsKey = 'icjk'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSPostScriptLevelKey = 'pslv'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSFlatteningOptionKey = 'flat'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSUseDefaultScreensKey = 'dfsc'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.
const ActionParamKeyID	kAIEPSOverprintsKey = 'eopt'
	Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

---

Define Documentation

#define kAIEPSFileFormat   "Adobe Illustrator EPSF"

#define kAIEPSFileFormatExtension   "eps"

File extension for saving as an EPS file in kAISaveDocumentAsAction.

#define kAINativeFileFormat   "Adobe Illustrator Any Format Writer"

File format for saving as a native file in kAISaveDocumentAsAction.

#define kAINativeFileFormatExtension   "ai"

File extension for saving as a native file in kAISaveDocumentAsAction.

---

Typedef Documentation

typedef enum _AIEPSFilePreview AIEPSFilePreview

Dictionary key values for kAIEPSFormatKey.

typedef enum _AIEPSOverprints AIEPSOverprints

Dictionary key values for kAIEPSOverprintsKey.

typedef enum _AIFileFormatFlattening AIFileFormatFlattening

Dictionary key values for kAINativeFlatteningOptionKey and kAIEPSFlatteningOptionKey.

typedef enum _AIFileFormatScriptCompatibility AIFileFormatScriptCompatibility

Dictionary key values for kAINativeScriptKey and kAIEPSScriptKey.

---

Enumeration Type Documentation

enum _AIEPSFilePreview

Dictionary key values for kAIEPSFormatKey.

Enumerator:

kAIEPSFilePreviewNone
kAIEPSFilePreviewBWPICT
kAIEPSFilePreviewColorPICT
kAIEPSFilePreviewBWTIFF
kAIEPSFilePreviewColorTIFF
kAIEPSFilePreviewSimpleColor

enum _AIEPSOverprints

Dictionary key values for kAIEPSOverprintsKey.

Enumerator:

kAIEPSFileOverprints_Preserve
kAIEPSFileOverprints_Discard
kAIEPSFileOverprints_Simulate

enum _AIFileFormatFlattening

Dictionary key values for kAINativeFlatteningOptionKey and kAIEPSFlatteningOptionKey.

Enumerator:

kAIFileFormatFlatteningPreservePaths
kAIFileFormatFlatteningPreserveAppearance
kAIFileFormatFlatteningPreserveAppearanceAndOverprints

enum _AIFileFormatScriptCompatibility

Dictionary key values for kAINativeScriptKey and kAIEPSScriptKey.

Enumerator:

kAIFileFormatScriptCompatibleEnglish
kAIFileFormatScriptCompatibleCJK

---

Variable Documentation

const ActionParamKeyID kAIEPSCMYKPostScriptKey = 'cmyk'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Boolean: when true, convert RGB values to CMYK in the EPS, using the current color settings. When false, send RGB values to the printer unconverted.

const ActionParamKeyID kAIEPSCompatibleGradientPrintKey = 'cgpt'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Boolean: when true, rasterize gradients in the document or convert them to the type of gradients supported by the target device. It is equivalent to selecting the "Compatible Gradient and Gradient Mesh Printing" check box in the EPS Save Options or Print dialog.

const ActionParamKeyID kAIEPSFlatteningOptionKey = 'flat'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Integer: whether to flatten layers when saving a document with transparency to a version that does not support transparency. An AIFileFormatFlattening value.

const ActionParamKeyID kAIEPSFormatKey = 'wfmt'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

The file format for EPS is kAIEPSFileFormat.

const ActionParamKeyID kAIEPSImageFormatKey = 'ifmt'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Integer: the format for writing raster image data in the EPS. When 0, use ASCII hex, when 1, use binary. Applies only when the version is AI8 or earlier.

const ActionParamKeyID kAIEPSIncludeCJKFontsKey = 'icjk'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Boolean: when true, include CJK fonts in the PostScript stream. When false, do not include CJK fonts (they must be present on the printer to avoid substitution).

const ActionParamKeyID kAIEPSIncludePlacedKey = 'iplc'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Boolean: when true, embed linked images and EPS files when saving. When false, do not change the embedded/linked status of images.

const ActionParamKeyID kAIEPSIncludeThumbnailKey = 'ithm'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Boolean: when true, include a thumbnail image of the artwork that is displayed in the File Open dialog in Windows. When false, do not include the thumbnail image.

const ActionParamKeyID kAIEPSOverprintsKey = 'eopt'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Integer: how to handle overprints in the EPS file. An AIEPSOverprints value.

const ActionParamKeyID kAIEPSPostScriptLevelKey = 'pslv'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Integer: The PostScript level with which the EPS must be compatible. 1, 2 or 3.

const ActionParamKeyID kAIEPSScriptKey = 'ext.'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Integer, language script compatibility of the saved file, an AIFileFormatScriptCompatibility value.

const ActionParamKeyID kAIEPSUseDefaultScreensKey = 'dfsc'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Boolean: when true, Illustrator includes its own halftone screens in the generated EPS. Applies only to AI8 and earlier.

const ActionParamKeyID kAIEPSVersionKey = 'crtr'

Additional parameter for kAISaveDocumentAsAction when saving as an EPS file.

Integer: the file format version to use when saving. an AIVersion value.

const ActionParamKeyID kAINativeCompressionKey = 'cmpr'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Boolean: when true, the file contents are compressed, when false they are not.

const ActionParamKeyID kAINativeEmbedAllFontsKey = 'embd'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Integer: whether to embed all fonts. Non-zero causes all fonts to be embedded.

const ActionParamKeyID kAINativeEmbedProfileKey = 'prfl'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Integer: non-zero value causes the document color profile to be embedded in the file.

const ActionParamKeyID kAINativeFlatteningOptionKey = 'flat'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Integer: whether to flatten layers when saving a document with transparency to a version that does not support transparency. An AIFileFormatFlattening value.

const ActionParamKeyID kAINativeIncludeImagesKey = 'incl'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Integer, whether to embed any linked images when saving. Non-zero causes images to be embedded. zero does not change the embedded/linked status of images.

const ActionParamKeyID kAINativePDFCompatibilityKey = 'pdf '

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Boolean: when true, a PDF rendition of the document is saved together with native roundtrip information. When false, only roundtrip information is saved.

const ActionParamKeyID kAINativeSaveAllKey = 'sall'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

When true, export all artboards. when false,export the artbaords in kAINativeSaveRangeKey specified

const ActionParamKeyID kAINativeSaveMultipleArtboardsKey = 'smab'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

When true, export multiple artboards specified in # kAINativeSaveAllKey or kAINativeSaveRangeKey. When false,export all the artboards.

const ActionParamKeyID kAINativeSaveRangeKey = 'sran'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

The artboards range string. Optional when # kAINativeSaveAllKey is true or kAINativeSaveMultipleArtboardsKey is false

const ActionParamKeyID kAINativeScriptKey = 'ext.'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Integer, language script compatibility of the saved file, an AIFileFormatScriptCompatibility value.

const ActionParamKeyID kAINativeSubsetFontsBelowKey = 'sbst'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Boolean: when true, fonts using less than the percentage of characters specified by kAINativeSubsetFontsRatioKey are subsetted.

const ActionParamKeyID kAINativeSubsetFontsRatioKey = 'rato'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Integer, [0..100]: Threshold percentage of character usage for font subsetting. See kAINativeSubsetFontsBelowKey.

const ActionParamKeyID kAINativeVersionKey = 'crtr'

Additional parameter for kAISaveDocumentAsAction when saving as a native file.

Integer: the file format version to use when saving. an AIVersion value.