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 kAIRuntimeSuiteVersion12        AIAPI_VERSION(12)
00066 #define kAIRuntimeSuiteVersion  kAIRuntimeSuiteVersion12
00067 #define kAIRuntimeVersion               kAIRuntimeSuiteVersion
00068 
00076 #define kAIApplicationStartedNotifier           "AI Application Started Notifier"
00077 
00080 #define kAIApplicationShutdownNotifier          "AI Application Shutdown Notifier"
00081 
00084 const char* const kAIApplicationActivatedNotifier = "AI Application Activated Notifier";
00085 
00088 const char* const kAIApplicationDeactivatedNotifier = "AI Application Deactivated Notifier";
00089 
00090 
00091 
00092 /*******************************************************************************
00093  **
00094  **     Types
00095  **
00096  **/
00097 
00099 typedef const char *AIAppName;
00101 typedef const char *AIAppVersion;
00103 typedef const char *AIUserName;
00105 typedef const char *AIUserOrganization;
00107 typedef const char *AIUserSerialNumber;
00108 
00109 
00110 /*******************************************************************************
00111  **
00112  **     Suite
00113  **
00114  **/
00115 
00130 struct AIRuntimeSuite {
00131 
00140         AIAPI AIErr (*GetAppName) ( AIAppName *name );
00141 
00145         AIAPI AIErr (*GetAppFileSpecification) ( ai::FilePath &file );
00146 
00153         AIAPI AIErr (*GetUserName) ( AIUserName *name );
00154 
00161         AIAPI AIErr (*GetUserOrganization) ( AIUserOrganization *organization );
00162 
00169         AIAPI AIErr (*GetUserSerialNumber) ( AIUserSerialNumber *serialNumber );
00170 
00183         AIAPI AIErr (*GetAppNameSpace) ( AINameSpace **space );
00184 
00196         AIAPI AIErr (*GetAppStringPool) ( AIStringPool **pool );
00197 
00203         AIAPI size_t (*GetAppFreeMem) ( void );
00204 
00206         AIAPI AIErr (*ShowAppAboutBox) ( void );
00207 
00212         AIAPI ai::int32 (*GetSystemVersion) ( void );
00213 
00217         AIAPI AIBoolean (*GetIsSystemMacOSX) ( void );
00218 
00224         AIAPI ai::int32 (*GetAppMajorVersion) ( void );
00225 
00231         AIAPI ai::int32 (*GetAppMinorVersion) ( void );
00232 
00238         AIAPI ai::int32 (*GetAppRevisionVersion) ( void );
00239 
00244         AIAPI AIErr (*GetAppNameUS) ( ai::UnicodeString& name );
00245 
00251         AIAPI AIErr (*GetUserNameUS) ( ai::UnicodeString& name );
00252 
00258         AIAPI AIErr (*GetUserOrganizationUS) ( ai::UnicodeString& organization );
00259 
00263         AIAPI AIErr (*GetDefaultScript) ( AIFaceScript *script);
00264 
00266         AIAPI AIBoolean (*GetIsHonestyBuild) ( void );
00267 
00269         AIAPI AIBoolean (*GetIsProductTryAndDie) ( void );
00270 
00271         // Introduced in Illustrator 13
00272 
00274         AIAPI AIBoolean (*GetIsExeBuild) ( void );
00275 
00280         AIAPI AIErr (*ShowAdobeHelp) (const char *pageID);
00281         
00288         AIAPI ai::int32 (*GetAppBuildNumber) ( AIBoolean *isDebug );
00289         
00290         
00295         AIAPI ai::int32 (*GetUserAdobeID) (const char **userGUID, const char **userAdobeID);
00296 };
00297 
00298 
00299 #include "AIHeaderEnd.h"
00300 
00301 
00302 #endif