AIDocumentAction.h File Reference

#include "AIActionManager.h"

Go to the source code of this file.

Defines
#define	kAINewDocumentAction   "adobe_newDocument"
	Makes a new document.
#define	kAIOpenDocumentAction   "adobe_openDocument"
	Opens a document.
#define	kAISaveDocumentAction   "adobe_saveDocument"
	Saves the current document under its current name, according to its current format.
#define	kAISaveDocumentAsAction   "adobe_saveDocumentAs"
	Saves the current document.
#define	kAIRevertDocumentAction   "adobe_revertDocument"
	Reverts the current document to its state when last saved.
#define	kAICloseDocumentAction   "adobe_closeDocument"
	Closes the current document or all open documents.
#define	kAIExportDocumentAction   "adobe_exportDocument"
	Exports the current document to the file format specified by the format and extension parameters.
#define	kAIPrintDocumentAction   "adobe_printDocument"
	Prints the current document.
#define	kAIPlaceDocumentAction   "adobe_placeDocument"
	Places a file into a document.
Variables
const ActionParamKeyID	kAINewDocumentNameKey = 'name'
	Parameter to kAINewDocumentAction.
const ActionParamKeyID	kAINewDocumentColorModelKey = 'colr'
	Parameter to kAINewDocumentAction.
const ActionParamKeyID	kAINewDocumentSettingsFileKey = 'setf'
	Parameter to kAINewDocumentAction.
const ActionParamKeyID	kAINewDocumentWidthKey = 'wdth'
	The page width in points (real).
const ActionParamKeyID	kAINewDocumentHeightKey = 'heit'
	Parameter to kAINewDocumentAction.
const ActionParamKeyID	kAINewDocumentRulerUnitsKey = 'rulr'
	Parameter to kAINewDocumentAction.
const ActionParamKeyID	kAINewDocumentRasterResolutionKey = 'rast'
	Parameter to kAINewDocumentAction.
const ActionParamKeyID	kAINewDocumentPreviewModeKey = 'pxpr'
	Parameter to kAINewDocumentAction.
const ActionParamKeyID	kAINewDocumentTransparencyGridKey = 'tran'
	Parameter to kAINewDocumentAction.
const ActionParamKeyID	kAINewDocumentTransparencyGridColor1RedKey = 'gr1r'
	Parameter to kAINewDocumentAction.
const ActionParamKeyID	kAINewDocumentTransparencyGridColor1GreenKey = 'gr1g'
const ActionParamKeyID	kAINewDocumentTransparencyGridColor1BlueKey = 'gr1b'
const ActionParamKeyID	kAINewDocumentTransparencyGridColor2RedKey = 'gr2r'
const ActionParamKeyID	kAINewDocumentTransparencyGridColor2GreenKey = 'gr2g'
const ActionParamKeyID	kAINewDocumentTransparencyGridColor2BlueKey = 'gr2b'
const ActionParamKeyID	kAIOpenDocumentNameKey = 'name'
	Parameter to kAIOpenDocumentAction.
const ActionParamKeyID	kAIOpenDocumentColorModelKey = 'colr'
	Parameter to kAIOpenDocumentAction.
const ActionParamKeyID	kAISaveDocumentAsNameKey = 'name'
	Parameter to kAISaveDocumentAsAction.
const ActionParamKeyID	kAISaveDocumentAsFormatKey = 'frmt'
	Parameter to kAISaveDocumentAsAction.
const ActionParamKeyID	kAISaveDocumentAsGetParamsKey = 'gprm'
	Parameter to kAISaveDocumentAsAction.
const ActionParamKeyID	kAICloseAllDocumentsKey = 'all.'
	Parameter to kAICloseDocumentAction.
const ActionParamKeyID	kAICloseAndSaveDocumentKey = 'save'
	Parameter to kAICloseDocumentAction.
const ActionParamKeyID	kAIExportDocumentNameKey = 'name'
	Parameter to kAIExportDocumentAction.
const ActionParamKeyID	kAIExportDocumentFormatKey = 'frmt'
	Parameter to kAIExportDocumentAction.
const ActionParamKeyID	kAIExportDocumentExtensionKey = 'extn'
	Parameter to kAIExportDocumentAction.
const ActionParamKeyID	kAIExportDocumentSaveMultipleArtboardsKey = 'smab'
	Parameter to kAIExportDocumentAction.
const ActionParamKeyID	kAIExportDocumentSaveAllKey = 'sall'
	Parameter to kAIExportDocumentAction.
const ActionParamKeyID	kAIExportDocumentSaveRangeKey = 'sran'
	Parameter to kAIExportDocumentAction.
const ActionParamKeyID	kAIEnableBatchExport = 'ebep'
const ActionParamKeyID	kAIExportDocumentPreventFileNameUniquifyKey = 'pfnu'
const ActionParamKeyID	kAIPlaceDocumentActionNameKey = 'name'
	Parameter to kAIPlaceDocumentAction.
const ActionParamKeyID	kAIPlaceDocumentActionLinkKey = 'link'
	Parameter to kAIPlaceDocumentAction.
const ActionParamKeyID	kAIPlaceDocumentActionReplaceKey = 'rplc'
	Parameter to kAIPlaceDocumentAction.
const ActionParamKeyID	kAIPlaceDocumentActionTemplateKey = 'tmpl'
	Parameter to kAIPlaceDocumentAction.

---

Variable Documentation

const ActionParamKeyID kAICloseAllDocumentsKey = 'all.'

Parameter to kAICloseDocumentAction.

When true, close all open document. When false, close only the current document.

const ActionParamKeyID kAICloseAndSaveDocumentKey = 'save'

Parameter to kAICloseDocumentAction.

When true, saves the document or documents before closing.

const ActionParamKeyID kAIEnableBatchExport = 'ebep'

const ActionParamKeyID kAIExportDocumentExtensionKey = 'extn'

Parameter to kAIExportDocumentAction.

The file extension string. Optional. If not specified, shows the Export dialog.

const ActionParamKeyID kAIExportDocumentFormatKey = 'frmt'

Parameter to kAIExportDocumentAction.

The format string. Optional. If not specified, shows the Export dialog. See the action information for individual formats for definitions of the format strings.

const ActionParamKeyID kAIExportDocumentNameKey = 'name'

Parameter to kAIExportDocumentAction.

The name string for the file to export as.

const ActionParamKeyID kAIExportDocumentPreventFileNameUniquifyKey = 'pfnu'

const ActionParamKeyID kAIExportDocumentSaveAllKey = 'sall'

Parameter to kAIExportDocumentAction.

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

const ActionParamKeyID kAIExportDocumentSaveMultipleArtboardsKey = 'smab'

Parameter to kAIExportDocumentAction.

When true, export multiple artboards specified in # kAIExportDocumentSaveAllKey or kAIExportDocumentSaveRangeKey. when false,export the complete artwork

const ActionParamKeyID kAIExportDocumentSaveRangeKey = 'sran'

Parameter to kAIExportDocumentAction.

The artboards range string. Optional when # kAIExportDocumentSaveAllKey is true or kAIExportDocumentSaveMultipleArtboardsKey is false

const ActionParamKeyID kAINewDocumentColorModelKey = 'colr'

Parameter to kAINewDocumentAction.

The color model to use. Allowed values are kDocRGBColor and kDocCMYKColor.

const ActionParamKeyID kAINewDocumentHeightKey = 'heit'

Parameter to kAINewDocumentAction.

The page height in points (real).

const ActionParamKeyID kAINewDocumentNameKey = 'name'

Parameter to kAINewDocumentAction.

The document title string. Optional, default is "untitled-n" (with a unique number).

const ActionParamKeyID kAINewDocumentPreviewModeKey = 'pxpr'

Parameter to kAINewDocumentAction.

The preview style for the new document, an AIPreviewMode constant.

const ActionParamKeyID kAINewDocumentRasterResolutionKey = 'rast'

Parameter to kAINewDocumentAction.

The document raster resolution, an integer for the PPI value: Screen(72), Medium(150), or High(300).

const ActionParamKeyID kAINewDocumentRulerUnitsKey = 'rulr'

Parameter to kAINewDocumentAction.

The ruler units, an AIDocumentRulerUnitValue.

const ActionParamKeyID kAINewDocumentSettingsFileKey = 'setf'

Parameter to kAINewDocumentAction.

Unicode string containing the path to the new document profile file to use. These files are found in folders kAIUserWritableStartupFileFolderType and kAIRequiredStartupProfilesFolderType.

const ActionParamKeyID kAINewDocumentTransparencyGridColor1BlueKey = 'gr1b'

const ActionParamKeyID kAINewDocumentTransparencyGridColor1GreenKey = 'gr1g'

const ActionParamKeyID kAINewDocumentTransparencyGridColor1RedKey = 'gr1r'

Parameter to kAINewDocumentAction.

If kAINewDocumentTransparencyGridKey is true, the RGB values for the colors of the Transparency Grid

const ActionParamKeyID kAINewDocumentTransparencyGridColor2BlueKey = 'gr2b'

const ActionParamKeyID kAINewDocumentTransparencyGridColor2GreenKey = 'gr2g'

const ActionParamKeyID kAINewDocumentTransparencyGridColor2RedKey = 'gr2r'

const ActionParamKeyID kAINewDocumentTransparencyGridKey = 'tran'

Parameter to kAINewDocumentAction.

True to show the transparency grid for the document, false to hide it.

const ActionParamKeyID kAINewDocumentWidthKey = 'wdth'

The page width in points (real).

const ActionParamKeyID kAIOpenDocumentColorModelKey = 'colr'

Parameter to kAIOpenDocumentAction.

The color model to use. Allowed values are kDocRGBColor and kDocCMYKColor.

const ActionParamKeyID kAIOpenDocumentNameKey = 'name'

Parameter to kAIOpenDocumentAction.

The name string of the file to open.

const ActionParamKeyID kAIPlaceDocumentActionLinkKey = 'link'

Parameter to kAIPlaceDocumentAction.

When true, the file is linked. When false, the file is embedded.

const ActionParamKeyID kAIPlaceDocumentActionNameKey = 'name'

Parameter to kAIPlaceDocumentAction.

The name string of the file to place.

const ActionParamKeyID kAIPlaceDocumentActionReplaceKey = 'rplc'

Parameter to kAIPlaceDocumentAction.

When true, the file replaces the current selection in the document.

const ActionParamKeyID kAIPlaceDocumentActionTemplateKey = 'tmpl'

Parameter to kAIPlaceDocumentAction.

When true. creates a template layer and places the file in that layer.

const ActionParamKeyID kAISaveDocumentAsFormatKey = 'frmt'

Parameter to kAISaveDocumentAsAction.

The format string of the format to save to. Optional. If not specified, uses the current format of the document. See AINativeAction.h

const ActionParamKeyID kAISaveDocumentAsGetParamsKey = 'gprm'

Parameter to kAISaveDocumentAsAction.

When true, shows a dialog to query user for additional parameters required by the format. Optional. Default is false.

const ActionParamKeyID kAISaveDocumentAsNameKey = 'name'

Parameter to kAISaveDocumentAsAction.

The name string of the file to save to. Optional. If not specified, shows a dialog to query user for the name.