Adobe.com
Contents Suites Classes Class Index Member Index

AIDocument.h File Reference

#include "AITypes.h"
#include "AIRealMath.h"
#include "AIFileFormat.h"
#include "ATETypesDef.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes

struct  AIDocumentScaleNotifyData
 Data passed in kAIDocumentScaleConvertedNotifier and kAIActiveDocumentScaleChangedNotifier. More...
struct  AIDocumentWriteOnDiskCompleteNotifyData
 Struct for notification data of kAIDocumentWriteOnDiskCompleteNotifier. More...
struct  AIDocumentWriteOnDiskFailedNotifyData
 Struct for notification data of kAIDocumentWriteOnDiskFailedNotifier. More...
struct  AIDocumentSetup
 Document setup information. More...
struct  AIDocumentMiPrintRecord
struct  AIDocumentVersionInfo
 Version information for the document being processed. More...
struct  AIDocumentSuite
 Use these functions to get and set information about the current document. More...

Defines

#define kAIDocumentSuite   "AI Document Suite"
#define kAIDocumentSuiteVersion19   AIAPI_VERSION(19)
#define kAIDocumentSuiteVersion   kAIDocumentSuiteVersion19
#define kAIDocumentVersion   kAIDocumentSuiteVersion
#define kAIDocumentChangedNotifier   "AI Document Changed Notifier"
 Sent when the contents of a document have changed.
#define kAIActiveDocumentWindowAboutToBeChangedNotifier   "AI Active Document Window About To be Changed Notifier"
 Sent when the active document window is about to be changed.
#define kAIDocumentAboutToCloseNotifier   "AI Document About To Close Notifier"
 Sent right before the last document window of the artwork is about to be closed.
#define kAIDocumentClosedNotifier   "AI Document Closed Notifier"
 Sent when a document has been closed.
#define kAIDocumentOpenedNotifier   "AI Document Opened Notifier"
 Sent when a document has been opened.
#define kAIDocumentSavedNotifier   "AI Document Saved Notifier"
 Sent when serialization part of saving process is done.
#define kAIDocumentWriteOnDiskCompleteNotifier   "AI Document Write On Disk Complete Notifier"
 Sent when a document has been written to the disk successfully.
#define kAIDocumentWriteOnDiskFailedNotifier   "AI Document Write On Disk Failed Notifier"
 Sent when a document writing to the disk get failed.
#define kAIDocumentNewNotifier   "AI Document New Notifier"
 Sent when a new document has been created.
#define kAIDocumentClrMdlChangedNotifier   "AI Document Color Model Changed Notifier"
 Sent when the color model for a document has changed.
#define kAIDocumentProfilesChangedNotifier   "AI Document Profiles Changed Notifier"
 Sent when document profiles have been changed.
#define kAIDocumentSpotColorModeChangedNotifier   "AI Document Spot Color Mode Changed Notifier"
 Sent whenever the spot color mode of a document has been changed.
#define kAIDocumentRulerUnitChangedNotifier   "AI Document Ruler Unit Changed Notifier"
 Sent when ruler unit has changed.
#define kAIDocumentWritePreprocessNotifier   "AI Document Write Preprocess Notifier"
 Sent just before the document is saved, along with the AI Version information to allow any data conversion required for saving to legacy files.
#define kAIDocumentWritePostprocessNotifier   "AI Document Write Postprocess Notifier"
 Sent just after serializing a document to an Illustrator file format, and before the flattening layer is removed (if the document was flattened).
#define kAIDocumentCropAreaModifiedNotifier   "AI Document Crop Area Modified Notifier"
 Sent when a crop area has been modified, deleted, or created.
#define kAIDocumentRulerOriginChangedNotifier   "AI Document Ruler Origin Changed Notifier"
 Sent when the document ruler origin has been changed or reset.
#define kAIDocumentBleedsChangedNotifier   "AI Document Bleed Value Changed Notifier"
 Sent when the document bleed values have been changed.
#define kAIDocumentTransparencyGridNotifier   "AI Document Transparency Grid Notifier"
 Sent when the transparency grid is toggled.
#define kAIDocumentScaleConversionStartedNotifier   "AI Document Scale Conversion Started Notifier"
 Sent when we start the document scale conversion to a new scale.
#define kAIDocumentScaleConvertedNotifier   "AI Document Scale Converted Notifier"
 Sent when current document scale is converted to a new scale.
#define kAIActiveDocumentScaleChangedNotifier   "AI Active Document Scale Changed Notifier"
 Sent when a document become active which has a different document scale then the last active document.
#define kAIDocumentScaleOutOfRangeErr   'DSOR'
 Sent when the document scale passed in SetDocument Scale is out of range.
#define kAIDocumentMiPrintRecordVersion   1

Typedefs

typedef void * AIDocumentPlatformPrintRecord
 Not supported.
typedef struct
AIDocumentMiPrintRecord
AIDocumentMiPrintRecordPtr
typedef void * AIDocumentFileFormatParameters
 Opaque reference to a file format's parameters.

Enumerations

enum  AIDocumentRulerUnitValue {
  kUnknownUnits = 0, kInchesUnits, kCentimetersUnits, kPointsUnits,
  kPicasUnits, kMillimetersUnits, kPixelsUnits, kQUnits,
  kFeetInchesUnits, kMetersUnits, kYardsUnits, kFeetsUnits,
  kLastUnit = kFeetsUnits, kUnknownUnits = 0, kInchesUnits, kCentimetersUnits,
  kPointsUnits, kPicasUnits, kMillimetersUnits, kPixelsUnits,
  kQUnits, kFeetInchesUnits, kMetersUnits, kYardsUnits,
  kFeetsUnits, kLastUnit = kFeetsUnits
}
 

Ruler unit values, see AIDocumentSuite::GetDocumentRulerUnits().

More...
enum  AIDocumentColorModelValue {
  kDocUnknownColor = -1, kDocGrayColor = 0, kDocRGBColor, kDocCMYKColor,
  kDocUnknownColor = -1, kDocGrayColor = 0, kDocRGBColor, kDocCMYKColor
}
 

Color models that can be used to specify artwork colors for a specific document.

More...
enum  { kDocTargetGroups, kDocTargetLeaves, kDocTargetPainted, kDocTargetExplicit }
 

Document targeting types.

More...
enum  AISpotColorMode {
  kAILegacySpotColorMode = 0, kAIStandardSpotColorMode = 1, kAIDummySpotColorMode = 0xFFFFFFFF, kAILegacySpotColorMode = 0,
  kAIStandardSpotColorMode = 1, kAIDummySpotColorMode = 0xFFFFFFFF
}
 

A book color is one of the named spot colors defined in files installed in the "Presets/Color Books" directory.

More...
enum  AIExportTriggeredFrom { kAIExportAs, kAIExportForScreen, kAISaveForWeb }
 

Export can be triggered from Export as, Export for screens and Save for web.

More...
enum  AICropMarkStyle { kStandardCropStyle, kJapaneseCropStyle }
 

Styles of crop marks.

More...
enum  AILibraryType { kAIBrushLibraryType, kAIStyleLibraryType, kAISwatchLibraryType, kAISymbolLibraryType }
 

Types of libraries.

More...

Detailed Description


Define Documentation

#define kAIDocumentMiPrintRecordVersion   1
#define kAIDocumentSuite   "AI Document Suite"
#define kAIDocumentSuiteVersion   kAIDocumentSuiteVersion19
#define kAIDocumentSuiteVersion19   AIAPI_VERSION(19)
#define kAIDocumentVersion   kAIDocumentSuiteVersion

Typedef Documentation

Opaque reference to a file format's parameters.

Deprecated:
Information about how a document will print. No longer used.

Not supported.


Enumeration Type Documentation

anonymous enum

Document targeting types.

See AIDocumentSuite::GetDocumentTargeting() (Not yet implemented.)

Enumerator:
kDocTargetGroups 
kDocTargetLeaves 
kDocTargetPainted 
kDocTargetExplicit 

Styles of crop marks.

Enumerator:
kStandardCropStyle 
kJapaneseCropStyle 

Color models that can be used to specify artwork colors for a specific document.

See AIDocumentSuite::GetDocumentColorModel()

Enumerator:
kDocUnknownColor 
kDocGrayColor 
kDocRGBColor 
kDocCMYKColor 
kDocUnknownColor 
kDocGrayColor 
kDocRGBColor 
kDocCMYKColor 

Ruler unit values, see AIDocumentSuite::GetDocumentRulerUnits().

Enumerator:
kUnknownUnits 
kInchesUnits 

inches

kCentimetersUnits 

centimeters

kPointsUnits 

points

kPicasUnits 

picas

kMillimetersUnits 

millimeters

kPixelsUnits 

pixels

kQUnits 

Q units.

kFeetInchesUnits 

feet-inch

kMetersUnits 

meters

kYardsUnits 

yards

kFeetsUnits 

feet

kLastUnit 

last

kUnknownUnits 
kInchesUnits 

inches

kCentimetersUnits 

centimeters

kPointsUnits 

points

kPicasUnits 

picas

kMillimetersUnits 

millimeters

kPixelsUnits 

pixels

kQUnits 

Q units.

kFeetInchesUnits 

feet-inch

kMetersUnits 

meters

kYardsUnits 

yards

kFeetsUnits 

feet

kLastUnit 

last

Export can be triggered from Export as, Export for screens and Save for web.

We have maintained different default settings for each export. GetLastExportedFilePath() SetLastExportedFilePath() require this parameter of type AIExportTriggeredFrom to know which export was used

Enumerator:
kAIExportAs 
kAIExportForScreen 
kAISaveForWeb 

Types of libraries.

Enumerator:
kAIBrushLibraryType 
kAIStyleLibraryType 
kAISwatchLibraryType 
kAISymbolLibraryType 

A book color is one of the named spot colors defined in files installed in the "Presets/Color Books" directory.

The appearance definition of a book color specifies how to simulate the appearance of the spot ink when the physical ink is not available.

This mode value indicates whether new book colors added to a document should use the standard or legacy appearance definition. It affects new spot colors that are added from a swatch library, by placing a file, or by cut and paste. See AIDocumentSuite::GetDocumentSpotColorMode() and AIDocumentSuite::GetDocumentSpotColorMode().

Note:
Illustrator does not enforce the mode setting for new spot colors. However, the import code automatically resolves spot color conflicts.
Enumerator:
kAILegacySpotColorMode 

The legacy definition matches prior versions of Illustrator, typically given using CMYK.

kAIStandardSpotColorMode 

The standard definition is the most accurate, typically given using Lab.

kAIDummySpotColorMode 
kAILegacySpotColorMode 

The legacy definition matches prior versions of Illustrator, typically given using CMYK.

kAIStandardSpotColorMode 

The standard definition is the most accurate, typically given using Lab.

kAIDummySpotColorMode 


Contents Suites Classes Class Index Member Index
Adobe Solutions Network
 
Copyright © 2014 Adobe Systems Incorporated. All rights reserved.
Terms of Use Online Privacy Policy Adobe and accessibility Avoid software piracy Permissions and Trademarks