API: AIATEPaint.h Source File

00001 /*
00002  *        Name: AIATEPaint.h
00003  *   $Revision:
00004  *      Author:
00005  *        Date:
00006  *     Purpose: Facilitates access of paint attributes applied to text.
00007  *                              This suite serves as a bridge between ATE::ApplicationPaint
00008  *                              and AIColor
00009  *
00010  *
00011  * ADOBE SYSTEMS INCORPORATED
00012  * Copyright 2002-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 #ifndef __AIATEPAINT__
00024 #define __AIATEPAINT__
00025 
00026 /*******************************************************************************
00027  **
00028  **     Imports
00029  **
00030  **/
00031 
00032 #include "AITypes.h"
00033 
00034 #include "AIColor.h"
00035 #include "AIEntry.h"
00036 #include "AIPathStyle.h"
00037 
00038 #include "ATESuites.h"
00039 
00040 
00041 #include "AIHeaderBegin.h"
00042 
00046 /*******************************************************************************
00047  **
00048  **     Constants
00049  **
00050  **/
00051 
00052 #define kAIATEPaintSuite                        "AIATE Paint Suite"
00053 #define kAIATEPaintSuiteVersion3        AIAPI_VERSION(3)
00054 #define kAIATEPaintSuiteVersion         kAIATEPaintSuiteVersion3
00055 #define kAIATEPaintVersion                      kAIATEPaintSuiteVersion
00056 
00057 /*******************************************************************************
00058  **
00059  **     Suite
00060  **
00061  **/
00062 
00139 typedef struct {
00140 
00141         // ATE paint types -> Illustrator paint types
00142         // -------------------------------------------------------------------------
00143 
00148         AIAPI AIErr ( *GetAIColor ) ( ATE::ApplicationPaintRef src, AIColor* dst );
00149 
00154         AIAPI AIErr ( *GetAILineCap ) ( ATE::LineCapType src, AILineCap* dst );
00155 
00160         AIAPI AIErr ( *GetAILineJoin ) ( ATE::LineJoinType src, AILineJoin* dst );
00161 
00166         AIAPI AIErr ( *GetAIDashStyleArray ) ( ATE::ArrayRealRef srcArray, AIDashStyle* dstStyle );
00167 
00168         // Illustrator paint types -> ATE paint types
00169         // -------------------------------------------------------------------------
00170 
00188         AIAPI AIErr ( *CreateATEApplicationPaint ) ( const AIColor* src, ATE::ApplicationPaintRef* dst );
00189 
00194         AIAPI AIErr ( *GetATELineCap ) ( AILineCap src, ATE::LineCapType* dst );
00195 
00201         AIAPI AIErr ( *GetATELineJoin ) ( AILineJoin src, ATE::LineJoinType* dst );
00202 
00208         AIAPI AIErr ( *CreateATELineDashArray ) ( const AIDashStyle* srcStyle, ATE::ArrayRealRef* dst );
00209 
00210         // Convenience Methods
00211         // -------------------------------------------------------------------------
00212 
00219         AIAPI AIErr ( *GetAIPathStyleAndMap ) ( ATE::CharFeaturesRef src, AIPathStyle* pDstPathStyle, AIPathStyleMap* pDstPathStyleMap );
00220 
00227         AIAPI AIErr ( *GetCharFeatures ) ( const AIPathStyle* pSrcPathStyle, const AIPathStyleMap* pSrcPathStyleMap, ATE::CharFeaturesRef dst );
00228 
00229         // Transparency Methods
00230         // -------------------------------------------------------------------------
00231 
00239         AIAPI AIErr ( *GetTransparencyAttrs ) ( ATE::CharFeaturesRef pSrc, AIDictionaryRef pDst );
00240 
00249         AIAPI AIErr ( *SetTransparencyAttrs ) ( AIDictionaryRef pSrc, ATE::CharFeaturesRef pDst );
00250 
00251 } AIATEPaintSuite;
00252 
00253 #include "AIHeaderEnd.h"
00254 
00255 #endif // __AIATEPAINT__