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 
00056 /*******************************************************************************
00057  **
00058  **     Constants
00059  **
00060  **/
00061 
00062 #define kAIDocumentListSuite                    "AI Document List Suite"
00063 #define kAIDocumentListSuiteVersion10   AIAPI_VERSION(10)
00064 
00065 // latest version
00066 #define kAIDocumentListSuiteVersion             kAIDocumentListSuiteVersion10
00067 #define kAIDocumentListVersion                  kAIDocumentListSuiteVersion
00068 
00069 
00070 /*******************************************************************************
00071  **
00072  **     Types
00073  **
00074  **/
00075 
00078 #define kCantCreateNewDocumentErr                       'ENEW'
00079 
00085 #define kAIInvalidNegativeSpacingErr            'InNS'
00086 
00090 #define kAICantFitArtboardsErr                          'CFCE'
00091 
00092 
00095 typedef enum
00096 {
00097         kAIUnknownColorModel = -1,
00099         kAIGrayColorModel = 0,
00101         kAIRGBColorModel,
00103         kAICMYKColorModel
00104 } AIColorModel;
00105 
00108 typedef enum
00109 {
00111         kAITransparencyGridNone = 0,
00113         kAITransparencyGridLight,
00115         kAITransparencyGridMedium,
00117         kAITransparencyGridDark,
00119         kAITransparencyGridRed,
00121         kAITransparencyGridOrange,
00123         kAITransparencyGridGreen,
00125         kAITransparencyGridBlue,
00127         kAITransparencyGridPurple
00128 } AITransparencyGrid;
00129 
00132 typedef enum
00133 {
00134         /* The default preview mode */
00135         kAIPreviewModeDefault = 0,
00136         /* Pixel preview mode */
00137         kAIPreviewModePixelPreview,
00138         /* Overprint preview mode */
00139         kAIPreviewModeOverprintPreview
00140 } AIPreviewMode;
00141 
00146 typedef enum
00147 {
00149         kAIRasterResolutionScreen = 0,
00151         kAIRasterResolutionMedium,
00153         kAIRasterResolutionHigh
00154 } AIRasterResolution;
00155 
00158 typedef enum
00159 {
00161         kAIArtboardLayoutGridByRow  = 0 ,
00163         kAIArtboardLayoutGridByCol,
00165         kAIArtboardLayoutRow,
00167         kAIArtboardLayoutCol,
00169         kAIArtboardLayoutRLGridByRow,
00171         kAIArtboardLayoutRLGridByCol,
00173         kAIArtboardLayoutRLRow
00174 }AIArtboardLayout;
00175 
00177 typedef struct {
00180         ai::UnicodeString       docTitle;
00183         AIReal                          docWidth;
00186         AIReal                          docHeight;
00189         ai::int32                               docNumArtboards;
00191         AIArtboardLayout                docArtboardLayout;
00193         AIReal                          docArtboardSpacing;
00202         ai::int32                               docArtboardRowsOrCols;
00204         AIColorModel            docColorMode;
00206         AIDocumentRulerUnitValue docUnits;
00208         AIPreviewMode           docPreviewMode;
00210         AITransparencyGrid      docTransparencyGrid;
00212         AIRasterResolution      docRasterResolution;
00214         AIRealRect                      docBleedOffset;
00216         AIBoolean                       docBleedLinkStatus;
00217 } AINewDocumentPreset;
00218 
00219 
00220 
00221 /*******************************************************************************
00222  **
00223  **     Suite
00224  **
00225  **/
00226 
00242 struct AIDocumentListSuite {
00243 
00249         AIAPI AIErr     (*Count)( ai::int32* count );
00250 
00256         AIAPI AIErr     (*GetNthDocument)( AIDocumentHandle* document, ai::int32 lIndex );
00257 
00274         AIAPI AIErr     (*New)( ai::UnicodeString& preset, AINewDocumentPreset *parameter, ActionDialogStatus dialogStatus, AIDocumentHandle* document );
00275 
00287         AIAPI AIErr     (*Open)( const ai::FilePath &fileSpec, AIColorModel colorMode,
00288                                                 ActionDialogStatus dialogStatus, AIBoolean forceCopy, AIDocumentHandle* document );
00289 
00302         AIAPI AIErr     (*OpenNoHistory)( const ai::FilePath &fileSpec, AIColorModel colorMode,
00303                 ActionDialogStatus dialogStatus, AIBoolean forceCopy, AIDocumentHandle* document );
00304 
00309         AIAPI AIErr     (*Save)( AIDocumentHandle document );
00310 
00318         AIAPI AIErr     (*Close)( AIDocumentHandle document );
00319 
00323         AIAPI AIErr     (*CloseAll)();
00324 
00329         AIAPI AIErr     (*Activate)( AIDocumentHandle document, ASBoolean bSetFocus );
00330 
00336         AIAPI AIErr     (*Print)( AIDocumentHandle document, ActionDialogStatus dialogStatus );
00337 
00338         // Introduced in Illustrator 13.0
00339 
00345         AIAPI AIErr     (*GetPresetSettings)( ai::UnicodeString &preset, AINewDocumentPreset *param );
00346 
00352         AIAPI ai::int32 (*CountRecentDocuments)();
00353 
00359         AIAPI AIErr (*GetNthRecentDocument)( ai::int32 index, ai::FilePath& document );
00360 
00364         AIAPI AIErr (*OpenNthRecentDocument)(ai::int32 index);
00365 
00369         AIAPI AIErr (*AddToRecentFiles)(const ai::FilePath &document);
00370 };
00371 
00372 #include "AIHeaderEnd.h"
00373 
00374 #endif