API: AIDocumentView.h Source File

00001 #ifndef __AIDocumentView__
00002 #define __AIDocumentView__
00003 
00004 /*
00005  *     Name:    AIDocumentView.h
00006  *     Purpose: Adobe Illustrator Document View Suite.
00007  *
00008  * ADOBE SYSTEMS INCORPORATED
00009  * Copyright 1986-2017 Adobe Systems Incorporated.
00010  * All rights reserved.
00011  *
00012  * NOTICE:  Adobe permits you to use, modify, and distribute this file 
00013  * in accordance with the terms of the Adobe license agreement 
00014  * accompanying it. If you have received this file from a source other 
00015  * than Adobe, then your use, modification, or distribution of it 
00016  * requires the prior written permission of Adobe.
00017  *
00018  */
00019 
00020 
00021 /*******************************************************************************
00022  **
00023  **     Imports
00024  **
00025  **/
00026 
00027 #ifndef __AITypes__
00028 #include "AITypes.h"
00029 #endif
00030 
00031 #ifndef __AIRealMath__
00032 #include "AIRealMath.h"
00033 #endif
00034 
00035 #ifndef __AIDocument__
00036 #include "AIDocument.h"
00037 #endif
00038 
00039 
00040 #include "AIHeaderBegin.h"
00041 
00044 /*******************************************************************************
00045  **
00046  **     Constants
00047  **
00048  **/
00049 
00050 #define kAIDocumentViewSuite                    "AI Document View Suite"
00051 #define kAIDocumentViewSuiteVersion14   AIAPI_VERSION(14)
00052 
00053 // latest version
00054 #define kAIDocumentViewSuiteVersion             kAIDocumentViewSuiteVersion14
00055 #define kAIDocumentViewVersion                  kAIDocumentViewSuiteVersion
00056 
00059 #define kAIDocumentViewChangedNotifier                          "AI Document View Changed Notifier"
00060 
00062 #define kAIDocumentViewInvalidRectChangedNotifier       "AI Document View Invalid Rect Changed Notifier"
00063 
00065 #define kAIDocumentViewStyleChangedNotifier                     "AI Document View Style Changed Notifier"
00066 
00068 #define kAIDocumentViewActiveViewChangedNotifier        "AI Document View Style Active View Changed Notifier"
00069 
00071 #define kAIDocumentViewOPPPlateStateChangedNotifier     "AI Document View Plate State Changed Notifier"
00072 
00074 #define kAIDocumentViewEdgesVisibilityChangeNotifier "AI Document View Edges Visibility Change Notifier"
00075 
00077 #define kAIActiveDocViewTitleChangedNotifier "AI Document View Title Changed Notifier"
00078 
00080 #define kAIDocViewTrimViewStateChangedNotifier "AI Document View Trim View State Changed Notifier"
00081 
00084 #define kAIDocViewRenderModeChangedNotifier "AI Document View Render Mode Changed Notifier"
00085 /*******************************************************************************
00086  **
00087  **     Types
00088  **
00089  **/
00090 
00092 typedef void *AIDocumentPlatformViewBitmap;
00093 
00095 typedef struct _t_AIDocumentViewOpaque *AIDocumentViewHandle;
00096 
00099 enum AIScreenMode {
00101         kNoScreenMode,
00103         kNormalScreenMode,
00105         kFullScreenWithMenuMode,
00107         kFullScreenNoMenuMode,
00109     kAIPresentationMode,
00111         kDummyWindowMode = 0xffffffff
00112 };
00113 
00118 struct AIPageTiling {
00121         AIPoint tilesPerArt;
00123         ASInt16 tilesPerArtPiece;
00127         AIRealRect bounds;
00129         AIRealPoint paperSize;
00131         AIRealPoint paperOrigin;
00133         AIRealPoint imageSize;
00135         AIRealPoint imageOrigin;
00137         AIRealPoint pieceDelta;
00138         /* When true, show outlines of page tiles. */
00139         AIBoolean showTiling;
00140 };
00141 
00142 
00145 #define kVsArtwork                      0x0001
00146 
00148 #define kVsPreview                      0x0002
00149 
00151 #define kVsRaster                       0x0040
00152 
00154 #define kVsOpaque                       0x0080
00155 
00157 #define kVsInk                          0x0100
00158 
00159 /*******************************************************************************
00160  **
00161  **     Suite
00162  **
00163  **/
00164 
00165 
00177 struct AIDocumentViewSuite {
00178 
00184         AIAPI AIErr (*GetDocumentViewBounds) ( AIDocumentViewHandle view, AIRealRect *bounds );
00185 
00191         AIAPI AIErr (*GetDocumentViewCenter) ( AIDocumentViewHandle view, AIRealPoint *center );
00192 
00197         AIAPI AIErr (*SetDocumentViewCenter) ( AIDocumentViewHandle view, const AIRealPoint *center );
00198         
00205         AIAPI AIErr(*GetDocumentViewUserVisibleZoom) (AIDocumentViewHandle view, AIReal *zoom);
00206 
00213         AIAPI AIErr (*GetDocumentViewZoom) ( AIDocumentViewHandle view, AIReal *zoom );
00214 
00223         AIAPI AIErr (*SetDocumentViewZoom) ( AIDocumentViewHandle view, AIReal zoom );
00224 
00233         AIAPI AIErr(*SetDocumentViewUserVisibleZoom) (AIDocumentViewHandle view, AIReal zoom);
00234 
00242         AIAPI AIErr (*ArtworkPointToViewPoint) ( AIDocumentViewHandle view, const AIRealPoint *artworkPoint, AIPoint *viewPoint );
00243 
00250         AIAPI AIErr (*ViewPointToArtworkPoint) ( AIDocumentViewHandle view, const AIPoint *viewPoint, AIRealPoint *artworkPoint );
00251 
00256         AIAPI AIErr (*CountDocumentViews)( ai::int32 *count );
00257 
00263         AIAPI AIErr (*GetNthDocumentView)( ai::int32 n, AIDocumentViewHandle *view );
00264 
00272         AIAPI AIErr (*FixedArtworkPointToViewPoint) ( AIDocumentViewHandle view, const AIRealPoint *artworkPoint, AIRealPoint *viewPoint );
00273 
00280         AIAPI AIErr (*FixedViewPointToArtworkPoint) ( AIDocumentViewHandle view, const AIRealPoint *viewPoint, AIRealPoint *artworkPoint );
00281 
00287         AIAPI AIErr (*SetScreenMode) ( AIDocumentViewHandle view, AIScreenMode mode );
00288 
00294         AIAPI AIErr (*GetScreenMode) ( AIDocumentViewHandle view, AIScreenMode *mode );
00295 
00300         AIAPI AIErr (*GetPageTiling) ( AIPageTiling *pageTiling );
00301 
00306         AIAPI AIErr (*GetTemplateVisible) ( AIDocumentViewHandle view, AIBoolean *visible );
00307 
00313         AIAPI AIErr (*DocumentViewScrollDelta)( AIDocumentViewHandle view, AIRealPoint *delta);
00314 
00321         AIAPI AIErr (*GetDocumentViewInvalidRect)( AIDocumentViewHandle view, AIRealRect *invalidRect );
00322 
00330         AIAPI AIErr (*SetDocumentViewInvalidRect)( AIDocumentViewHandle view, const AIRealRect *invalidRect );
00331 
00337         AIAPI AIErr (*GetDocumentViewStyle)( AIDocumentViewHandle view,  ai::int16 *style );
00338 
00346         AIAPI AIErr (*SetDocumentViewInvalidDocumentRect)( AIDocumentViewHandle view, const AIRealRect *invalidRect );
00347 
00351         AIAPI AIErr (*GetShowPageTiling) ( AIBoolean *show );
00352 
00356         AIAPI AIErr (*SetShowPageTiling) ( AIBoolean show );
00357 
00363         AIAPI AIErr (*GetGridOptions) ( AIDocumentViewHandle view, AIBoolean* show, AIBoolean* snap );
00364 
00370         AIAPI AIErr (*SetGridOptions) ( AIDocumentViewHandle view, AIBoolean show, AIBoolean snap );
00371 
00376         AIAPI AIErr (*GetShowTransparencyGrid) ( AIDocumentViewHandle view, AIBoolean* show );
00377 
00382         AIAPI AIErr (*SetShowTransparencyGrid) ( AIDocumentViewHandle view, AIBoolean show );
00383 
00388         AIAPI AIErr (*GetDocumentViewDocument) ( AIDocumentViewHandle view, AIDocumentHandle *document );
00389 
00392         AIAPI AIErr (*ForceDocumentViewsOnScreen) ( void );
00393 
00398         AIAPI AIErr (*GetShowGuides) ( AIDocumentViewHandle view, AIBoolean* show );
00399 
00404         AIAPI AIErr (*SetShowGuides) ( AIDocumentViewHandle view, AIBoolean show );
00405 
00410         AIAPI AIErr (*GetShowEdges) ( AIDocumentViewHandle view, AIBoolean* show );
00411 
00416         AIAPI AIErr (*SetShowEdges) ( AIDocumentViewHandle view, AIBoolean show );
00417 
00425         AIAPI AIErr (*SaveImage) ( AIDocumentViewHandle view, const ai::UnicodeString &saveFilename, 
00426                 const AIPoint &windowSize );
00427 
00432         AIAPI AIErr (*IsArtboardRulerVisible) ( const AIDocumentViewHandle view, AIBoolean *visible );
00433 
00438         AIAPI AIErr (*SetArtboardRulerVisible) ( const AIDocumentViewHandle view, const AIBoolean visible );
00439         
00445         AIAPI AIErr (*CountOPPPlates) ( AIDocumentViewHandle view, ai::int32& count );
00446 
00451         AIAPI AIErr (*GetNthOPPPlate) ( AIDocumentViewHandle view, ai::int32 n, ai::ColorSpace& plate );
00452 
00459         AIAPI AIErr (*GetOPPPlateState) ( AIDocumentViewHandle view, const ai::ColorSpace& plate, AIBoolean& isOn );
00460 
00467         AIAPI AIErr (*SetOPPPlateState) ( AIDocumentViewHandle view, const ai::ColorSpace& plate, const AIBoolean isOn );
00468 
00478         AIAPI AIErr (*SetDocumentViewStyle)( AIDocumentViewHandle view,  ai::int16 style, ai::int16 mask );
00479 
00484         AIAPI AIErr (*IsRulerInArtboardCoordinates)( const AIDocumentViewHandle view, ASBoolean *isYes );
00485 
00490         AIAPI AIErr (*UseArtboardCoordinatesInRuler) ( const AIDocumentViewHandle view, const ASBoolean state );
00491 
00496         AIAPI AIBoolean (*IsGPUPreviewModeOn)(const AIDocumentViewHandle view);
00497 
00502         AIAPI AIBoolean(*IsGPURenderingOn)(const AIDocumentViewHandle view);
00503 
00508         AIAPI AIErr (*GetGPUPixel)(AIWindowRef window, AIPoint location, AIColor& color);
00509 
00514         AIAPI AIErr (*GetDocumentViewVisibleArea)(AIDocumentViewHandle view, AIRealRect *bounds);
00515     
00519     AIAPI AIErr (*SetClipViewToArtboards) (AIDocumentViewHandle view, AIBoolean clipToActiveArtboard);
00520     
00524     AIAPI AIErr(*GetClipViewToArtboards)(AIDocumentViewHandle view, AIBoolean& clipToActiveArtboard);
00525     
00531     AIAPI AIErr (*ScreenShot)(AIDocumentViewHandle view, const ai::UnicodeString &saveFilePath);
00532 };
00533 
00534 
00535 #include "AIHeaderEnd.h"
00536 
00537 
00538 #endif