AIDocumentList.h File Reference

#include "AITypes.h"
#include "AIRealMath.h"
#include "AIDocument.h"
#include "AIActionManager.h"
#include "AIUnicodeString.h"
#include "IAIFilePath.hpp"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AINewDocumentPreset
	Parameters for creating a new document with AIDocumentListSuite::New(). More...
struct	AIDocumentListSuite
	These functions enumerate and operate on the list of open Illustrator documents. More...
Defines
#define	kAIDocumentListSuite   "AI Document List Suite"
#define	kAIDocumentListSuiteVersion11   AIAPI_VERSION(11)
#define	kAIDocumentListSuiteVersion   kAIDocumentListSuiteVersion11
#define	kAIDocumentListVersion   kAIDocumentListSuiteVersion
#define	kCantCreateNewDocumentErr   'ENEW'
	See AIDocumentListSuite.
#define	kAIInvalidNegativeSpacingErr   'InNS'
	Thrown by AIDocumentListSuite::New() when negative value of docArtboardSpacing (spacing between artboards, See AINewDocumentPreset) is invalid.
#define	kAICantFitArtboardsErr   'CFCE'
	Thrown by AIDocumentListSuite::New() when artboards cannot fit into available canvas size (14000x14000 pts or 16383 x 16383 pts).
Enumerations
enum	AIColorModel {   kAIUnknownColorModel = -1, kAIGrayColorModel = 0, kAIRGBColorModel, kAICMYKColorModel,   kAIUnknownColorModel = -1, kAIGrayColorModel = 0, kAIRGBColorModel, kAICMYKColorModel }
	The document color model used when creating a new document or opening a document, set in AINewDocumentPreset::docColorMode. More...
enum	AITransparencyGrid {   kAITransparencyGridNone = 0, kAITransparencyGridLight, kAITransparencyGridMedium, kAITransparencyGridDark,   kAITransparencyGridRed, kAITransparencyGridOrange, kAITransparencyGridGreen, kAITransparencyGridBlue,   kAITransparencyGridPurple, kAITransparencyGridNone = 0, kAITransparencyGridLight, kAITransparencyGridMedium,   kAITransparencyGridDark, kAITransparencyGridRed, kAITransparencyGridOrange, kAITransparencyGridGreen,   kAITransparencyGridBlue, kAITransparencyGridPurple }
	The preferred grid style for a new document, set in AINewDocumentPreset::docTransparencyGrid. More...
enum	AIPreviewMode {   kAIPreviewModeDefault = 0, kAIPreviewModePixelPreview, kAIPreviewModeOverprintPreview, kAIPreviewModeDefault = 0,   kAIPreviewModePixelPreview, kAIPreviewModeOverprintPreview }
	The preferred preview mode for a new document, set in AINewDocumentPreset::docPreviewMode. More...
enum	AIRasterResolution {   kAIRasterResolutionScreen = 0, kAIRasterResolutionMedium, kAIRasterResolutionHigh, kAIRasterResolutionScreen = 0,   kAIRasterResolutionMedium, kAIRasterResolutionHigh, kAIRasterResolution36PPI }
	Raster resolution values for creating a new document, set in AINewDocumentPreset::docRasterResolution. More...
enum	AIArtboardLayout {   kAIArtboardLayoutGridByRow = 0, kAIArtboardLayoutGridByCol, kAIArtboardLayoutRow, kAIArtboardLayoutCol,   kAIArtboardLayoutRLGridByRow, kAIArtboardLayoutRLGridByCol, kAIArtboardLayoutRLRow, kAIArtboardLayoutGridByRow = 0,   kAIArtboardLayoutGridByCol, kAIArtboardLayoutRow, kAIArtboardLayoutCol, kAIArtboardLayoutRLGridByRow,   kAIArtboardLayoutRLGridByCol, kAIArtboardLayoutRLRow }
	Artboard Layout for placing artboards while creating a new document, set in AINewDocumentPreset::docArtboardLayout. More...

---

Detailed Description

---

Define Documentation

#define kAIDocumentListSuite   "AI Document List Suite"

#define kAIDocumentListSuiteVersion   kAIDocumentListSuiteVersion11

#define kAIDocumentListSuiteVersion11   AIAPI_VERSION(11)

#define kAIDocumentListVersion   kAIDocumentListSuiteVersion

---

Enumeration Type Documentation

enum AIArtboardLayout

Artboard Layout for placing artboards while creating a new document, set in AINewDocumentPreset::docArtboardLayout.

Enumerator:

kAIArtboardLayoutGridByRow	Arrange artboards in grid by row pattern.
kAIArtboardLayoutGridByCol	Arrange artboards in grid by column pattern.
kAIArtboardLayoutRow	Arrange artboards in a single row.
kAIArtboardLayoutCol	Arrange artboards in a single column.
kAIArtboardLayoutRLGridByRow	Arrange artboards in grid by row pattern from right to left.
kAIArtboardLayoutRLGridByCol	Arrange artboards in grid by column pattern from right to left.
kAIArtboardLayoutRLRow	Arrange artboards in single row from right to left.
kAIArtboardLayoutGridByRow	Arrange artboards in grid by row pattern.
kAIArtboardLayoutGridByCol	Arrange artboards in grid by column pattern.
kAIArtboardLayoutRow	Arrange artboards in a single row.
kAIArtboardLayoutCol	Arrange artboards in a single column.
kAIArtboardLayoutRLGridByRow	Arrange artboards in grid by row pattern from right to left.
kAIArtboardLayoutRLGridByCol	Arrange artboards in grid by column pattern from right to left.
kAIArtboardLayoutRLRow	Arrange artboards in single row from right to left.

enum AIColorModel

The document color model used when creating a new document or opening a document, set in AINewDocumentPreset::docColorMode.

Enumerator:

kAIUnknownColorModel
kAIGrayColorModel	Grayscale (Unimplemented. If specified, an RGB document is created.)
kAIRGBColorModel	RGB.
kAICMYKColorModel	CMYK.
kAIUnknownColorModel
kAIGrayColorModel	Grayscale (Unimplemented. If specified, an RGB document is created.)
kAIRGBColorModel	RGB.
kAICMYKColorModel	CMYK.

enum AIPreviewMode

The preferred preview mode for a new document, set in AINewDocumentPreset::docPreviewMode.

Enumerator:

kAIPreviewModeDefault
kAIPreviewModePixelPreview
kAIPreviewModeOverprintPreview
kAIPreviewModeDefault
kAIPreviewModePixelPreview
kAIPreviewModeOverprintPreview

enum AIRasterResolution

Raster resolution values for creating a new document, set in AINewDocumentPreset::docRasterResolution.

Values are in pixels-per-inch. This becomes the Raster Effect Settings value for the document.

Enumerator:

kAIRasterResolutionScreen	Low or screen resolution, 72 PPI. This is the default.
kAIRasterResolutionMedium	Medium resolution, 150 PPI.
kAIRasterResolutionHigh	High resolution, 300 PPI.
kAIRasterResolutionScreen	Low or screen resolution, 72 PPI. This is the default.
kAIRasterResolutionMedium	Medium resolution, 150 PPI.
kAIRasterResolutionHigh	High resolution, 300 PPI.
kAIRasterResolution36PPI	Low resolution, 36 PPI.

enum AITransparencyGrid

The preferred grid style for a new document, set in AINewDocumentPreset::docTransparencyGrid.

Enumerator:

kAITransparencyGridNone	No grid.
kAITransparencyGridLight	Light gray lines.
kAITransparencyGridMedium	Medium gray lines.
kAITransparencyGridDark	Dark gray lines.
kAITransparencyGridRed	Red lines.
kAITransparencyGridOrange	Orange lines.
kAITransparencyGridGreen	Green lines.
kAITransparencyGridBlue	Blue lines.
kAITransparencyGridPurple	Purple lines.
kAITransparencyGridNone	No grid.
kAITransparencyGridLight	Light gray lines.
kAITransparencyGridMedium	Medium gray lines.
kAITransparencyGridDark	Dark gray lines.
kAITransparencyGridRed	Red lines.
kAITransparencyGridOrange	Orange lines.
kAITransparencyGridGreen	Green lines.
kAITransparencyGridBlue	Blue lines.
kAITransparencyGridPurple	Purple lines.