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 
00095 #define kAnnotateNoPortType                     0
00096 
00097 #define kAnnotateWindowPortType         1
00098 
00099 #define kAnnotateGWorldPortType         2
00100 
00101 
00102 /*******************************************************************************
00103  **
00104  ** Types
00105  **
00106  **/
00107 
00109 typedef struct _t_AIAnnotatorOpaque *AIAnnotatorHandle;
00110 
00112 struct AIUpdateBezier
00113 {
00115         AIRealPoint p0;
00117         AIRealPoint p1;
00119         AIRealPoint p2;
00121         AIRealPoint p3;
00123         AIBoolean updateIt;
00125         AIBoolean drawIt;
00126 };
00127 
00131 struct AIAnnotatorMessage
00132 {
00134         SPMessageData d;
00137         AIAnnotatorHandle annotator;
00139         AIDocumentViewHandle view;
00144         ai::int32 updateType;
00149         void *updateData;
00155         ai::int32 portType;
00163         AIPortRef port;
00166         AIBoolean showEdges;
00167 
00187         const AIRealRect *invalidationRects;
00190         ai::int32 numInvalidationRects;
00191 
00195         class AIAnnotatorDrawer *drawer;
00196 };
00197 
00200 enum AIAnnotatorOptionsFlagValues
00201 {
00203         kDrawBeforeAllOthers            = 1,
00204 
00207         kDrawOnInactiveDocuments        = 1<<1,
00208 
00211         kDontDrawOnInactiveView                 = 1<<2,
00212 
00214         AIAnnotatorOptionsFlagValuesDummy       = 0xFFFFFFFF
00215 };
00216 
00217 typedef ai::int32 AIAnnotatorOptionsFlags;
00218 
00219 /*******************************************************************************
00220  **
00221  **     Suite Record
00222  **
00223  **/
00224 
00225 
00254 struct AIAnnotatorSuite
00255 {
00263         AIAPI AIErr (*AddAnnotator) ( SPPluginRef self, const char *name, AIAnnotatorHandle *notifier );
00264 
00270         AIAPI AIErr (*GetAnnotatorName) ( AIAnnotatorHandle notifier, const char **name );
00271 
00277         AIAPI AIErr (*GetAnnotatorActive) ( AIAnnotatorHandle notifier, AIBoolean *active );
00278 
00284         AIAPI AIErr (*SetAnnotatorActive) ( AIAnnotatorHandle notifier, AIBoolean active );
00285 
00291         AIAPI AIErr (*GetAnnotatorPlugin) ( AIAnnotatorHandle notifier, SPPluginRef *plugin );
00292 
00298         AIAPI AIErr (*CountAnnotators) ( ai::int32 *count );
00305         AIAPI AIErr (*GetNthAnnotator) ( ai::int32 n, AIAnnotatorHandle *notifier );
00306 
00323         AIAPI AIErr (*InvalAnnotationRect)( AIDocumentViewHandle view, const AIRect *annotationBounds );
00324 
00330         AIAPI AIErr (*SetAnnotatorAlternatePlugin) ( AIAnnotatorHandle notifier, SPPluginRef plugin );
00331 
00336         AIAPI AIErr (*GetAnnotatorAlternatePlugin) ( AIAnnotatorHandle notifier, SPPluginRef *plugin );
00337 
00343         AIAPI AIErr (*GetAnnotatorOptions) ( AIAnnotatorHandle notifier, AIAnnotatorOptionsFlags *flags );
00348         AIAPI AIErr (*SetAnnotatorOptions) ( AIAnnotatorHandle notifier, const AIAnnotatorOptionsFlags flags );
00349 };
00350 
00351 
00352 #include "AIHeaderEnd.h"
00353 
00354 
00355 #endif