API: AIGrid.h Source File

00001 #ifndef __AIGrid__
00002 #define __AIGrid__
00003 
00004 /*
00005  *        Name: AIGrid.h
00006  *   $Revision: 13 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Grid 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 
00031 #ifndef __AITypes__
00032 #include "AITypes.h"
00033 #endif
00034 #ifndef __AIArt__
00035 #include "AIArt.h"
00036 #endif
00037 #ifndef __AIDocumentView__
00038 #include "AIDocumentView.h"
00039 #endif
00040 
00041 #include "AIHeaderBegin.h"
00042 
00045 /*******************************************************************************
00046  **
00047  ** Constants
00048  **
00049  **/
00051 #define kAIGridSuite                    "AI Grid Suite"
00052 
00053 #define kAIGridSuiteVersion5    AIAPI_VERSION(5)
00054 
00055 #define kAIGridSuiteVersion             kAIGridSuiteVersion5
00056 
00057 #define kAIGridVersion                  kAIGridSuiteVersion
00058 
00059 
00061 enum {
00063         kAIGridStyleGraph = 0,
00065         kAIGridStyleDotted
00066 };
00067 
00068 
00069 /*******************************************************************************
00070  **
00071  **     Types
00072  **
00073  **/
00074 
00076 typedef struct {
00078         AIFloat                         spacing;
00081         ai::int32                               ticks;
00082 } AIGridSpacing;
00083 
00086 typedef struct {
00088         AIBoolean                       isinback;
00091         ai::int32                               style;
00093         AIGridSpacing           spacing;
00095         AIRGBColor                      darkcolor;
00097         AIRGBColor                      litecolor;
00098 } AIGridSettings;
00099 
00108 typedef ASErr ASAPI (*AIGridLineProc)   (void* data,
00109                                                                                 AIRealPoint p0,
00110                                                                                 AIRealPoint p1);
00111 
00120 typedef ASErr ASAPI (*AIPageLineProc)   (void* data,
00121                                                                                 AIRealPoint p0,
00122                                                                                 AIRealPoint p1);
00123 
00124 
00125 /*******************************************************************************
00126  **
00127  **     Suite
00128  **
00129  **/
00130 
00137 typedef struct {
00138 
00142         AIAPI AIErr (*GetGridSettings)          (AIGridSettings* settings);
00147         AIAPI AIErr (*SetGridSettings)          (AIGridSettings* settings);
00148 
00156         AIAPI AIErr     (*EnumGridLines)                (AIDocumentViewHandle view,
00157                                                                                 AIRealRect *rect,
00158                                                                                 AIGridLineProc proc,
00159                                                                                 void* data);
00160 
00168         AIAPI AIErr     (*EnumPageLines)                (AIDocumentViewHandle view,
00169                                                                                 AIRealRect *rect,
00170                                                                                 AIPageLineProc proc,
00171                                                                                 void* data);
00172 
00178         AIAPI AIBoolean (*IsVisible)            (AIDocumentViewHandle view);
00179 
00186         AIAPI AIBoolean (*IsSnapOn)                     (AIDocumentViewHandle view);
00187 
00188 } AIGridSuite;
00189 
00190 
00191 #include "AIHeaderEnd.h"
00192 
00193 
00194 #endif