AIFileFormat.h Go to the documentation of this file. /************************************************************************* * * ADOBE CONFIDENTIAL * * Copyright 1986 Adobe * * 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. * **************************************************************************/ #ifndef __AIFileFormat__ #define __AIFileFormat__ /******************************************************************************* ** ** Imports ** **/ #ifndef __AITypes__ #include "AITypes.h" #endif #ifndef __AIPlugin__ #include "AIPlugin.h" #endif #ifndef __AIArt__ #include "AIArt.h" #endif #ifndef __AIPlaced__ #include "AIPlaced.h" #endif #include "AIEntry.h" #include "IAIFilePath.hpp" #include "AIArtboardRange.h" #include "AIActionManager.h" #include "AIHeaderBegin.h" /******************************************************************************* ** ** Constants ** **/ #define kAIFileFormatSuite "AI File Format Suite" #define kAIFileFormatSuiteVersion15 AIAPI_VERSION(15) // From AI 23.1 #define kAIFileFormatSuiteVersion kAIFileFormatSuiteVersion15 #define kAIFileFormatVersion kAIFileFormatSuiteVersion #define kAIMacFileFormatSuite "AI Mac File Format Suite" #define kAIMacFileFormatSuiteVersion AIAPI_VERSION(5) #define kAIMacFileFormatVersion kAIMacFileFormatSuiteVersion #define kCallerAIFileFormat "AI File Format" #define kSelectorAIGetFileFormatParameters "AI Get Parameters" #define kSelectorAISetFileFormatParameters "AI Set Parameters" #define kSelectorAIGoFileFormat "AI Go" #define kSelectorAICheckFileFormat "AI Check" #define kSelectorAIUpdateFileFormat "AI Update AI140" #define kAIFileFormatDocumentOpenedNotifier "AI File Format Document Opened Notifier" #define kAIFileFormatLinkUpdateNotifier "AI File Format Link Update Notifier" enum AIFileFormatOptions { kFileFormatRead = (1 << 0), kFileFormatExport = (1 << 1), kFileFormatImportArt = (1 << 2), kFileFormatPlaceArt = (1 << 3), kFileFormatImportStyles = (1 << 4), kFileFormatSuppliesPrintRecordOption = (1 << 5), kFileFormatIsDefaultOption = (1 << 6), kFileFormatConvertTemplate = (1 << 7), kFileFormatLinkArt = (1 << 8), kFileFormatWrite = (1 << 9), kFileFormatNoAutoCheckFormat = (1 << 10), kFileFormatCreateTemplateLayer = (1 << 11), kFileFormatHasExtendedData = (1 << 12), kFileFormatSkipStartupObjectsOption = (1 << 13), kFileFormatNoWarningOption = (1 << 14), kFileFormatSaveCopyOption = (1 << 15), kFileFormatExportSelection = (1 << 16), kFileFormatBatchExport = (1 << 17), kFileFormatSuppressPluginFileNameUniquify = (1 << 18), kFileFormatOptimizeNetworkOperation = (1 << 19), /* Enables save of AI file in background if possible */ kFileFormatSaveInBackground = (1 << 20), kFileFormatSuppressUI = (1 << 21), kFileFormatWriteAs = (1 << 22), kFileFormatCheckAlways = (1 << 23), kFileFormatContainsPartialParameters = (1 << 24), kFileFormatImportCompositeFonts = (1 << 25), kFileFormatOpenUntitledCopy = (1 << 26), kFileFormatWriteSwatchLibrary = (1 << 27), kFileFormatWriteBrushLibrary = (1 << 28), kFileFormatWriteStyleLibrary = (1 << 29), kFileFormatWriteSymbolLibrary = (1 << 30), kFileFormatWriteInTouch = (1 << 31) }; #define kFileFormatWritePalettesOnly (kFileFormatWriteSwatchLibrary|kFileFormatWriteBrushLibrary|kFileFormatWriteStyleLibrary|kFileFormatWriteSymbolLibrary) #define kFileFormatExtensionStrMaxLength 31 #define kFileFormatExtMaxLength 5 #define kUnknownFormatErr 'FMT?' #define kInvalidFormatErr 'FMTi' #define kBadResolutionErr 'RES!' #define kOptimizedNetworkSaveFailedErr 'ONSF' enum AIFileFormatPriority { kAIFileFormatPriorityNative = 10000, kAIFileFormatPriorityNormal = 0, kAIFileFormatPriorityLowest = -10000 }; /******************************************************************************* ** ** Types ** **/ typedef struct _t_AIFileFormatOpaque *AIFileFormatHandle; typedef struct PlatformAddFileFormatData4 { ai::int32 type; unsigned char *title; ai::int32 titleOrder; } PlatformAddFileFormatData4; typedef struct PlatformAddFileFormatData { ai::int32 type; ai::UnicodeString title; ai::int32 titleOrder; ai::UnicodeString extension; } PlatformAddFileFormatData; typedef struct PlatformAddFileFormatExData { ai::int32 numTypes; ai::int32* typeList; ai::UnicodeString title; ai::int32 titleOrder; ai::UnicodeString extension; } PlatformAddFileFormatExData; typedef struct AICreatorTypePair { long creator; ai::int32 type; } AICreatorTypePair; // Extend File Format Message with // usage-specific data type. enum eFFExtType { /* No additional data required for this request */ kFFExtNone, /* This is a placement request, which requires additional data */ kFFExtPlaceRequest, /* This is a import/export request, where additional data is provided by the client to customize the request */ kFFExtAdditionalOptions }; // Extended options of plug-ins enum AIFFExtendedOptions{ /* No Extended options is supported*/ kNoExtendedOptions= (0), /* Save/Export of Multiple Artboards is supported */ kSaveMultiArtboards= (1<<0), kDoNotExitTextEditingModeOption = ( 1 << 1), kFileFormatPlaceInTouch = (1<<2), kDoNotHonourDocumentScaleOnPlace = (1<<3), /*This is a export request, primarily for a format which can be exported in a large Canvas document i.e, with document scale as 10x Large Canvas is supported*/ kFileFormatSupportsLargeCanvas = (1 << 4) }; enum eFFOperationOptions{ /* Save/Export Multiple Artboards selected by the user*/ kSaveMultiArtboardsSelected= (1<<0), }; union FileFormatExtUnion { AIDictionaryRef m_AdditionalOptionsDict; AIPlaceRequestData *m_pPlaceRequestData; }; typedef struct FileFormatExtData { ai::int32 m_lExtType; union FileFormatExtUnion m_unExt; FileFormatExtData() : m_lExtType(kFFExtNone) { m_unExt.m_AdditionalOptionsDict = NULL; } } FileFormatExtData; // File Format message structure. struct AIFileFormatMessage { SPMessageData d; AIFileFormatHandle fileFormat; public: ai::int32 option; FileFormatExtData *m_pExtData; void *actionParm; private: ai::FilePath filePath; public: void SetFilePath(const ai::FilePath &fp); const ai::FilePath &GetFilePath() const; public: ai::int32 operationOptions; AIArtboardRangeHandle rangeHandle; public: AIFileFormatMessage() : fileFormat(NULL), option(0), m_pExtData(NULL), actionParm(NULL), operationOptions(kNoExtendedOptions), rangeHandle(NULL) {} }; struct AIUpdateFileFormatMessage { struct AIFileFormatMessage ffm; AIArtHandle art; void* data; }; // The following enum and struct can be used to convey // information in conjunction with the Link Update // Artwork Notifier. enum eLinkUpdateType { kNormalUpdate, kLinkReplaced, kMissingLinkIgnored }; struct AILinkUpdateNotifyData { ai::int32 m_iUpdateType; void *m_pvParam; }; enum AIDocumentStartupProfile { kAIStartupProfileUnknown = 0, kAIStartupProfilePrint = 1, kAIStartupProfileWeb, kAIStartupProfileVideo, /* Unused. Not returned. Use \c kAIStartupProfilePrint instead. */ kAIStartupProfileCMYK, /* Unused. Not returned. Use \c kAIStartupProfileWeb instead. */ kAIStartupProfileRGB, kAIStartupProfileMobile }; /******************************************************************************* ** ** Suite ** **/ struct AIFileFormatSuite { AIAPI AIErr (*AddFileFormat) ( SPPluginRef self, const char* name, PlatformAddFileFormatData *data, ai::int32 options, AIFileFormatHandle *fileFormat , ai::int32 extendedOptions); AIAPI AIErr (*GetFileFormatName) ( AIFileFormatHandle fileFormat, const char **name ); AIAPI AIErr (*GetFileFormatOptions) ( AIFileFormatHandle fileFormat, ai::int32 *options ); AIAPI AIErr (*SetFileFormatOptions) ( AIFileFormatHandle fileFormat, ai::int32 options ); AIAPI AIErr (*GetFileFormatPlugin) ( AIFileFormatHandle fileFormat, SPPluginRef *plugin ); AIAPI AIErr (*CountFileFormats) ( ai::int32 *count ); AIAPI AIErr (*GetNthFileFormat) ( ai::int32 n, AIFileFormatHandle *fileFormat ); AIAPI AIErr (*GetFileFormatExtension) ( AIFileFormatHandle fileFormat, ai::UnicodeString& extension ); AIAPI AIErr (*AddFileFormatEx) ( SPPluginRef self, const char* name, PlatformAddFileFormatExData *dataEx, ai::int32 options, AIFileFormatHandle *fileFormat, ai::int32 extendedOptions ); AIAPI AIErr (*GetFileFormatTitle) ( AIFileFormatHandle fileFormat, ai::UnicodeString& szTitle ); AIAPI AIErr (*GetFileFormatType) ( AIFileFormatHandle fileFormat, ai::int32 *maxNumTypes, ai::int32 *typeList ); AIAPI AIErr (*SetFileFormatFilter) ( AIFileFormatHandle fileFormat, ai::int32 numPairs, AICreatorTypePair *pairList, const ai::UnicodeString& extensions ); AIAPI AIErr (*GetFileFormatCreatorType) ( AIFileFormatHandle fileFormat, ai::int32 *maxNumPairs, AICreatorTypePair *pairList ); AIAPI AIErr (*PutFile) (ai::int32 options, const unsigned char *dlgTitle, ai::FilePath &fileSpec, AIFileFormatHandle *fileFormat, AIBoolean *good ); AIAPI AIErr (*SetFileFormatPriority) ( AIFileFormatHandle fileFormat, ai::int32 priority ); AIAPI AIErr (*FindMatchingFileFormats) ( ai::int32 options, const ai::FilePath &file, ai::int32 maxMatches, AIFileFormatHandle matchingFormats[], ai::int32* numMatches ); AIAPI AIErr (*ResolveImportConflicts) (); AIAPI AIVersion (*GetFirstVersionUsingPlacedArt) (AIFileFormatHandle fileFormat); AIAPI AIErr (*SetFirstVersionUsingPlacedArt) (AIFileFormatHandle fileFormat, AIVersion version); AIAPI AIErr (*GetFileStartupProfileType) (const ai::FilePath &file, AIDocumentStartupProfile *docStartupProfile); AIAPI AIErr (*GetStartupFileOfType) (const AIDocumentStartupProfile docStartupProfile, ai::FilePath &profile); AIAPI AIErr (*GetFileFormatExtendedOptions) ( AIFileFormatHandle fileFormat, ai::int32 *extendedOptions ); AIAPI AIErr (*SetFileFormatExtendedOptions) ( AIFileFormatHandle fileFormat, ai::int32 extendedOptions); AIAPI AIErr(*GoExport) (AIActionParamValueRef actionParam); } ; typedef struct { AIAPI AIErr (*MacXGetFileFormatTitle) ( AIFileFormatHandle fileFormat, ai::UnicodeString& title ); AIAPI AIErr (*MacXSetFileFormatTitle) ( AIFileFormatHandle fileFormat, ai::UnicodeString title ); AIAPI AIErr (*MacXGetFileFormatType) ( AIFileFormatHandle fileFormat, ai::int32 *type ); AIAPI AIErr (*MacXSetFileFormatType) ( AIFileFormatHandle fileFormat, ai::int32 type ); } AIMacFileFormatSuite; #include "AIHeaderEnd.h" /******************************************************************************* ** ** Inline members ** **/ inline void AIFileFormatMessage::SetFilePath(const ai::FilePath &fp) { filePath = fp; } inline const ai::FilePath &AIFileFormatMessage::GetFilePath() const { return filePath; } #endif

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