AISelectionContextManager.h File Reference

#include "AITypes.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AISelectionContextManagerSuite
	This suite provides functions to access current selection context information. More...
Defines
#define	kAISelectionContextManagerSuite   "AI Selection Context Manager Suite"
#define	kAISelectionContextManagerSuiteVersion1   AIAPI_VERSION(1)
#define	kAISelectionContextManagerSuiteVersion   kAISelectionContextManagerSuiteVersion1
#define	kAISelectionContextManagerVersion   kAISelectionContextManagerSuiteVersion
#define	kNoTopLevelDocumentPropsError   '!TLP'
Enumerations
enum	AISelectionLevelContext {   kAISelectionNoneContext = 0, kAISelectionTopLevelContext = 1<<0, kAISelectionAnyLevelContext = 1<<1, kAISelectionObjectLevelContext = 1<<2,   kAISelectionCompleteContext = kAISelectionTopLevelContext | kAISelectionAnyLevelContext | kAISelectionObjectLevelContext }
	This suite works only for the current selection. More...
enum	AISelectionCountDetailsFlag { kTopLevelObjectTypeCount, kTopLevelTotalObjectCount, kObjectLevelObjectTypeCount, kObjectLevelTotalObjectCount }
enum	AISelectionContextFlags {   kAISelectionNone = 0, kAISelectionHasPathArt, kAISelectionHasMultiplePaths, kAISelectionHasOpenPathArt,   kAISelectionHasClosePathArt, kAISelectionHasLiveShapeArt, kAISelectionHasMultipleLiveShapeArt, kAISelectionHasGroupObject,   kAISelectionHasMultipleGroupObject, kAISelectionHasNormalGroup, kAISelectionHasMultipleNormalGroup, kAISelectionHasCompoundGroup,   kAISelectionHasMultipleCompoundGroup, kAISelectionHasClipGroup, kAISelectionHasMultipleClipGroup, kAISelectionHasNormalNonLayerGroup,   kAISelectionHasMultipleNormalNonLayerGroup, kAISelectionHasImageArt, kAISelectionHasMultipleImageArt, kAISelectionHasEmbedImageArt,   kAISelectionHasUnEmbedImageArt, kAISelectionHasMultipleUnEmbedImageArt, kAISelectionHasTextArt, kAISelectionHasMultipleTextArt,   kAISelectionHasSymbol, kAISelectionHasMultipleSymbol, kAISelectionHasSymbolSet, kAISelectionHasMultipleSymbolSet,   kAISelectionHasLivePaintGroup, kAISelectionHasMultipleLivePaintGroup, kAISelectionHasShaperGroup, kAISelectionHasMultipleShaperGroup,   kAISelectionHasGraphObjects, kAISelectionHasMultipleGraphObjects, kAISelectionHasTracedbject, kAISelectionHasMultipleTracedbject,   kAISelectionHasAnchorPoint, kAISelectionHasMultipleAnchorPoint, kAISelectionHasWarpEnvelope, kAISelectionHasMultipleWarpEnvelope,   kAISelectionHasMeshEnvelope, kAISelectionHasMultipleMeshEnvelope, kAISelectionHasTopEnvelope, kAISelectionHasMultipleTopEnvelope,   kAISelectionHasEnvelope, kAISelectionHasMultipleEnvelope, kAISelectionHasBlend, kAISelectionHasMultipleBlend,   kAISelectionHasMeshObject, kAISelectionHasMultipleMeshObject, kAISelectionHasTransformedSymbolInstance, kAISelectionHasGuides,   kAISelectionResetSymbolTransformation, kAISelectionCanEnableGlobalEditing, kAISelectionHasSymmetryRepeat, kAISelectionHasMultipleSymmetryRepeat,   kAISelectionHasRadialRepeat, kAISelectionHasMultipleRadialRepeat, kAISelectionHasGridRepeat, kAISelectionHasMultipleGridRepeat }

---

Detailed Description

---

Define Documentation

#define kAISelectionContextManagerSuite   "AI Selection Context Manager Suite"

#define kAISelectionContextManagerSuiteVersion   kAISelectionContextManagerSuiteVersion1

#define kAISelectionContextManagerSuiteVersion1   AIAPI_VERSION(1)

#define kAISelectionContextManagerVersion   kAISelectionContextManagerSuiteVersion

#define kNoTopLevelDocumentPropsError   '!TLP'

---

Enumeration Type Documentation

enum AISelectionContextFlags

Enumerator:

kAISelectionNone	To find if any art is present in the current selection.
kAISelectionHasPathArt	To find if any art context is present in the current selection.
kAISelectionHasMultiplePaths
kAISelectionHasOpenPathArt	To find if a path art (open/close) context is present in the current selection.
kAISelectionHasClosePathArt
kAISelectionHasLiveShapeArt	To find if a Live Shape context is present in the current selection.
kAISelectionHasMultipleLiveShapeArt
kAISelectionHasGroupObject	To find if a group context is present in the current selection. Compound group or Clip group, or, layer or sub-layer can share the same context.
kAISelectionHasMultipleGroupObject
kAISelectionHasNormalGroup	To find if a normal group context is present in the current selection.
kAISelectionHasMultipleNormalGroup
kAISelectionHasCompoundGroup	To find if a compound path context is present in the current selection.
kAISelectionHasMultipleCompoundGroup
kAISelectionHasClipGroup	To find if a clip group context is present in the current selection.
kAISelectionHasMultipleClipGroup
kAISelectionHasNormalNonLayerGroup	To find if a normal group (not a layer or a sub-layer) is present in the current selection.
kAISelectionHasMultipleNormalNonLayerGroup
kAISelectionHasImageArt	To find if an image art (embed or unembed) is present in the current selection.
kAISelectionHasMultipleImageArt
kAISelectionHasEmbedImageArt	To find if an embed image or an unembed art context is present in the current selection.
kAISelectionHasUnEmbedImageArt
kAISelectionHasMultipleUnEmbedImageArt
kAISelectionHasTextArt	To find if a text art context is present in the current selection.
kAISelectionHasMultipleTextArt
kAISelectionHasSymbol	To find if a symbol art context is present in the current selection.
kAISelectionHasMultipleSymbol
kAISelectionHasSymbolSet	To find if a symbol art context is present in the current selection.
kAISelectionHasMultipleSymbolSet
kAISelectionHasLivePaintGroup	To find if a Live Paint art context is present in the current selection.
kAISelectionHasMultipleLivePaintGroup
kAISelectionHasShaperGroup	To find if a shaper context is present in the current selection.
kAISelectionHasMultipleShaperGroup
kAISelectionHasGraphObjects	To find if a graph context is present in the current selection.
kAISelectionHasMultipleGraphObjects
kAISelectionHasTracedbject	To find if a traced context is present in the current selection.
kAISelectionHasMultipleTracedbject
kAISelectionHasAnchorPoint	To find if an anchor point context is present in the current selection.
kAISelectionHasMultipleAnchorPoint
kAISelectionHasWarpEnvelope	To find if a wrap envelope context is present in the current selection.
kAISelectionHasMultipleWarpEnvelope
kAISelectionHasMeshEnvelope	To find if a mesh envelope context is present in the current selection.
kAISelectionHasMultipleMeshEnvelope
kAISelectionHasTopEnvelope	To find if a top envelope context is present in the current selection.
kAISelectionHasMultipleTopEnvelope
kAISelectionHasEnvelope	To find if an envelope context is present in the current selection.
kAISelectionHasMultipleEnvelope
kAISelectionHasBlend	To find if a blend context is present in the current selection.
kAISelectionHasMultipleBlend
kAISelectionHasMeshObject	To find if a mesh context is present in the current selection.
kAISelectionHasMultipleMeshObject
kAISelectionHasTransformedSymbolInstance	To find if a transformed symbol context is present in the current selection.
kAISelectionHasGuides
kAISelectionResetSymbolTransformation	To find if the selected symbol has reset the transformation properties.
kAISelectionCanEnableGlobalEditing	To find if global editing can be applied on the current selection.
kAISelectionHasSymmetryRepeat	To find if a symmetry repeat context is present in the current selection.
kAISelectionHasMultipleSymmetryRepeat
kAISelectionHasRadialRepeat	To find if a radial repeat context is present in the current selection.
kAISelectionHasMultipleRadialRepeat
kAISelectionHasGridRepeat	To find if a grid repeat context is present in the current selection.
kAISelectionHasMultipleGridRepeat

enum AISelectionCountDetailsFlag

Enumerator:

kTopLevelObjectTypeCount	Total count of different types of context present at top level.
kTopLevelTotalObjectCount	Total context count present at top level.
kObjectLevelObjectTypeCount	Total count of different types of context present at object level.
kObjectLevelTotalObjectCount	Total count of context present at object level.

enum AISelectionLevelContext

This suite works only for the current selection.

Enumerator:

kAISelectionNoneContext	Default Value.
kAISelectionTopLevelContext	Context that is a direct child of a layer is termed as Below context.
kAISelectionAnyLevelContext	Any context present in the current selection, irrespective of parent or sibling.
kAISelectionObjectLevelContext	Context that is a direct child of a layer or a group is termed as an object-level context.
kAISelectionCompleteContext	Combined of Above Context.