API: AICustomColor.h Source File

00001 #ifndef __AICustomColor__
00002 #define __AICustomColor__
00003 
00004 /*
00005  *        Name: AICustomColor.h
00006  *   $Revision: 10 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Custom Color Fill 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 __AIColor__
00035 #include "AIColor.h"
00036 #endif
00037 
00038 #ifndef __AIColorConversion__
00039 #include "AIColorConversion.h"
00040 #endif
00041 
00042 #include "IAIUnicodeString.h"
00043 
00044 
00045 #include "AIHeaderBegin.h"
00046 
00049 /*******************************************************************************
00050  **
00051  **     Constants
00052  **
00053  **/
00054 
00055 #define kAICustomColorSuite                                     "AI Custom Color Suite"
00056 #define kAICustomColorSuiteVersion                      AIAPI_VERSION(8)
00057 #define kAICustomColorVersion                           kAICustomColorSuiteVersion
00058 
00063 #define kAIArtCustomColorChangedNotifier        "AI Art Custom Color Changed Notifier"
00064 
00065 
00066 /*******************************************************************************
00067  **
00068  **     Suite
00069  **
00070  **/
00071 
00079 typedef struct {
00080 
00088         AIAPI AIErr (*NewCustomColor) ( AICustomColor *color, const ai::UnicodeString& name, AICustomColorHandle *customColor );
00089 
00094         AIAPI AIErr (*DeleteCustomColor) ( AICustomColorHandle customColor );
00095 
00101         AIAPI AIErr (*GetCustomColor) ( AICustomColorHandle customColor, AICustomColor *color );
00107         AIAPI AIErr (*SetCustomColor) ( AICustomColorHandle customColor, AICustomColor *color );
00108 
00113         AIAPI AIErr (*GetCustomColorName) ( AICustomColorHandle customColor, ai::UnicodeString& name );
00114 
00121         AIAPI AIErr (*SetCustomColorName) ( AICustomColorHandle customColor, const ai::UnicodeString& name );
00122 
00127         AIAPI AIErr (*CountCustomColors) ( ai::int32 *count );
00128 
00134         AIAPI AIErr (*GetNthCustomColor) ( ai::int32 n, AICustomColorHandle *customColor );
00135 
00140         AIAPI AIErr (*GetCustomColorByName) ( const ai::UnicodeString& name,  AICustomColorHandle *customColor );
00141 
00150         AIAPI AIErr (*NewCustomColorName) ( ai::UnicodeString& name );
00151 
00154         AIAPI AIErr (*GetCustomColorDisplayName) ( ai::UnicodeString& name );
00155 
00159         AIAPI AIErr (*GetCurrentRegistrationColor) ( AICustomColorHandle *customColor );
00160 
00167         AIAPI AIErr (*NewRegistrationColor)(AICustomColorHandle *customColor, AIReal cyan /*red*/,
00168                 AIReal magenta /*green*/,AIReal yellow/*blue*/, AIReal black, AICustomColorTag kind);
00169 
00176         AIAPI AIBoolean (*ValidateCustomColor)(AICustomColorHandle customColor);
00183         AIAPI AIBoolean (*HasExternalUses)(AICustomColorHandle customColor);
00184 
00203         AIAPI AIErr (*ConvertToNonGlobal)(AICustomColorHandle customColor, AIReal tint, AIColor* color);
00204 
00220         AIAPI AIErr (*GetAppearanceApproximation)(AICustomColorHandle customColor, AIReal tint,
00221                         ai::int32* space, AIFloatSampleComponent* values);
00222 
00228         AIAPI AIErr (*SetCustomColorBookID)(AICustomColorHandle customColor, ai::int32 bookid);
00229 
00230 
00235         AIAPI ai::int32 (*GetCustomColorBookID)(AICustomColorHandle customColor);
00236 
00237 
00238 } AICustomColorSuite;
00239 
00240 
00241 #include "AIHeaderEnd.h"
00242 
00243 
00244 #endif