AIDictionary.h Go to the documentation of this file. #ifndef __AIDict__ #define __AIDict__ /* * Name: AIDictionary.h * $Id $ * Author: * Date: * Purpose: Adobe Illustrator Dictionary Object Suite. * * ADOBE SYSTEMS INCORPORATED * Copyright 1999-2007 Adobe Systems Incorporated. * All rights reserved. * * NOTICE: Adobe permits you to use, modify, and distribute this file * in accordance with the terms of the Adobe license agreement * accompanying it. If you have received this file from a source other * than Adobe, then your use, modification, or distribution of it * requires the prior written permission of Adobe. * */ /******************************************************************************* ** ** Imports ** **/ #ifndef __AIEntry__ #include "AIEntry.h" #endif #include "IAIFilePath.hpp" #include "AIHeaderBegin.h" /******************************************************************************* ** ** Constants ** **/ #define kAIDictionarySuite "AI Dictionary Suite" #define kAIDictionarySuiteVersion10 AIAPI_VERSION(10) #define kAIDictionarySuiteVersion kAIDictionarySuiteVersion10 #define kAIDictionaryVersion kAIDictionarySuiteVersion #define kAIDictionaryIteratorSuite "AI Dictionary Iterator Suite" #define kAIDictionaryIteratorSuiteVersion5 AIAPI_VERSION(5) #define kAIDictionaryIteratorSuiteVersion kAIDictionaryIteratorSuiteVersion5 #define kAIDictionaryIteratorVersion kAIDictionaryIteratorSuiteVersion #define kNoSuchKey 'NOKY' /******************************************************************************* ** ** Types ** **/ typedef const struct _t_AIDictKey *AIDictKey; typedef struct _AIDictionaryIterator* AIDictionaryIterator; typedef struct _AIDictionaryKeyChangedNotifyData { ai::int32 refStamp; AIDictionaryRef dictionary; AIDictKey key; } AIDictionaryKeyChangedNotifyData; /******************************************************************************* ** ** Suite ** **/ struct AIDictionarySuite { AIAPI AIErr (*CreateDictionary) ( AIDictionaryRef* dictionary ); AIAPI AIErr (*CreateDictionaryFromJSONFile) ( AIDictionaryRef* dictionary, const ai::FilePath &file ); AIAPI ai::int32 (*AddRef) ( AIDictionaryRef dictionary ); AIAPI ai::int32 (*Release) ( AIDictionaryRef dictionary ); AIAPI AIErr (*Clone) ( ConstAIDictionaryRef src, AIDictionaryRef* dst ); AIAPI AIErr (*Copy) ( AIDictionaryRef dict, ConstAIDictionaryRef src ); AIAPI ai::uint32 (*Size) ( ConstAIDictionaryRef dict ); AIAPI AIErr (*Begin) ( ConstAIDictionaryRef dict, AIDictionaryIterator* iterator ); AIAPI AIDictKey (*Key) ( const char* keyString ); AIAPI const char* (*GetKeyString) ( AIDictKey key ); AIAPI AIBoolean (*IsKnown) ( ConstAIDictionaryRef dictionary, AIDictKey key ); AIAPI AIErr (*DeleteEntry) ( AIDictionaryRef dictionary, AIDictKey key ); AIAPI AIErr (*GetEntryType) ( ConstAIDictionaryRef dictionary, AIDictKey key, AIEntryType* entryType ); AIAPI AIErr (*CopyEntry) ( ConstAIDictionaryRef dictionary1, AIDictionaryRef dictionary2, AIDictKey key1, AIDictKey key2 ); AIAPI AIErr (*MoveEntry) ( AIDictionaryRef dictionary1, AIDictionaryRef dictionary2, AIDictKey key1, AIDictKey key2 ); AIAPI AIErr (*SwapEntries) ( AIDictionaryRef dictionary1, AIDictionaryRef dictionary2, AIDictKey key1, AIDictKey key2 ); AIAPI AIErr (*GetArtEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, AIArtHandle* art ); AIAPI AIErr (*NewArtEntry) ( AIDictionaryRef dictionary, AIDictKey key, ai::int16 type ); AIAPI AIErr (*MoveArtToEntry) ( AIDictionaryRef dictionary, AIDictKey key, AIArtHandle art ); AIAPI AIErr (*MoveEntryToArt) ( AIDictionaryRef dictionary, AIDictKey key, ai::int16 paintOrder, AIArtHandle prep, AIArtHandle* art ); AIAPI AIErr (*CopyArtToEntry) ( AIDictionaryRef dictionary, AIDictKey key, AIArtHandle art ); AIAPI AIErr (*CopyEntryToArt) ( ConstAIDictionaryRef dictionary, AIDictKey key, ai::int16 paintOrder, AIArtHandle prep, AIArtHandle* art ); AIAPI AIErr (*SetEntryToLayer) ( AIDictionaryRef dictionary, AIDictKey key, AILayerHandle layer ); AIAPI AIErr (*SetLayerToEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, ai::int16 paintOrder, AILayerHandle prep, AILayerHandle *layer ); AIAPI AIEntryRef (*Get) ( ConstAIDictionaryRef dictionary, AIDictKey key ); AIAPI AIErr (*Set) ( AIDictionaryRef dictionary, AIDictKey key, AIEntryRef entry ); // the following are convenience APIs for getting and setting entries of the basic types AIAPI AIErr (*GetBooleanEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, AIBoolean* value ); AIAPI AIErr (*SetBooleanEntry) ( AIDictionaryRef dictionary, AIDictKey key, AIBoolean value ); AIAPI AIErr (*GetIntegerEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, ai::int32* value ); AIAPI AIErr (*SetIntegerEntry) ( AIDictionaryRef dictionary, AIDictKey key, ai::int32 value ); AIAPI AIErr (*GetPointerEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, ai::intptr* value ); AIAPI AIErr (*SetPointerEntry) ( AIDictionaryRef dictionary, AIDictKey key, ai::intptr value ); AIAPI AIErr (*GetRealEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, AIReal* value ); AIAPI AIErr (*SetRealEntry) ( AIDictionaryRef dictionary, AIDictKey key, AIReal value ); AIAPI AIErr (*GetStringEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, const char** value ); AIAPI AIErr (*SetStringEntry) ( AIDictionaryRef dictionary, AIDictKey key, const char* value ); AIAPI AIErr (*GetBinaryEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, void* value, size_t* size ); AIAPI AIErr (*SetBinaryEntry) ( AIDictionaryRef dictionary, AIDictKey key, void* value, size_t size ); AIAPI AIErr (*GetDictEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, AIDictionaryRef* value ); AIAPI AIErr (*SetDictEntry) ( AIDictionaryRef dictionary, AIDictKey key, AIDictionaryRef value ); AIAPI AIErr (*GetArrayEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, AIArrayRef* value ); AIAPI AIErr (*SetArrayEntry) ( AIDictionaryRef dictionary, AIDictKey key, AIArrayRef value ); AIAPI AIErr (*GetUnicodeStringEntry) ( ConstAIDictionaryRef dictionary, AIDictKey key, ai::UnicodeString& value ); AIAPI AIErr (*SetUnicodeStringEntry) ( AIDictionaryRef dictionary, AIDictKey key, const ai::UnicodeString& value ); AIAPI AIErr (*TouchArt) ( ConstAIDictionaryRef dictionary ); AIAPI AIErr(*Find) (ConstAIDictionaryRef dict, AIDictKey key, AIDictionaryIterator* iterator); }; struct AIDictionaryIteratorSuite { AIAPI ai::int32 (*AddRef) ( AIDictionaryIterator iterator ); AIAPI ai::int32 (*Release) ( AIDictionaryIterator iterator ); AIAPI AIBoolean (*IsValid) ( AIDictionaryIterator iterator ); AIAPI AIErr (*Copy) ( AIDictionaryIterator iterator, AIDictionaryIterator from ); AIAPI AIErr (*Clone) ( AIDictionaryIterator iterator, AIDictionaryIterator* clone ); AIAPI AIBoolean (*IsEqual) ( AIDictionaryIterator iterator1, AIDictionaryIterator iterator2 ); AIAPI AIBoolean (*AtEnd) ( AIDictionaryIterator iterator ); AIAPI void (*Next) ( AIDictionaryIterator iterator ); AIAPI void (*Prev) ( AIDictionaryIterator iterator ); AIAPI AIDictKey (*GetKey) ( AIDictionaryIterator iterator ); AIAPI AIEntryRef(*GetEntry) (AIDictionaryIterator iterator); }; #include "AIHeaderEnd.h" #endif

Copyright © 2014 Adobe Systems Incorporated. All rights reserved. Terms of Use Online Privacy Policy Adobe and accessibility Avoid software piracy Permissions and Trademarks