API: AIWorkspace.h Source File

00001 #ifndef __AIWorkspace__
00002 #define __AIWorkspace__
00003 
00004 /*
00005  *        Name: AIWorkspace.h
00006  *              $Id $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Workspace Suite.
00010  *
00011  * ADOBE SYSTEMS INCORPORATED
00012  * Copyright 2004-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 #ifndef __AITypes__
00030 #include "AITypes.h"
00031 #endif
00032 
00033 #ifndef __SPAccess__
00034 #include "SPAccess.h"
00035 #endif
00036 
00037 #include "AIHeaderBegin.h"
00038 
00040 /*******************************************************************************
00041  **
00042  **     Constants
00043  **
00044  **/
00045 
00047 #define kAIWorkspaceSuite                                       "AI Workspace Suite"
00048 #define kAIWorkspaceSuiteVersion3                       AIAPI_VERSION(3)
00049 #define kAIWorkspaceSuiteVersion                        kAIWorkspaceSuiteVersion3
00050 #define kAIWorkspaceVersion                                     kAIWorkspaceSuiteVersion
00051 
00053 #define kMaxWSStringLength                      (64)
00054 
00055 
00058 #define kAIWorkspaceCaller                                      "Workspace Manager"
00059 
00074 #define kAIWSWriteSelector                                      "Write Workspace"
00075 
00089 #define kAIWSRestoreSelector                            "Restore Workspace"
00090 
00097 #define kAIWSDefaultSelector                            "Default Workspace"
00098 
00102 #define kWorkspaceNameTooLongErr                        'WSNL'
00103 
00105 enum AIWorkspaceDefaultValue {
00106         kAIWSDefaultPreset = 1,
00107         kAIWSAICSPreset
00108 };
00109 
00110 /*******************************************************************************
00111  **
00112  **     Types
00113  **
00114  **/
00116 typedef struct _AIWorkspace*                    AIWorkspaceHandle;
00117 
00119 typedef struct {
00121         SPMessageData d;
00123         AIWorkspaceHandle workspace;
00126         const char *dialogName;
00130         AIBoolean restore;
00132         AIWorkspaceDefaultValue flag;
00133 } AIWorkspaceMessage;
00134 
00135 /*******************************************************************************
00136  **
00137  **     Suites
00138  **
00139  **/
00140 
00160 typedef struct {
00161 
00168         AIAPI AIErr (*GetIntegerValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, int *value);
00169 
00176         AIAPI AIErr (*SetIntegerValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, ai::int32 value);
00177 
00184         AIAPI AIErr (*GetRealValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIReal *value);
00185 
00192         AIAPI AIErr (*SetRealValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIReal value);
00193 
00200         AIAPI AIErr (*GetBooleanValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIBoolean *value);
00201 
00208         AIAPI AIErr (*SetBooleanValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIBoolean value);
00209 
00216         AIAPI AIErr (*GetStringValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, char *value, ai::int32 length);
00217 
00224         AIAPI AIErr (*SetStringValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, const char *value);
00225 
00232         AIAPI AIErr (*GetPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIPoint *value);
00233 
00240         AIAPI AIErr (*SetPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIPoint value);
00241 
00248         AIAPI AIErr (*GetRealPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealPoint *value);
00249 
00256         AIAPI AIErr (*SetRealPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealPoint value);
00257 
00264         AIAPI AIErr (*GetRectValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRect *value);
00265 
00272         AIAPI AIErr (*SetRectValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRect value);
00273 
00280         AIAPI AIErr (*GetRealRectValue)(AIWorkspaceHandle collectioRef, const char *prefix, const char *suffix, AIRealRect *value);
00281 
00288         AIAPI AIErr (*SetRealRectValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealRect value);
00289 
00296         AIAPI AIErr (*GetRealMatrixValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealMatrix *value);
00297 
00304         AIAPI AIErr (*SetRealMatrixValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealMatrix value);
00305 
00306 } AIWorkspaceSuite;
00307 
00308 
00309 
00310 #include "AIHeaderEnd.h"
00311 
00312 
00313 #endif // __AIWorkspace__