API: AIDynamicSymbol.h Source File

00001 /*************************************************************************
00002 ADOBE SYSTEMS INCORPORATED
00003 Copyright 2015 Adobe Systems Incorporated
00004 All Rights Reserved.
00005 
00006 NOTICE:  Adobe permits you to use, modify, and distribute this file in accordance with the
00007 terms of the Adobe license agreement accompanying it.  If you have received this file from a
00008 source other than Adobe, then your use, modification, or distribution of it requires the prior
00009 written permission of Adobe.
00010 **************************************************************************/
00011 
00012 #ifndef _AI_DYNAMIC_SYMBOL_H_
00013 #define _AI_DYNAMIC_SYMBOL_H_
00014 
00015 #ifndef __ASTypes__
00016 #include "ASTypes.h"
00017 #endif
00018 
00019 #ifndef __AIPlugin__
00020 #include "AIPlugin.h"
00021 #endif
00022 
00023 #include "AIHeaderBegin.h"
00024 
00025 #define kAIDynamicSymbolSuite                                   "AI Dynamic Symbol Suite"
00026 #define kAIDynamicSymbolSuiteVersion                    AIAPI_VERSION(1)
00027 
00034 enum AISymbolType
00035 {
00037         kAISymbolStaticType = 0x01,
00039         kAISymbolDynamicType = 0x02
00040 };
00041 
00042 /*******************************************************************************
00043 **
00044 **      AIDynamicSymbol Suite
00045 **
00046 **/
00047 struct AIDynamicSymbolSuite
00048 {
00054         AIAPI AIErr(*GetSymbolOverriddenArt) (AIArtHandle inSymbolArt, AIArtHandle *outArt);
00055 
00060         AIAPI AIErr(*GetSymbolArtHasOverride)(AIArtHandle inSymbolArt, AIBoolean &outHasOverride);
00061 
00062         /*
00063         Retrieves the type of a symbol, static or dynamic. Only dynamic symbols can have an overridden appearance.
00064         @param symbolPattern [in] The symbol pattern reference.
00065         @param outSymbolType [out] A buffer in which to return the symbol type.
00066         */
00067         AIAPI AIErr(*GetSymbolType) (const AIPatternHandle inSymbolArt, AISymbolType& outSymbolType);
00068 
00069 };
00070 
00071 #include "AIHeaderEnd.h"
00072 
00073 #endif // _AI_DYNAMIC_SYMBOL_H_
00074