API: AIDocumentList.h Source File

00001 #ifndef __AIDocumentList__
00002 #define __AIDocumentList__
00003 
00004 /*
00005  *        Name: AIDocumentList.h
00006  *   $Revision: 1 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Document Suite.
00010  *
00011  * ADOBE SYSTEMS INCORPORATED
00012  * Copyright 1986-2007 Adobe Systems Incorporated.
00013  * All rights reserved.
00014  *
00015  * NOTICE:  Adobe permits you to use, modify, and distribute this file
00016  * in accordance with the terms of the Adobe license agreement
00017  * accompanying it. If you have received this file from a source other
00018  * than Adobe, then your use, modification, or distribution of it
00019  * requires the prior written permission of Adobe.
00020  *
00021  */
00022 
00023 
00024 /*******************************************************************************
00025  **
00026  **     Imports
00027  **
00028  **/
00029 
00030 #ifndef __AITypes__
00031 #include "AITypes.h"
00032 #endif
00033 
00034 #ifndef __AIRealMath__
00035 #include "AIRealMath.h"
00036 #endif
00037 
00038 #ifndef __AIDocument__
00039 #include "AIDocument.h"
00040 #endif
00041 
00042 #ifndef __AIActionManager_h__
00043 #include "AIActionManager.h"
00044 #endif
00045 
00046 #ifndef __AIUnicodeString__
00047 #include "AIUnicodeString.h"
00048 #endif
00049 
00050 #include "IAIFilePath.hpp"
00051 
00052 #include "AIHeaderBegin.h"
00053 
00054 #if defined(ILLUSTRATOR_MINIMAL)
00055         #include "AIDocumentBasicTypes.h"
00056 #endif
00057 
00060 /*******************************************************************************
00061  **
00062  **     Constants
00063  **
00064  **/
00065 
00066 #define kAIDocumentListSuite                    "AI Document List Suite"
00067 #define kAIDocumentListSuiteVersion11   AIAPI_VERSION(11)
00068 
00069 // latest version
00070 #define kAIDocumentListSuiteVersion             kAIDocumentListSuiteVersion11
00071 #define kAIDocumentListVersion                  kAIDocumentListSuiteVersion
00072 
00073 
00074 /*******************************************************************************
00075  **
00076  **     Types
00077  **
00078  **/
00079 
00082 #define kCantCreateNewDocumentErr                       'ENEW'
00083 
00089 #define kAIInvalidNegativeSpacingErr            'InNS'
00090 
00094 #define kAICantFitArtboardsErr                          'CFCE'
00095 
00096 #if !defined(ILLUSTRATOR_MINIMAL)
00097 
00099 typedef enum
00100 {
00101         kAIUnknownColorModel = -1,
00103         kAIGrayColorModel = 0,
00105         kAIRGBColorModel,
00107         kAICMYKColorModel
00108 } AIColorModel;
00109 
00112 typedef enum
00113 {
00115         kAITransparencyGridNone = 0,
00117         kAITransparencyGridLight,
00119         kAITransparencyGridMedium,
00121         kAITransparencyGridDark,
00123         kAITransparencyGridRed,
00125         kAITransparencyGridOrange,
00127         kAITransparencyGridGreen,
00129         kAITransparencyGridBlue,
00131         kAITransparencyGridPurple
00132 } AITransparencyGrid;
00133 
00136 typedef enum
00137 {
00138         /* The default preview mode */
00139         kAIPreviewModeDefault = 0,
00140         /* Pixel preview mode */
00141         kAIPreviewModePixelPreview,
00142         /* Overprint preview mode */
00143         kAIPreviewModeOverprintPreview
00144 } AIPreviewMode;
00145 
00150 typedef enum
00151 {
00153         kAIRasterResolutionScreen = 0,
00155         kAIRasterResolutionMedium,
00157         kAIRasterResolutionHigh,
00159         kAIRasterResolution36PPI
00160 } AIRasterResolution;
00161 
00164 typedef enum
00165 {
00167         kAIArtboardLayoutGridByRow  = 0 ,
00169         kAIArtboardLayoutGridByCol,
00171         kAIArtboardLayoutRow,
00173         kAIArtboardLayoutCol,
00175         kAIArtboardLayoutRLGridByRow,
00177         kAIArtboardLayoutRLGridByCol,
00179         kAIArtboardLayoutRLRow
00180 }AIArtboardLayout;
00181 #endif
00182 
00183 typedef struct {
00186         ai::UnicodeString       docTitle;
00189         AIReal                          docWidth;
00192         AIReal                          docHeight;
00195         ai::int32                               docNumArtboards;
00197         AIArtboardLayout                docArtboardLayout;
00199         AIReal                          docArtboardSpacing;
00208         ai::int32                               docArtboardRowsOrCols;
00210         AIColorModel            docColorMode;
00212         AIDocumentRulerUnitValue docUnits;
00214         AIPreviewMode           docPreviewMode;
00216         AITransparencyGrid      docTransparencyGrid;
00218         AIRasterResolution      docRasterResolution;
00220         AIRealRect                      docBleedOffset;
00222         AIBoolean                       docBleedLinkStatus;
00224         ai::FilePath docCustomFile;
00225 } AINewDocumentPreset;
00226 
00227 
00228 
00229 /*******************************************************************************
00230  **
00231  **     Suite
00232  **
00233  **/
00234 
00250 struct AIDocumentListSuite {
00251 
00257         AIAPI AIErr     (*Count)( ai::int32* count );
00258 
00264         AIAPI AIErr     (*GetNthDocument)( AIDocumentHandle* document, ai::int32 lIndex );
00265 
00282         AIAPI AIErr     (*New)( ai::UnicodeString& preset, AINewDocumentPreset *parameter, ActionDialogStatus dialogStatus, AIDocumentHandle* document );
00283 
00295         AIAPI AIErr     (*Open)( const ai::FilePath &fileSpec, AIColorModel colorMode,
00296                                                 ActionDialogStatus dialogStatus, AIBoolean forceCopy, AIDocumentHandle* document );
00297 
00310         AIAPI AIErr     (*OpenNoHistory)( const ai::FilePath &fileSpec, AIColorModel colorMode,
00311                 ActionDialogStatus dialogStatus, AIBoolean forceCopy, AIDocumentHandle* document );
00312 
00317         AIAPI AIErr     (*Save)( AIDocumentHandle document );
00318 
00326         AIAPI AIErr     (*Close)( AIDocumentHandle document );
00327 
00331         AIAPI AIErr     (*CloseAll)();
00332 
00337         AIAPI AIErr     (*Activate)( AIDocumentHandle document, ASBoolean bSetFocus );
00338 
00344         AIAPI AIErr     (*Print)( AIDocumentHandle document, ActionDialogStatus dialogStatus );
00345 
00346         // Introduced in Illustrator 13.0
00347 
00353         AIAPI AIErr     (*GetPresetSettings)( ai::UnicodeString &preset, AINewDocumentPreset *param );
00354 
00360         AIAPI ai::int32 (*CountRecentDocuments)();
00361 
00367         AIAPI AIErr (*GetNthRecentDocument)( ai::int32 index, ai::UnicodeString& document );
00368 
00372         AIAPI AIErr (*OpenNthRecentDocument)(ai::int32 index);
00373 
00377         AIAPI AIErr (*AddToRecentFiles)(const ai::FilePath &document);
00378 };
00379 
00380 #include "AIHeaderEnd.h"
00381 
00382 #endif