API: AIFolders.h Source File

00001 #ifndef __AIFolders__
00002 #define __AIFolders__
00003 
00004 /*
00005  *        Name: AIFolders.h
00006  *   $Revision: 1 $
00007  *      Author:  dmaclach
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Folders 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 #include "AIFilePath.h"
00035 
00036 #include "AIHeaderBegin.h"
00037 
00040 /*******************************************************************************
00041  **
00042  **     Suite name and version
00043  **
00044  **/
00045 
00046 #define kAIFoldersSuite                                 "AI Folders Suite"
00047 #define kAIFoldersSuiteVersion5                 AIAPI_VERSION(5)
00048 #define kAIFoldersSuiteVersion                  kAIFoldersSuiteVersion5
00049 #define kAIFoldersVersion                               kAIFoldersSuiteVersion
00050 
00051 /*******************************************************************************
00052  **
00053  **     Constants
00054  **
00055  **/
00056 
00059 #define kFolderNotFoundErr              'D!FD'
00060 
00061 
00062 /*******************************************************************************
00063  **
00064  **     Types
00065  **
00066  **/
00067 
00071 typedef enum AIFolderType
00072 {
00073                 kAIApplicationFolderType = 0,
00074                 kAIPluginsFolderType = 1,
00075                 kAIPrimaryScratchFolderType = 2,
00076                 kAISecondaryScratchFolderType = 3,
00077                 kAIPreferencesFolderType = 4,
00078                 kAIUserSupportFolderType = 5,
00079                 kAIUserSupportAIFolderType = 6,
00080                 kAIUserSupportAIPluginsFolderType = 7,
00081                 kAIApplicationSupportCommonFolderType = 8,
00082                 kAIApplicationSupportCommonColorFolderType = 9,
00083                 kAIApplicationSupportCommonTypeSupportFolderType = 10,
00084                 kAIApplicationSupportCommonFontsFolderType = 11,
00085                 kAIApplicationSupportCommonFontsReqrdFolderType = 12,
00086                 kAIApplicationSupportCommonFontsReqrdCMapsFolderType = 13,
00087             kAIRequiredFontsFolderType = 14,
00088                 kAIFontsFolderType = 15,
00089                 kAIMyDocumentsFolderType = 16,
00090                 kAIApplicationSupportCommonWorkflowFolderType = 17,
00091                 kAIPrinterDescriptionsFolderType = 18,
00092                 kAIRequiredPluginsFolderType = 19,
00093                 kAISettingsFolderType = 20,
00094                 kAIColorTableSettingsFolderType = 21,
00095                 kAIOptimizeSettingsFolderType = 22,
00096                 kAIHelpFolderType = 23,
00097                 kAIRootFolderType = 24,
00098                 kAIPresetsFolderType = 25,
00099                 /* The presets folder and all folders within it are in the application directory and may not be writable, especially on Vista. */
00100                 /* If your code intends to write settings files, please use one of the kAIUserSupport folders or the kAIUserWritable folders */
00101                 /* instead of the kAIPreset folders. */
00102                 kAIPresetActionsFolderType = 26,
00103                 kAIPresetBrushesFolderType = 27,
00104                 kAIPresetGradientsFolderType = 28,
00105                 kAIPresetKeyboardShortcutsFolderType = 29,
00106                 kAIPresetPatternsFolderType = 30,
00107                 kAIPresetScriptsFolderType = 31,
00108                 kAIPresetStylesFolderType = 32,
00109                 kAIPresetSwatchesFolderType = 33,
00110                 kAIDictionariesFolderType = 34,
00111                 kAILegalFolderType = 35,
00112                 kAISampleFilesFolderType = 36,
00113                 kAIUtilitiesFolderType = 37,
00114                 kAIPackageFolderType = 38,
00115                 kAIApplicationSupportCommonFontsReqrdBaseFolderType = 39,
00116                 kAIHelpersFolderType = 40,
00117                 kAIPreviewInFolderType = 41,
00119                 kAIStartupFileFolderType = 42,
00120                 kAIRidersFileFolderType = 43,
00121                 kAIHyphenationDictFolderType = 44,
00122                 kAIApplicationSupportCommonPDFLFolderType = 45,
00123                 kAIApplicationSupportCommonPDFL5FolderType = 46,
00124                 kAIApplicationSupportCommonPDFL5CMapsFolderType = 47,
00125                 kAIApplicationSupportCommonPDFL5FontsFolderType = 48,
00126                 kAIApplicationSupportCommonPrintSupportFolderType = 49,
00127                 kAIApplicationSupportCommonColorProfilesFolderType = 50,
00128                 kAIApplicationSupportCommonColorSettingsFolderType = 51,
00129                 kAIContentsFolderType = 52,
00130                 kAIHelpImagesFolderType = 53,
00131                 kAIFontsCMapsFolderType = 54,
00132                 kAIPresetSymbolsFolderType = 55,
00133                 kAITsumeFolderType = 56,
00134                 kAISpellingDictFolderType = 57,
00135                 kAIPresetTemplatesFolderType = 58,
00136                 kAIFontsCFFolderType = 59,
00137                 kAIApplicationSupportCommonKinsokuSetFolderType = 60,
00138                 kAIApplicationSupportCommonMojikumeSetFolderType = 61,
00139                 kAIPresetBlankDocumentsFolderType = 62,
00140                 kAIUserSupportCommonFontsFolderType = 63,
00141                 kAIFontsCFTempFolderType = 64,
00142                 kAILogsFolderType = 65,
00143                 kAISampleArtFolderType = 66,
00144                 kAISampleSVGFolderType = 67,
00145                 kAISampleGraphDesignsFolderType = 68,
00146                 kAISampleDataDrivenGraphicsFolderType = 69,
00147                 kAIWorkspacesFolderType = 70,
00148                 kAIPresetColorBooksFolderType = 71,
00149                 kAIPresetLegacyColorBooksFolderType = 72,
00150                 kAIPresetSwatchExchangeFolderType = 73,
00151                 kAIApplicationSupportCommonLinguisticsFolderType = 74,
00152                 kAIApplicationSupportCommonLinguisticsProvidersFolderType = 75,
00153                 kAIVersionCueFolderType = 76, // Deprecated.
00154                 kAIDemonstratorFolderType = 77,
00155                 kAIResourcesFolderType = 78,
00156                 kAICoolExtrasFolderType = 79,
00157                 kAIOutputSettingsFolderType = 80,
00158                 kAIStartupScriptsFolderType = 81,
00159                 kAIDesktopFolderType = 82,
00160                 kAIIllustratorFormatsFolderType = 83,
00161                 kAIAdditionalAIPluginsFolderType = 84,
00162                 kAIUserWritableStartupFileFolderType = 85,
00163                 kAIUserWritablePresetBrushesFolderType = 86,
00164                 kAIUserWritablePresetStylesFolderType = 87,
00165                 kAIUserWritablePresetSwatchesFolderType = 88,
00166                 kAIUserWritablePresetSwatchExchangeFolderType = 89,
00167                 kAIUserWritablePresetSymbolsFolderType = 90,
00168                 kAIPresetFlashPanelsFolderType = 91,
00169                 kAIPresetKnowhowFolderType = 92,        //Deprecated
00170                 kAIUserWritablePresetSettingsFolderType = 93,
00171                 kAIUserWritablePresetOptimizeSettingsFolderType = 94,
00172                 kAIUserWritablePresetOutputSettingsFolderType = 95,
00173                 kAIUserWritablePresetColorTableSettingsFolderType = 96,
00174                 kAIRequiredStartupProfilesFolderType = 97,
00175                 kAIPresetWorkspacesFolderType = 98,
00176                 kAIPresetKulerFolderType = 99,  //Deprecated
00177                 kAIPresetWelcomeScreenFolderType = 100,
00178                 kAIRequiredFolderType = 101,
00179                 kAIRequiredResourcesFolderType = 102,
00180                 kAIRequiredLocalizedResourcesFolderType = 103,
00181                 kAIWSMgrCfgFolderType = 104,
00182                 kAIModifiedWorkspacesFolderType = 105,
00183                 kAIToolsFolderType = 106,
00184                 kAIPreferencesRootFolderType = 107,
00185                 kAIRequiredLinguisticsFolderType = 108,
00186         kAITemporayFolder = 109,
00187                 kAIPresetChartsFolderType = 110,
00188         kAIMACSupportFilesFolderType = 111,
00189         kAIFrameworksDllsPath = 112,
00190                 kAIUserLocalSupportFolderType = 113,
00191         kAIAMTParentFolderType = 114,
00192 
00193 } AIFolderType;
00194 
00196 typedef enum
00197 {
00199         kAITemporaryFileType = 1
00200 
00201 } AIFileType;
00202 
00203 
00204 /*******************************************************************************
00205  **
00206  **     Suite
00207  **
00208  **/
00209 
00210 
00386 struct AIFoldersSuite {
00387 
00394         AIAPI AIErr (*FindFolder)(AIFolderType type, AIBoolean createFolder, ai::FilePath &folder);
00395 
00401         AIAPI AIErr (*GetFolderName)(AIFolderType type, ai::UnicodeString &name);
00402 
00408         AIAPI AIErr (*GetFileName)(AIFileType type, ai::FilePath &file);
00409 
00410 };
00411 
00412 
00413 #include "AIHeaderEnd.h"
00414 
00415 
00416 #endif