API: AIXMLNameUtil.h Source File

00001 #ifndef __AIXMLNameUtil__
00002 #define __AIXMLNameUtil__
00003 
00004 /*
00005  *        Name: AIXMLNameUtil.h
00006  *              $Id $
00007  *      Author:
00008  *        Date:
00009  *     Purpose: Adobe Illustrator XML Name Utilities Suite.
00010  *
00011  * ADOBE SYSTEMS INCORPORATED
00012  * Copyright 2001-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 
00035 #include "AIHeaderBegin.h"
00036 
00040 /*******************************************************************************
00041  **
00042  **     Constants
00043  **
00044  **/
00045 
00046 #define kAIXMLNameUtilSuite                                             "AI XML Name Utilities Suite"
00047 #define kAIXMLNameUtilSuiteVersion4                             AIAPI_VERSION(4)
00048 #define kAIXMLNameUtilSuiteVersion                              kAIXMLNameUtilSuiteVersion4
00049 #define kAIXMLNameUtilVersion                                   kAIXMLNameUtilSuiteVersion
00050 
00051 
00052 /*******************************************************************************
00053  **
00054  **     Suite
00055  **
00056  **/
00057 
00058 
00072 typedef struct AIXMLNameUtilSuite {
00073 
00081         AIAPI AIErr (*NameFromBaseAndNumber) (const ai::UnicodeString& base, ai::UnicodeString& buffer, ai::int32 number, ai::int32 maxlength);
00082 
00088         AIAPI AIErr (*BaseFromName) (const ai::UnicodeString& name, ai::UnicodeString& buffer);
00089 
00095         AIAPI AIBoolean (*IsValidName) (const ai::UnicodeString& name);
00096 
00105         AIAPI AIErr (*XMLNameFromString) (const ai::UnicodeString& str, ai::UnicodeString& buffer);
00106 
00112         AIAPI AIErr (*StringFromXMLName) (const ai::UnicodeString& name, ai::UnicodeString& buffer);
00113 
00114 } AIXMLNameUtilSuite;
00115 
00116 
00117 #include "AIHeaderEnd.h"
00118 
00119 
00120 #endif