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 kAIWorkspaceRestoreFinishNotifier   "AI Workspace Restore Finish Notifier"
00059 
00062 #define kAIWorkspaceCaller                                      "Workspace Manager"
00063 
00078 #define kAIWSWriteSelector                                      "Write Workspace"
00079 
00093 #define kAIWSRestoreSelector                            "Restore Workspace"
00094 
00101 #define kAIWSDefaultSelector                            "Default Workspace"
00102 
00106 #define kWorkspaceNameTooLongErr                        'WSNL'
00107 
00109 enum AIWorkspaceDefaultValue {
00110         kAIWSDefaultPreset = 1,
00111         kAIWSAICSPreset
00112 };
00113 
00114 /*******************************************************************************
00115  **
00116  **     Types
00117  **
00118  **/
00120 typedef struct _AIWorkspace*                    AIWorkspaceHandle;
00121 
00123 typedef struct {
00125         SPMessageData d;
00127         AIWorkspaceHandle workspace;
00130         const char *dialogName;
00134         AIBoolean restore;
00136         AIWorkspaceDefaultValue flag;
00137 } AIWorkspaceMessage;
00138 
00139 /*******************************************************************************
00140  **
00141  **     Suites
00142  **
00143  **/
00144 
00164 typedef struct {
00165 
00172         AIAPI AIErr (*GetIntegerValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, int *value);
00173 
00180         AIAPI AIErr (*SetIntegerValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, ai::int32 value);
00181 
00188         AIAPI AIErr (*GetRealValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIReal *value);
00189 
00196         AIAPI AIErr (*SetRealValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIReal value);
00197 
00204         AIAPI AIErr (*GetBooleanValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIBoolean *value);
00205 
00212         AIAPI AIErr (*SetBooleanValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIBoolean value);
00213 
00220         AIAPI AIErr (*GetStringValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, char *value, ai::int32 length);
00221 
00228         AIAPI AIErr (*SetStringValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, const char *value);
00229 
00236         AIAPI AIErr (*GetPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIPoint *value);
00237 
00244         AIAPI AIErr (*SetPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIPoint value);
00245 
00252         AIAPI AIErr (*GetRealPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealPoint *value);
00253 
00260         AIAPI AIErr (*SetRealPointValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealPoint value);
00261 
00268         AIAPI AIErr (*GetRectValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRect *value);
00269 
00276         AIAPI AIErr (*SetRectValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRect value);
00277 
00284         AIAPI AIErr (*GetRealRectValue)(AIWorkspaceHandle collectioRef, const char *prefix, const char *suffix, AIRealRect *value);
00285 
00292         AIAPI AIErr (*SetRealRectValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealRect value);
00293 
00300         AIAPI AIErr (*GetRealMatrixValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealMatrix *value);
00301 
00308         AIAPI AIErr (*SetRealMatrixValue)(AIWorkspaceHandle workspace, const char *prefix, const char *suffix, AIRealMatrix value);
00309 
00310 } AIWorkspaceSuite;
00311 
00312 
00313 
00314 #include "AIHeaderEnd.h"
00315 
00316 
00317 #endif // __AIWorkspace__