API: AIRuntime.h Source File

00001 #ifndef __AIRuntime__
00002 #define __AIRuntime__
00003 
00004 /*
00005  *        Name: AIRuntime.h
00006  *   $Revision: 11 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Runtime Environment.
00010  *
00011  * ADOBE SYSTEMS INCORPORATED
00012  * Copyright 1986-2016 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 __AINameSpace__
00035 #include "AINameSpace.h"
00036 #endif
00037 
00038 #ifndef __AIStringPool__
00039 #include "AIStringPool.h"
00040 #endif
00041 
00042 #ifndef __AIPlugin__
00043 #include "AIPlugin.h"
00044 #endif
00045 
00046 #ifndef __AIUnicodeString__
00047 #include "AIUnicodeString.h"
00048 #endif //__AIUnicodeString__
00049 
00050 #ifndef __AIFont__
00051 #include "AIFont.h"
00052 #endif
00053 
00054 #include "AIHeaderBegin.h"
00055 
00058 /*******************************************************************************
00059  **
00060  ** Constants
00061  **
00062  **/
00063 
00064 #define kAIRuntimeSuite                 "AI Runtime Suite"
00065 #define kAIRuntimeSuiteVersion13        AIAPI_VERSION(13)
00066 #define kAIRuntimeSuiteVersion  kAIRuntimeSuiteVersion13
00067 #define kAIRuntimeVersion               kAIRuntimeSuiteVersion
00068 
00076 #define kAIApplicationStartedNotifier           "AI Application Started Notifier"
00077 
00080 #define kAIApplicationShutdownNotifier          "AI Application Shutdown Notifier"
00081 
00086 #define kAISaveUserDataNotifier                         "AI Save User Data Notifier"
00087 
00090 const char* const kAIApplicationActivatedNotifier = "AI Application Activated Notifier";
00091 
00094 const char* const kAIApplicationDeactivatedNotifier = "AI Application Deactivated Notifier";
00095 
00096 
00097 
00098 /*******************************************************************************
00099  **
00100  **     Types
00101  **
00102  **/
00103 
00105 typedef const char *AIAppName;
00107 typedef const char *AIAppVersion;
00109 typedef const char *AIUserName;
00111 typedef const char *AIUserOrganization;
00113 typedef const char *AIUserSerialNumber;
00114 
00115 
00116 /*******************************************************************************
00117  **
00118  **     Suite
00119  **
00120  **/
00121 
00136 struct AIRuntimeSuite {
00137 
00146         AIAPI AIErr (*GetAppName) ( AIAppName *name );
00147 
00151         AIAPI AIErr (*GetAppFileSpecification) ( ai::FilePath &file );
00152 
00159         AIAPI AIErr (*GetUserName) ( AIUserName *name );
00160 
00167         AIAPI AIErr (*GetUserOrganization) ( AIUserOrganization *organization );
00168 
00175         AIAPI AIErr (*GetUserSerialNumber) ( AIUserSerialNumber *serialNumber );
00176 
00189         AIAPI AIErr (*GetAppNameSpace) ( AINameSpace **space );
00190 
00202         AIAPI AIErr (*GetAppStringPool) ( AIStringPool **pool );
00203 
00209         AIAPI size_t (*GetAppFreeMem) ( void );
00210 
00212         AIAPI AIErr (*ShowAppAboutBox) ( void );
00213 
00218         AIAPI ai::int32 (*GetSystemVersion) ( void );
00219 
00223         AIAPI AIBoolean (*GetIsSystemMacOSX) ( void );
00224 
00230         AIAPI ai::int32 (*GetAppMajorVersion) ( void );
00231 
00237         AIAPI ai::int32 (*GetAppMinorVersion) ( void );
00238 
00244         AIAPI ai::int32 (*GetAppRevisionVersion) ( void );
00245 
00250         AIAPI AIErr (*GetAppNameUS) ( ai::UnicodeString& name );
00251 
00257         AIAPI AIErr (*GetUserNameUS) ( ai::UnicodeString& name );
00258 
00264         AIAPI AIErr (*GetUserOrganizationUS) ( ai::UnicodeString& organization );
00265 
00269         AIAPI AIErr (*GetDefaultScript) ( AIFaceScript *script);
00270 
00272         AIAPI AIBoolean (*GetIsHonestyBuild) ( void );
00273 
00275         AIAPI AIBoolean (*GetIsProductTryAndDie) ( void );
00276 
00277         // Introduced in Illustrator 13
00278 
00280         AIAPI AIBoolean (*GetIsExeBuild) ( void );
00281 
00286         AIAPI AIErr (*ShowAdobeHelp) (const char *pageID);
00287         
00294         AIAPI ai::int32 (*GetAppBuildNumber) ( AIBoolean *isDebug );
00295         
00296         
00301         AIAPI ai::int32 (*GetUserAdobeID) (const char **userGUID, const char **userAdobeID);
00302     
00307     AIAPI AIBoolean (*IsAIRobin) (void);
00308     
00309     AIAPI void (*PostQuit)(void);
00310     
00311 };
00312 
00313 
00314 #include "AIHeaderEnd.h"
00315 
00316 
00317 #endif