API: AIATETextUtil.h Source File

00001 #ifndef __ATETextUtil__
00002 #define __ATETextUtil__
00003 
00004 /*
00005  *        Name: AIATETextUtil.h
00006  *   $Revision: 1 $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator Text Frame Object Suite.
00010  *
00011  *                              REQUIREMENT: This won't compile without a C++ compiler!
00012  *
00013  * ADOBE SYSTEMS INCORPORATED
00014  * Copyright 1986-2007 Adobe Systems Incorporated.
00015  * All rights reserved.
00016  *
00017  * NOTICE:  Adobe permits you to use, modify, and distribute this file 
00018  * in accordance with the terms of the Adobe license agreement 
00019  * accompanying it. If you have received this file from a source other 
00020  * than Adobe, then your use, modification, or distribution of it 
00021  * requires the prior written permission of Adobe.
00022  *
00023  */
00024 
00025 
00026 /*******************************************************************************
00027  **
00028  **     Imports
00029  **
00030  **/
00031 
00032 #ifndef __AITypes__
00033 #include "AITypes.h"
00034 #endif
00035 
00036 #ifndef __AIArt__
00037 #include "AIArt.h"
00038 #endif
00039 
00040 #ifndef __ATESuites__
00041 #include "ATESuites.h"
00042 #endif
00043 
00044 #ifndef __AIDocument__
00045 #include "AIDocument.h"
00046 #endif
00047 
00048 #ifndef __AIFont__
00049 #include "AIFont.h"
00050 #endif
00051 
00052 #ifndef __SPFiles__
00053 #include "SPFiles.h"
00054 #endif
00055 
00056 
00057 #include "AIHeaderBegin.h"
00058 
00062 /*******************************************************************************
00063  **
00064  **     Constants
00065  **
00066  **/
00067 
00068 #define kAIATETextUtilSuite                     "AI ATE Text Util Suite"
00069 #define kAIATETextUtilSuiteVersion4     AIAPI_VERSION(4)
00070 #define kAIATETextUtilSuiteVersion      kAIATETextUtilSuiteVersion4
00071 #define kAIATETextUtilVersion           kAIATETextUtilSuiteVersion
00072 
00073 
00076 #define kAICurrentFontChangedNotifier   "AI Current Font Changed Notifier"
00077 
00079 #define kAICurrentFontSizeChangedNotifier       "AI Current Font Size Changed Notifier"
00080 
00082 #define kAIFontListChangedNotifier              "AI Font List Changed Notifier"
00083 
00085 #define kATEDocumentResourceChangedNotifier     "AI ATE Document Resource Changed Notifier"
00086 
00087 
00092 #define kAIATEInvalidBounds 'INVB'
00093 
00094 /*******************************************************************************
00095  **
00096  **     Suite
00097  **
00098  **/
00099 
00106 struct AIATETextUtilSuite {
00112         AIAPI AIErr (*GetBoundsFromTextRange)( ATE::TextRangeRef tr, AIRealRect* bounds );
00113 
00120         AIAPI AIErr (*GetApplicationTextResources)( ATE::ApplicationTextResourcesRef *result );
00121 
00128         AIAPI AIErr (*GetTextResourcesFromDocument)( AIDocumentHandle pDocument, ATE::TextResourcesRef* pResources );
00129 
00137         AIAPI AIErr (*GetCompositeFont)( const ai::FilePath&, ATE::CompFontRef * compFont );
00138 
00144         AIAPI AIErr (*WriteCompositeFont)( const ai::FilePath&, const ATE::CompFontRef compFontRef);
00145 
00153         AIAPI AIErr (*GetKinsokuFile)( const ai::FilePath&, ATE::KinsokuRef *kinsokuRef );
00154 
00160         AIAPI AIErr (*WriteKinsokuFile)( const ai::FilePath&, const ATE::KinsokuRef kinsokuRef );
00161 
00169         AIAPI AIErr (*GetMojiKumiFile) ( const ai::FilePath&, ATE::MojiKumiRef *mojikumeRef );
00170 
00176         AIAPI AIErr (*WriteMojiKumiFile)( const ai::FilePath&, const ATE::MojiKumiRef mojikumeRef);
00177 
00180         AIAPI AIErr (*UpdateParagraphPaletteKinsoku) (ai::int32 index);
00181 
00184         AIAPI AIErr (*UpdateParagraphPaletteMojiKumi)(ai::int32 index);
00185 
00190         AIAPI AIErr (*GetSpellFile)( const ai::FilePath& pSrcFileSpec, ATE::SpellRef* pDst );
00191 
00195         AIAPI AIErr (*SetCurrentFont)(AIFontKey theFont);
00196 
00201         AIAPI AIErr (*GetCurrentFont)(AIFontKey *result);
00202 
00206         AIAPI AIErr (*SetCurrentFontSize)(AIReal theFontSize);
00207 
00212         AIAPI AIErr (*GetCurrentFontSize)(AIReal *result);
00213 
00214 
00215         // These should be in ATE::IGlyphRun.
00224         AIAPI AIErr (*GetUnderlinePoints)(const ATE::GlyphRunRef gr , ATE::ArrayRealPointRef* pPoints);
00225 
00234         AIAPI AIErr (*GetStrikethroughPoints)(const ATE::GlyphRunRef gr , ATE::ArrayRealPointRef* pPoints);
00235 };
00236 
00237 
00238 #include "AIHeaderEnd.h"
00239 
00240 
00241 #endif