API: AIPreference.h Source File

00001 #ifndef __AIPreference__
00002 #define __AIPreference__
00003 
00004 /*
00005  *        Name: AIPreference.h
00006  *   $Revision: 6 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Preference 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 #ifndef __AITypes__
00031 #include "AITypes.h"
00032 #endif
00033 
00034 #ifndef __AIFixedMath__
00035 #include "AIFixedMath.h"
00036 #endif
00037 
00038 #ifndef __SPPlugins__
00039 #include "SPPlugs.h"
00040 #endif
00041 
00042 #ifndef __AIMenu__
00043 #include "AIMenu.h"
00044 #endif
00045 
00046 #include "IAIUnicodeString.h"
00047 #include "IAIFilePath.hpp"
00048 
00049 #include "AIHeaderBegin.h"
00050 
00053 /*******************************************************************************
00054  **
00055  **     Constants
00056  **
00057  **/
00058 
00059 #define kAIPreferenceSuite              "AI Preference Suite"
00060 #define kAIPreferenceSuiteVersion6      AIAPI_VERSION(6)
00061 #define kAIPreferenceSuiteVersion       kAIPreferenceSuiteVersion6
00062 #define kAIPreferenceVersion            kAIPreferenceSuiteVersion
00063 
00067 #define kAIPreferenceChangedNotifier    "AI Preference Changed Notifier"
00068 
00069 
00072 #define kAIPreferenceCaller                             "AI Preference"
00073 
00075 #define kAIPreferenceInitSelector               "Init Preference Panel"
00076 
00078 #define kAIPreferenceOKSelector                 "Preference Dialog OK"
00079 
00081 #define kAIPreferenceCancelSelector             "Preference Dialog Cancel"
00082 
00084 #define kAIPreferenceUpdateSelector             "Preference Dialog Upadate"
00085 
00093 #define kAIPreferenceTurnOffWarningPrefix       "DontShowWarningAgain"
00094 
00095 /*******************************************************************************
00096  **
00097  **     Types
00098  **
00099  **/
00100 
00103 typedef struct _t_AIPreferenceItemGroupOpaque   *AIPreferenceItemGroupHandle;
00104 
00106 typedef ai::uint32 AIPreferenceDateTime;
00107 
00109 struct AIPreferencePanelMessage {
00111         SPMessageData d;
00113         AIPreferenceItemGroupHandle itemGroup;
00114 };
00115 
00116 /*******************************************************************************
00117  **
00118  **     Suite
00119  **
00120  **/
00121 
00215 typedef struct AIPreferenceSuite {
00216 
00222         AIAPI AIErr (*GetBooleanPreference) ( const char *prefix, const char *suffix, AIBoolean *value );
00223 
00229         AIAPI AIErr (*PutBooleanPreference) ( const char *prefix, const char *suffix, AIBoolean value );
00230 
00236         AIAPI AIErr (*GetIntegerPreference) ( const char *prefix, const char *suffix, ai::int32 *value );
00237 
00243         AIAPI AIErr (*PutIntegerPreference) ( const char *prefix, const char *suffix, ai::int32 value );
00244 
00250         AIAPI AIErr (*GetRealPreference) ( const char *prefix, const char *suffix, double *value );
00251 
00257         AIAPI AIErr (*PutRealPreference) ( const char *prefix, const char *suffix, double value );
00258 
00264         AIAPI AIErr (*GetStringPreference) ( const char *prefix, const char *suffix, char *value );
00265 
00271         AIAPI AIErr (*PutStringPreference) ( const char *prefix, const char *suffix, const char *value );
00272 
00278         AIAPI AIErr (*GetUnicodeStringPreference) ( const char *prefix, const char *suffix, ai::UnicodeString& value );
00279 
00285         AIAPI AIErr (*PutUnicodeStringPreference) ( const char *prefix, const char *suffix, const ai::UnicodeString& value );
00286 
00293         AIAPI AIErr (*GetBlockPreference) ( const char *prefix, const char *suffix, void *address, ai::int32 size );
00294 
00308         AIAPI AIErr (*PutBlockPreference) ( const char *prefix, const char *suffix, void *address, ai::int32 size );
00309 
00315         AIAPI AIErr (*GetFixedPreference) ( const char *prefix, const char *suffix, AIFixed *value );
00316 
00317 
00323         AIAPI AIErr (*PutFixedPreference) ( const char *prefix, const char *suffix, AIFixed value );
00324 
00330         AIAPI AIErr (*GetFractPreference) ( const char *prefix, const char *suffix, AIFract *value );
00331 
00337         AIAPI AIErr (*PutFractPreference) ( const char *prefix, const char *suffix, AIFract value );
00338 
00344         AIAPI AIErr (*GetPascalPreference) ( const char *prefix, const char *suffix, unsigned char *value );
00345 
00351         AIAPI AIErr (*PutPascalPreference) ( const char *prefix, const char *suffix, const unsigned char *value );
00352 
00358         AIAPI AIErr (*GetDateTimePreference) ( const char *prefix, const char *suffix, AIPreferenceDateTime *value );
00359 
00365         AIAPI AIErr (*PutDateTimePreference) ( const char *prefix, const char *suffix, AIPreferenceDateTime *value );
00366 
00372         AIAPI AIErr (*GetPointPreference) ( const char *prefix, const char *suffix, AIPoint *value );
00373 
00379         AIAPI AIErr (*PutPointPreference) ( const char *prefix, const char *suffix, AIPoint *value );
00380 
00386         AIAPI AIErr (*GetRectPreference) ( const char *prefix, const char *suffix, AIRect *value );
00387 
00393         AIAPI AIErr (*PutRectPreference) ( const char *prefix, const char *suffix, AIRect *value );
00394 
00400         AIAPI AIErr (*GetFilePathSpecificationPreference) ( const char *prefix, const char *suffix, ai::FilePath &value );
00401 
00407         AIAPI AIErr (*PutFilePathSpecificationPreference) ( const char *prefix, const char *suffix, const ai::FilePath &value );
00408 
00414         AIAPI AIErr (*RemovePreference) ( const char *prefix, const char *suffix );
00415 
00433         AIAPI AIErr (*AddPreferencePanel) (SPPluginRef pluginRef, unsigned char *itemText, ai::int32 dialogID, ai::int32 options,
00434                         AIPreferenceItemGroupHandle *prefItemGroup, AIMenuItemHandle *menuItem);
00435 
00444         AIAPI AIErr (*GetPreferencePanelBaseItemIndex) (AIPreferenceItemGroupHandle prefItemGroup, ai::int32 *baseIndex);
00445 
00451         AIAPI AIErr (*ShowPreferencePanel) (AIPreferenceItemGroupHandle prefItemGroup);
00452 
00458         AIAPI AIErr (*GetLargeIntegerPreference) ( const char *prefix, const char *suffix, ai::int64 *value );
00459 
00465         AIAPI AIErr (*PutLargeIntegerPreference) ( const char *prefix, const char *suffix, ai::int64 value );
00466     
00467 } AIPreferenceSuite;
00468 
00469 
00470 #include "AIHeaderEnd.h"
00471 
00472 
00473 #endif