API: AIAnnotator.h Source File

00001 #ifndef __AIAnnotator__
00002 #define __AIAnnotator__
00003 
00004 /*
00005  *        Name: AIAnnotator.h
00006  *   $Revision: 8 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Annotator 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 __AIDocumentView__
00035 #include "AIDocumentView.h"
00036 #endif
00037 
00038 #ifndef __AIFixedMath__
00039 #include "AIFixedMath.h"
00040 #endif
00041 
00042 #ifndef __AIRealMath__
00043 #include "AIRealMath.h"
00044 #endif
00045 
00046 #ifndef __AIPlugin__
00047 #include "AIPlugin.h"
00048 #endif
00049 
00050 
00051 #include "AIHeaderBegin.h"
00052 
00056 /*******************************************************************************
00057  **
00058  ** Constants
00059  **
00060  **/
00061 
00062 #define kAIAnnotatorSuite                       "AI Annotator Suite"
00063 #define kAIAnnotatorSuiteVersion6       AIAPI_VERSION(6)
00064 #define kAIAnnotatorSuiteVersion        kAIAnnotatorSuiteVersion6
00065 #define kAIAnnotatorVersion                     kAIAnnotatorSuiteVersion
00066 
00069 #define kCallerAIAnnotation "AI Annotation"
00070 
00073 #define kSelectorAIDrawAnnotation               "AI Draw"
00074 
00078 #define kSelectorAIInvalAnnotation              "AI Invalidate"
00079 
00081 #define kAnnotateNothing                        0
00082 
00083 #define kAnnotateBetaObject                     1
00084 
00085 #define kAnnotateBetaObjects            2
00086 
00087 #define kAnnotateBeziers                        3
00088 
00089 #define kAnnotateText                           4
00090 
00091 #define kAnnotateArtObject                      5
00092 
00093 
00094 #if defined(MAC_ENV) || defined(WIN_ENV)
00095 
00096 #define kAnnotateNoPortType                     0
00097 
00098 #define kAnnotateWindowPortType         1
00099 
00100 #define kAnnotateGWorldPortType         2
00101 #endif
00102 
00103 
00104 /*******************************************************************************
00105  **
00106  ** Types
00107  **
00108  **/
00109 
00111 typedef struct _t_AIAnnotatorOpaque *AIAnnotatorHandle;
00112 
00114 struct AIUpdateBezier
00115 {
00117         AIRealPoint p0;
00119         AIRealPoint p1;
00121         AIRealPoint p2;
00123         AIRealPoint p3;
00125         AIBoolean updateIt;
00127         AIBoolean drawIt;
00128 };
00129 
00133 struct AIAnnotatorMessage
00134 {
00136         SPMessageData d;
00139         AIAnnotatorHandle annotator;
00141         AIDocumentViewHandle view;
00146         ai::int32 updateType;
00151         void *updateData;
00157         ai::int32 portType;
00165         AIPortRef port;
00168         AIBoolean showEdges;
00169 
00189         const AIRealRect *invalidationRects;
00192         ai::int32 numInvalidationRects;
00193 
00197         class AIAnnotatorDrawer *drawer;
00198 };
00199 
00202 enum AIAnnotatorOptionsFlagValues
00203 {
00205         kDrawBeforeAllOthers            = 1,
00206 
00209         kDrawOnInactiveDocuments        = 1<<1,
00210 
00213         kDontDrawOnInactiveView                 = 1<<2,
00214 
00216         AIAnnotatorOptionsFlagValuesDummy       = 0xFFFFFFFF
00217 };
00218 
00219 typedef ai::int32 AIAnnotatorOptionsFlags;
00220 
00221 /*******************************************************************************
00222  **
00223  **     Suite Record
00224  **
00225  **/
00226 
00227 
00256 struct AIAnnotatorSuite
00257 {
00265         AIAPI AIErr (*AddAnnotator) ( SPPluginRef self, const char *name, AIAnnotatorHandle *notifier );
00266 
00272         AIAPI AIErr (*GetAnnotatorName) ( AIAnnotatorHandle notifier, const char **name );
00273 
00279         AIAPI AIErr (*GetAnnotatorActive) ( AIAnnotatorHandle notifier, AIBoolean *active );
00280 
00286         AIAPI AIErr (*SetAnnotatorActive) ( AIAnnotatorHandle notifier, AIBoolean active );
00287 
00293         AIAPI AIErr (*GetAnnotatorPlugin) ( AIAnnotatorHandle notifier, SPPluginRef *plugin );
00294 
00300         AIAPI AIErr (*CountAnnotators) ( ai::int32 *count );
00307         AIAPI AIErr (*GetNthAnnotator) ( ai::int32 n, AIAnnotatorHandle *notifier );
00308 
00325         AIAPI AIErr (*InvalAnnotationRect)( AIDocumentViewHandle view, const AIRect *annotationBounds );
00326 
00332         AIAPI AIErr (*SetAnnotatorAlternatePlugin) ( AIAnnotatorHandle notifier, SPPluginRef plugin );
00333 
00338         AIAPI AIErr (*GetAnnotatorAlternatePlugin) ( AIAnnotatorHandle notifier, SPPluginRef *plugin );
00339 
00345         AIAPI AIErr (*GetAnnotatorOptions) ( AIAnnotatorHandle notifier, AIAnnotatorOptionsFlags *flags );
00350         AIAPI AIErr (*SetAnnotatorOptions) ( AIAnnotatorHandle notifier, const AIAnnotatorOptionsFlags flags );
00351 };
00352 
00353 
00354 #include "AIHeaderEnd.h"
00355 
00356 
00357 #endif