AIArt.h Go to the documentation of this file. #ifndef __AIArt__ #define __AIArt__ /* * Name: AIArt.h * $Revision: 25 $ * Author: * Date: * Purpose: Adobe Illustrator Artwork Object Suite. * * ADOBE SYSTEMS INCORPORATED * Copyright 1986-2016 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 ** **/ #include "AITypes.h" #include "AILayer.h" #include "AIHeaderBegin.h" /******************************************************************************* ** ** Constants ** **/ #define kAIArtSuite "AI Art Suite" #define kAIArtSuiteVersion19 AIAPI_VERSION(19) #define kAIArtSuiteVersion kAIArtSuiteVersion19 #define kAIArtVersion kAIArtSuiteVersion #define kAIArtSelectionChangedNotifier "AI Art Selection Changed Notifier" #define kAIDrawingModeChangedNotifier "AI Drawing Mode Changed Notifier" #define kAIArtPropertiesChangedNotifier "AI Art Properties Changed Notifier" #define kAIAlignmentKeyArtChangedNotifier "AI Alignment Key Art Changed Notifier" enum AIDrawingMode { kAIDrawNormalMode = 0, kAIDrawBehindMode, kAIDrawInsideMode }; enum AIArtType { kAnyArt = -1, kUnknownArt = 0, kGroupArt, kPathArt, kCompoundPathArt, kTextArtUnsupported, kTextPathArtUnsupported, kTextRunArtUnsupported, kPlacedArt, kMysteryPathArt, kRasterArt, kPluginArt, kMeshArt, kTextFrameArt, kSymbolArt, kForeignArt, kLegacyTextArt, kChartArt, }; enum AIArtOrder { kUnknownOrder = 0, kFirstBeforeSecond = 1, kSecondAfterFirst = kFirstBeforeSecond, kFirstAfterSecond, kSecondBeforeFirst = kFirstAfterSecond, kFirstInsideSecond, kSecondInsideFirst }; enum AIArtUserAttr { kArtSelected = 0x00000001, kArtLocked = 0x00000002, kArtHidden = 0x00000004, kArtFullySelected = 0x00000008, kArtExpanded = 0x00000010, kArtTargeted = 0x00000020, kArtIsClipMask = 0x00001000, kArtIsTextWrap = 0x00010000, kArtSelectedTopLevelGroups = 0x00000040, kArtSelectedLeaves = 0x00000080, kArtSelectedTopLevelWithPaint = 0x00000100, // Top level groups that have a stroke or fill, or leaves kArtHasSimpleStyle = 0x00000200, kArtHasActiveStyle = 0x00000400, kArtPartOfCompound = 0x00000800, // notice that 0x00001000 is in use for kArtIsClipMask kMatchDictionaryArt = 0x00002000, kMatchArtInGraphs = 0x00004000, kMatchArtInResultGroups = 0x00008000, // notice that 0x00010000 is in use for kArtIsTextWrap kMatchTextPaths = 0x00020000, kArtStyleIsDirty = 0x00040000, kMatchArtNotIntoPluginGroups = 0x00080000, kMatchArtInCharts = 0x00100000 }; enum AIArtBoundsOptions { kVisibleBounds = 0x0000, kControlBounds = 0x0001, kNoStrokeBounds = 0x0002, kNoExtendedBounds = 0x0004, kWStrokeDependsOnPreference = 0x0008, kExcludeHiddenObjectBounds = 0x0010, kExcludeUnpaintedObjectBounds = 0x0020, kExcludeGuideBounds = 0x0040 }; enum AIArtTargettingAction { kReplaceAction = 0x0001, kAppendAction = 0x0002, kRemoveAction = 0x0003, kUpAction = 0x0004, kDownAction = 0x0005, kDownToLeafAction = 0x0006, kUpToLayersAction = 0x0007 }; enum AIArtTransferAttrsOptions { kTransferID = 1 << 0, kTransferStyle = 1 << 1, kTransferOpacityMask = 1 << 2, kTransferTextWrapProperties = 1 << 3, kTransferCompoundShapeMode = 1 << 4, kTransferSavedSelections = 1 << 5, kTransferSlicingAttributes = 1 << 6, kTransferArtLocked = 1 << 7, kTransferArtHidden = 1 << 8, kTransferSVGProperties = 1 << 9, kTransferLivePaintPathTags = 1 << 10, kTransferPixelPerfectAttribute = 1 << 11, kTransferLiveShapeProperties = 1 << 12, kTransferAll = 0xFFFFFFFF }; typedef struct _t_AICopyScopeOpaque* AICopyScopeHandle; enum AICopyScopeKind { kAICopyScopeForDuplicate = 0, kAICopyScopeForRetarget, kDummyScopeKind = 0xffffffff }; enum AIPathPolarity { kAIPolarPath, kAINonPolarPath }; enum AIArtTimeStampOptions { kAITimeStampOfArt = 1, // Example Usecase: Hiding/Showing a Layer in Layer Panel does not update the thumbnail of that Layer because timestamp of Layer's group art changes but that of its children does not. kAITimeStampOfChildren = kAITimeStampOfArt << 1, // Example Usecase: Thumbnail of Assets contained in Export Assets Panel are in sync with the visibility of that art on the document. // So if a group, added as an asset in Export Assets Panel, is shown/hidden (or its children are shown/hidden) then the thumbnail of that group in Asset Panel updates accordingly. kAITimeStampMaxFromArtAndChildren = kAITimeStampOfChildren << 1 }; #define kUnknownArtTypeErr 'ART?' #define kUnknownPaintOrderTypeErr 'ORD?' #define kUntouchableArtObjectErr 'ELIO' #define kTooDeepNestingErr 'NEST' #define kUntouchableLayerErr 'NESS' #define kInvalidArtTypeForDestErr '~VAT' /******************************************************************************* ** ** Suite ** **/ typedef struct AIArtSuite { AIAPI AIErr (*NewArt) ( ai::int16 type, ai::int16 paintOrder, AIArtHandle prep, AIArtHandle *newArt ); AIAPI AIErr (*DisposeArt) ( AIArtHandle art ); AIAPI AIErr (*ReorderArt) ( AIArtHandle thisArt, ai::int16 paintOrder, AIArtHandle prep ); AIAPI AIErr (*DuplicateArt) ( AIArtHandle thisArt, ai::int16 paintOrder, AIArtHandle prep, AIArtHandle *newArt ); AIAPI AIErr (*GetFirstArtOfLayer) ( AILayerHandle layer, AIArtHandle *art ); AIAPI AIErr (*GetLayerOfArt) ( AIArtHandle art, AILayerHandle *layer ); AIAPI AIErr (*GetArtType) ( AIArtHandle art, short *type ); AIAPI AIErr (*GetArtUserAttr) ( AIArtHandle art, ai::int32 whichAttr, ai::int32 *attr ); AIAPI AIErr (*SetArtUserAttr) ( AIArtHandle art, ai::int32 whichAttr, ai::int32 attr ); AIAPI AIErr (*GetArtParent) ( AIArtHandle art, AIArtHandle *parent ); AIAPI AIErr (*GetArtFirstChild) ( AIArtHandle art, AIArtHandle *child ); AIAPI AIErr (*GetArtSibling) ( AIArtHandle art, AIArtHandle *sibling ); AIAPI AIErr (*GetArtPriorSibling) ( AIArtHandle art, AIArtHandle *sibling ); AIAPI AIErr (*GetArtBounds) ( AIArtHandle art, AIRealRect *bounds ); AIAPI AIErr (*SetArtBounds) ( AIArtHandle art ); AIAPI AIErr (*GetArtCenterPointVisible) ( AIArtHandle art, AIBoolean *visible ); AIAPI AIErr (*SetArtCenterPointVisible) ( AIArtHandle art, AIBoolean visible ); AIAPI AIErr (*GetArtTransformBounds) ( AIArtHandle art, AIRealMatrix *transform, ai::int32 flags, AIRealRect *bounds ); /* Introduced in Illustrator 7.0 */ AIAPI AIErr (*UpdateArtworkLink) ( AIArtHandle art, AIBoolean force, AIBoolean *updated ); /* Introduced in Illustrator 8.0 */ AIAPI AIBoolean (*ValidArt) ( AIArtHandle art, AIBoolean searchAllLayerLists ); AIAPI AIErr (*GetArtOrder) ( AIArtHandle art1, AIArtHandle art2, short *order ); AIAPI AIErr (*SelectNamedArtOfLayer) ( AILayerHandle layer, const ai::UnicodeString& name, AIBoolean matchWholeWord, AIBoolean caseSensitive ); AIAPI AIErr (*GetArtRotatedBounds) ( AIArtHandle art, AIReal angle, ai::int32 flags, AIRealRect *bounds ); AIAPI AIBoolean (*ArtHasFill) ( AIArtHandle art ); AIAPI AIBoolean (*ArtHasStroke) ( AIArtHandle art ); AIAPI AIBoolean (*ArtsHaveEqualPaths) ( AIArtHandle art1, AIArtHandle art2 ); AIAPI AIErr (*ArtCopyFillStyleIfEqualPaths) ( AIArtHandle dstArt, AIArtHandle srcArt ); AIAPI AIErr (*ArtCopyStrokeStyleIfEqualPaths) ( AIArtHandle dstArt, AIArtHandle srcArt ); /* New in Illustrator 9.0 */ AIAPI AIErr (*GetInsertionPoint) ( AIArtHandle *art, short *paintorder, AIBoolean *editable ); AIAPI AIErr (*SetInsertionPoint) ( AIArtHandle art ); AIAPI AIErr (*GetKeyArt) ( AIArtHandle *art ); AIAPI AIErr (*CancelKeyArt) (void); AIAPI AIErr (*GetDictionary) ( AIArtHandle art, struct _AIDictionary** dictionary ); AIAPI AIBoolean (*HasDictionary) ( AIArtHandle art ); AIAPI AIBoolean (*IsDictionaryEmpty) ( AIArtHandle art ); AIAPI AIErr (*SetArtName) (AIArtHandle art, const ai::UnicodeString& name); AIAPI AIErr (*GetArtName) (AIArtHandle art, ai::UnicodeString& name, ASBoolean *isDefaultName); AIAPI AIErr (*IsArtLayerGroup) (AIArtHandle art, ASBoolean *isLayerGroup); AIAPI AIErr (*ReleaseToLayers) (const AIArtHandle art, ASBoolean build); AIAPI AIErr (*ModifyTargetedArtSet) (AIArtHandle *list, ai::int32 count, ai::int32 action); AIAPI AIBoolean (*IsArtStyledArt) (AIArtHandle art); AIAPI AIBoolean (*IsArtClipping) (AIArtHandle art); /* Introduced in Illustrator 10.0 */ AIAPI AIErr (*TransferAttributes) (AIArtHandle srcart, AIArtHandle dstart, ai::uint32 which); /* Introduced in Illustrator 11.0 */ AIAPI AIErr (*GetArtLastChild) ( AIArtHandle art, AIArtHandle *child ); AIAPI AIErr (*SetArtTextWrapProperty) ( AIArtHandle art, AIReal offset, AIBoolean invert ); AIAPI AIErr (*GetArtTextWrapProperty) ( AIArtHandle art, AIReal *offset, AIBoolean *invert ); AIAPI AIErr (*CreateCopyScope) (enum AICopyScopeKind kind, AICopyScopeHandle* scope); AIAPI AIErr (*DestroyCopyScope) (AICopyScopeHandle scope); /* Introduced in Illustrator 12.0 */ AIAPI AIErr (*InsertionPointBadForArtType) (ai::int16 paintOrder, AIArtHandle prep, ai::int16 artType); AIAPI AIErr (*PreinsertionFlightCheck) (AIArtHandle candidateArt, ai::int16 paintOrder, AIArtHandle prep); AIAPI AIErr (*SetNote) (AIArtHandle art, const ai::UnicodeString& inNote); AIAPI AIErr (*GetNote) (AIArtHandle art, ai::UnicodeString& outNote); AIAPI AIBoolean (*HasNote) (AIArtHandle art); AIAPI void (*DeleteNote) (AIArtHandle art); AIAPI AIErr (*GetArtXMPSize)(AIArtHandle art, size_t* size); AIAPI AIErr (*GetArtXMP)(AIArtHandle art, char *xmp, size_t size); AIAPI AIErr (*SetArtXMP)(AIArtHandle art, const char *xmp); AIAPI AIErr (*GetPreciseArtTransformBounds) ( AIArtHandle art, AIRealMatrix *transform, ai::int32 flags, AIDoubleRect *bounds ); AIAPI AIErr (*UncheckedDisposeArt) ( AIArtHandle art ); /* Introduced in Illustrator 13.0 */ AIAPI AIErr (*ArtIsGraph)(AIArtHandle art, AIBoolean *artisgraph); /* Introduced in Illustrator 14.0 */ AIAPI AIErr (*SetKeyArt)(AIArtHandle art); /* New in Illustrator 15.0 */ AIAPI AIErr (*GetDrawingMode)(ai::int32* mode); AIAPI AIErr (*SetDrawingMode)(ai::int32 mode); AIAPI AIErr (*GetInsertionPointForDrawingMode) (ai::int32 mode, AIArtHandle *art, short *paintorder, AIBoolean *editable); AIAPI AIErr (*GetInsertionPointForCurrentDrawingMode) (AIArtHandle *art, short *paintorder, AIBoolean *editable); AIAPI AIErr (*GetPathPolarity) (AIArtHandle art, ai::int32* polarity); AIAPI AIBoolean (*IsPixelPerfect) (AIArtHandle art); AIAPI AIErr (*SetPixelPerfect) (AIArtHandle art, AIBoolean isPixelPerfect); AIAPI AIBoolean (*ObjectsAreEquivalent) ( AIArtHandle art1, AIArtHandle art2 ); AIAPI AIErr (*IsArtALayerInSymbol) ( AIArtHandle art, AIBoolean* isLayerInSymbol ); AIAPI AIErr (*GetArtTimeStamp) ( AIArtHandle art, enum AIArtTimeStampOptions option, size_t* timeStamp ); /* Retrieves the global art edit timestamp. This value is a counter that is incremented on each art edit (0 at the beginning of the session). A comparison between the global timestamp and an art timestamp could reveal when the art was edited last. @return The global art edit time stamp for this session. */ AIAPI size_t (*GetGlobalTimeStamp) (); AIAPI AIErr (*ConvertPointTypeToAreaType) ( AIArtHandle art, AIArtHandle* newArtHandle ); AIAPI AIErr (*ConvertAreaTypeToPointType) ( AIArtHandle art, AIArtHandle* newArtHandle ); AIAPI AIErr (*MarkDirty) ( AIArtHandle art ); } AIArtSuite; #include "AIHeaderEnd.h" // __cplusplus #endif // __AIArt__

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