API: AIContext.h Source File

00001 #ifndef __AIContext__
00002 #define __AIContext__
00003 
00004 /*
00005  *        Name: AIContext.h
00006  *   $Revision: 2 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Runtime Context Environment.
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 __AIDocument__
00035 #include "AIDocument.h"
00036 #endif
00037 
00038 #ifndef __SPPlugins__
00039 #include "SPPlugs.h"
00040 #endif
00041 
00042 
00043 #include "AIHeaderBegin.h"
00044 
00048 /*******************************************************************************
00049  **
00050  ** Constants
00051  **
00052  **/
00053 
00054 #define kAIAppContextSuite                      "AI Context Suite"
00055 #define kAIAppContextSuiteVersion       AIAPI_VERSION(8)
00056 #define kAIAppContextVersion            kAIAppContextSuiteVersion
00057 
00058 enum AIAppContextKind
00059 {
00060         kAIAppContextStandardKind               = 0,
00061         kAIAppContextUndoRedoKind               = 1,
00062         kAIAppContextBetaUpdateKind     = 2
00063 };
00064 
00065 /*******************************************************************************
00066  **
00067  **     Types
00068  **
00069  **/
00070 
00072 typedef struct _t_AIAppContextOpaque *AIAppContextHandle;
00073 
00075 typedef struct _t_AISuspendedAppContextOpaque *AISuspendedAppContext;
00076 
00078 typedef struct _t_AIAppMenuContextOpaque *AIAppMenuContext;
00079 
00080 /*******************************************************************************
00081  **
00082  **     Suite
00083  **
00084  **/
00085 
00108 typedef struct {
00109 
00114         AIAPI AIErr (*GetPlatformAppWindow) ( AIWindowRef *appWindow );
00115 
00123         AIAPI AIErr (*PushAppContext) ( SPPluginRef plugin, AIAppContextHandle *appContext );
00124 
00129         AIAPI AIErr (*PopAppContext) ( AIAppContextHandle appContext );
00130 
00132         AIAPI AIErr (*MacGetAppQDGlobal) ( void **appQD );
00133 
00141         AIAPI AIErr (*SuspendAppContext) ( AISuspendedAppContext* appContext );
00142 
00149         AIAPI AIErr (*ResumeAppContext) ( AISuspendedAppContext appContext, AIDocumentHandle document );
00150 
00160         AIAPI AIErr (*AllowAllChanges) ( ASBoolean allowAllChanges, ASBoolean *previousState );
00161 
00165         AIAPI AIErr (*AllowProgress)(bool showProgress);
00166         
00171         AIAPI AIErr (*GetPlatformAppMenu) ( AIAppMenuContext *appMenu );
00172 
00178         AIAPI AIErr (*SetAppContextKind) (AIAppContextKind kind );
00179 
00180 
00183         AIAPI AIErr (*SyncAndDraw) ();
00184 
00190         AIAPI AIErr (*GetRulerWidthOffsetOnActiveDocument) (AIRect *horzRulerBounds, AIRect *vertRulerBounds, AIRect *cntrRulerBounds);
00191 
00196         AIAPI AIBoolean (*DoesAppContextExist)();
00197 
00198 } AIAppContextSuite;
00199 
00200 
00201 #include "AIHeaderEnd.h"
00202 
00203 
00204 #endif