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-2008 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 kAIDocumentViewSuiteVersion13   AIAPI_VERSION(13)
00052 
00053 // latest version
00054 #define kAIDocumentViewSuiteVersion             kAIDocumentViewSuiteVersion13
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 
00079 /*******************************************************************************
00080  **
00081  **     Types
00082  **
00083  **/
00084 
00086 typedef void *AIDocumentPlatformViewBitmap;
00087 
00089 typedef struct _t_AIDocumentViewOpaque *AIDocumentViewHandle;
00090 
00093 enum AIScreenMode {
00095         kNoScreenMode,
00097         kNormalScreenMode,
00099         kFullScreenWithMenuMode,
00101         kFullScreenNoMenuMode,
00105         kMaximizedWindowMode_deprecated,
00107         kDummyWindowMode = 0xffffffff
00108 };
00109 
00114 struct AIPageTiling {
00117         AIPoint tilesPerArt;
00119         ASInt16 tilesPerArtPiece;
00123         AIRealRect bounds;
00125         AIRealPoint paperSize;
00127         AIRealPoint paperOrigin;
00129         AIRealPoint imageSize;
00131         AIRealPoint imageOrigin;
00133         AIRealPoint pieceDelta;
00134         /* When true, show outlines of page tiles. */
00135         AIBoolean showTiling;
00136 };
00137 
00138 
00141 #define kVsArtwork                      0x0001
00142 
00144 #define kVsPreview                      0x0002
00145 
00147 #define kVsRaster                       0x0040
00148 
00150 #define kVsOpaque                       0x0080
00151 
00153 #define kVsInk                          0x0100
00154 
00155 /*******************************************************************************
00156  **
00157  **     Suite
00158  **
00159  **/
00160 
00161 
00173 struct AIDocumentViewSuite {
00174 
00180         AIAPI AIErr (*GetDocumentViewBounds) ( AIDocumentViewHandle view, AIRealRect *bounds );
00181 
00187         AIAPI AIErr (*GetDocumentViewCenter) ( AIDocumentViewHandle view, AIRealPoint *center );
00188 
00193         AIAPI AIErr (*SetDocumentViewCenter) ( AIDocumentViewHandle view, const AIRealPoint *center );
00194 
00201         AIAPI AIErr (*GetDocumentViewZoom) ( AIDocumentViewHandle view, AIReal *zoom );
00202 
00211         AIAPI AIErr (*SetDocumentViewZoom) ( AIDocumentViewHandle view, AIReal zoom );
00212 
00220         AIAPI AIErr (*ArtworkPointToViewPoint) ( AIDocumentViewHandle view, const AIRealPoint *artworkPoint, AIPoint *viewPoint );
00221 
00228         AIAPI AIErr (*ViewPointToArtworkPoint) ( AIDocumentViewHandle view, const AIPoint *viewPoint, AIRealPoint *artworkPoint );
00229 
00234         AIAPI AIErr (*CountDocumentViews)( ai::int32 *count );
00235 
00241         AIAPI AIErr (*GetNthDocumentView)( ai::int32 n, AIDocumentViewHandle *view );
00242 
00250         AIAPI AIErr (*FixedArtworkPointToViewPoint) ( AIDocumentViewHandle view, const AIRealPoint *artworkPoint, AIRealPoint *viewPoint );
00251 
00258         AIAPI AIErr (*FixedViewPointToArtworkPoint) ( AIDocumentViewHandle view, const AIRealPoint *viewPoint, AIRealPoint *artworkPoint );
00259 
00265         AIAPI AIErr (*SetScreenMode) ( AIDocumentViewHandle view, AIScreenMode mode );
00266 
00272         AIAPI AIErr (*GetScreenMode) ( AIDocumentViewHandle view, AIScreenMode *mode );
00273 
00278         AIAPI AIErr (*GetPageTiling) ( AIPageTiling *pageTiling );
00279 
00284         AIAPI AIErr (*GetTemplateVisible) ( AIDocumentViewHandle view, AIBoolean *visible );
00285 
00291         AIAPI AIErr (*DocumentViewScrollDelta)( AIDocumentViewHandle view, AIRealPoint *delta);
00292 
00299         AIAPI AIErr (*GetDocumentViewInvalidRect)( AIDocumentViewHandle view, AIRealRect *invalidRect );
00300 
00308         AIAPI AIErr (*SetDocumentViewInvalidRect)( AIDocumentViewHandle view, const AIRealRect *invalidRect );
00309 
00315         AIAPI AIErr (*GetDocumentViewStyle)( AIDocumentViewHandle view,  ai::int16 *style );
00316 
00324         AIAPI AIErr (*SetDocumentViewInvalidDocumentRect)( AIDocumentViewHandle view, const AIRealRect *invalidRect );
00325 
00329         AIAPI AIErr (*GetShowPageTiling) ( AIBoolean *show );
00330 
00334         AIAPI AIErr (*SetShowPageTiling) ( AIBoolean show );
00335 
00341         AIAPI AIErr (*GetGridOptions) ( AIDocumentViewHandle view, AIBoolean* show, AIBoolean* snap );
00342 
00348         AIAPI AIErr (*SetGridOptions) ( AIDocumentViewHandle view, AIBoolean show, AIBoolean snap );
00349 
00354         AIAPI AIErr (*GetShowTransparencyGrid) ( AIDocumentViewHandle view, AIBoolean* show );
00355 
00360         AIAPI AIErr (*SetShowTransparencyGrid) ( AIDocumentViewHandle view, AIBoolean show );
00361 
00366         AIAPI AIErr (*GetDocumentViewDocument) ( AIDocumentViewHandle view, AIDocumentHandle *document );
00367 
00370         AIAPI AIErr (*ForceDocumentViewsOnScreen) ( void );
00371 
00376         AIAPI AIErr (*GetShowGuides) ( AIDocumentViewHandle view, AIBoolean* show );
00377 
00382         AIAPI AIErr (*SetShowGuides) ( AIDocumentViewHandle view, AIBoolean show );
00383 
00388         AIAPI AIErr (*GetShowEdges) ( AIDocumentViewHandle view, AIBoolean* show );
00389 
00394         AIAPI AIErr (*SetShowEdges) ( AIDocumentViewHandle view, AIBoolean show );
00395 
00403         AIAPI AIErr (*SaveImage) ( AIDocumentViewHandle view, const ai::UnicodeString &saveFilename, 
00404                 const AIPoint &windowSize );
00405 
00410         AIAPI AIErr (*IsArtboardRulerVisible) ( const AIDocumentViewHandle view, AIBoolean *visible );
00411 
00416         AIAPI AIErr (*SetArtboardRulerVisible) ( const AIDocumentViewHandle view, const AIBoolean visible );
00417         
00423         AIAPI AIErr (*CountOPPPlates) ( AIDocumentViewHandle view, ai::int32& count );
00424 
00429         AIAPI AIErr (*GetNthOPPPlate) ( AIDocumentViewHandle view, ai::int32 n, ai::ColorSpace& plate );
00430 
00437         AIAPI AIErr (*GetOPPPlateState) ( AIDocumentViewHandle view, const ai::ColorSpace& plate, AIBoolean& isOn );
00438 
00445         AIAPI AIErr (*SetOPPPlateState) ( AIDocumentViewHandle view, const ai::ColorSpace& plate, const AIBoolean isOn );
00446 
00456         AIAPI AIErr (*SetDocumentViewStyle)( AIDocumentViewHandle view,  ai::int16 style, ai::int16 mask );
00457 
00462         AIAPI AIErr (*IsRulerInArtboardCoordinates)( const AIDocumentViewHandle view, ASBoolean *isYes );
00463 
00468         AIAPI AIErr (*UseArtboardCoordinatesInRuler) ( const AIDocumentViewHandle view, const ASBoolean state );
00469 
00474         AIAPI AIBoolean (*IsGPUPreviewModeOn)(const AIDocumentViewHandle view);
00475 
00480         AIAPI AIErr (*GetGPUPixel)(AIWindowRef window, AIPoint location, AIColor& color);
00481 
00486         AIAPI AIErr (*GetDocumentViewVisibleArea)(AIDocumentViewHandle view, AIRealRect *bounds);
00487 
00488 };
00489 
00490 
00491 #include "AIHeaderEnd.h"
00492 
00493 
00494 #endif