AISymbol.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AIColor.h"
#include "AIPathStyle.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AISymbolSetChangeNotifierData
	Data sent with kAIArtSymbolSetDetailedChangeNotifier. More...
struct	AISymbolInstanceDoubleClickedNotifierData
	Data sent with kAIArtSymbolDoubleClickedNotifier. More...
struct	AISymbolSuite
	This suite is always available. More...
struct	AISymbolPaletteSuite
	These functions access and manipulate the currency and selection state of symbols. More...
Defines
#define	kAISymbolSuite   "AI Symbol Suite"
#define	kAISymbolSuiteVersion8   AIAPI_VERSION(8)
#define	kAISymbolSuiteVersion   kAISymbolSuiteVersion8
#define	kAISymbolVersion   kAISymbolSuiteVersion
#define	kAISymbolPaletteSuite   "AI Symbol Palette Suite"
#define	kAISymbolPaletteSuiteVersion3   AIAPI_VERSION(3)
#define	kAISymbolPaletteSuiteVersion   kAISymbolPaletteSuiteVersion3
#define	kAISymbolPaletteVersion   kAISymbolPaletteSuiteVersion
#define	kAIArtSymbolSetChangedNotifier   "AI Art Symbol Set Changed Notifier"
	Sent when symbols are added, deleted, redefined (including indirectly due to redefinition of elements used inside the symbol pattern), renamed, sorted or moved in the symbol list.
#define	kAIArtSymbolSetDetailedChangeNotifier   "AI Art Symbol Set Detailed Change Notifier"
	Sent after kAIArtSymbolSetChangedNotifier, with the same time stamp.
#define	kAIArtSymbolListChangedNotifier   "AI Art Symbol List Changed Notifier"
	Sent when symbols are added to, removed from, or reordered in the symbol list.
#define	kAIArtSymbolDoubleClickedNotifier   "AI Art Symbol Double Clicked Notifier"
	Sent when a symbol instance is double-clicked.
#define	kMaxSymbolNameLength   63
	Maximum number of real characters in a symbol name.
#define	kSymbolNotInCurrentDocument   'SYnD'
	Attempt to modify a symbol that is not in the current document.
#define	kCircularSymbolDefinitionErr   '@in@'
	Symbol definitions cannot contain instances of the symbol being redefined.
#define	kNoGraphsInSymbolDefErr   '#in@'
	Symbol definitions cannot contain graphs.
#define	kNoLinkedImagesInSymbolDefErr   '!%i@'
	Symbol definitions cannot contain linked (non-embedded) images.
#define	kNoPerspectiveInSymbolDefErr   '$in@'
	Symbol definitions cannot contain Text and symbol in Perspective.
#define	kInvalidSymbolDefErr   '!#Sd'
	Miscellaneous problems with the definition art for symbols.
#define	kCantDeleteSymbolUsedInLiveEffectsErr   '!Del'
	Symbol cannot be deleted because it is used in Live Effects.
#define	kAISymbolToSelectDictKey   "AISymbolToSelect"
	When a plug-in group object is selected and has this key, it is selected as if it were an instance of the associated symbol.
Enumerations
enum	AISymbolChangeType { kSymbolAdded, kSymbolDeleted, kSymbolRenamed, kSymbolChanged }
	The type of symbol change that triggered the notification, sent in AISymbolSetChangeNotifierData. More...
enum	AISymbolSearchScope {   kSearchArtDictionary = 0x0001, kSearchDescendants = 0x0002, kSearchVisualRepresentation = 0x0004, kSearchNestedSymbolPatterns = 0x0008,   kSearchEffectDictionaries = 0x0040, kSymbolSearchEverywhere = 0x004F, kSearchPrintingOnly = 0x0010, kSymbolSearchListedOnly = 0x0020 }
	Bit flags for the search scope in AISymbolSuite::ArtUsesSymbolPattern(). More...
enum	AISymbolGlobalObjectUsage { kUsedInGraphDesigns = 0x0001, kUsedInUsedGraphDesigns = 0x0002, kUsedInOtherSymbols = 0x0004, kUsedInUsedSymbols = 0x0008 }
	Bit flags for the global object usage result from AISymbolSuite::ArtUsesSymbolPattern(). More...
enum	AISymbolFlashExportType { kGraphicType = 0x01, kMovieClipType = 0x02 }
	Symbol type used when exporting to Flash. More...
enum	AISymbolRegistrationPoint {   kSymbolTopLeftPoint = 0x01, kSymbolTopMiddlePoint, kSymbolTopRightPoint, kSymbolMiddleLeftPoint,   kSymbolCenterPoint, kSymbolMiddleRightPoint, kSymbolBottomLeftPoint, kSymbolBottomMiddlePoint,   kSymbolBottomRightPoint, kSymbolRegistrationPointUndefined = 0xffffffff }
	Symbol registration point. More...
enum	SymbolDeleteChoice { kExpandInstances, kDeleteInstances }

---

Detailed Description

---

Define Documentation

#define kAISymbolPaletteSuite   "AI Symbol Palette Suite"

#define kAISymbolPaletteSuiteVersion   kAISymbolPaletteSuiteVersion3

#define kAISymbolPaletteSuiteVersion3   AIAPI_VERSION(3)

#define kAISymbolPaletteVersion   kAISymbolPaletteSuiteVersion

#define kAISymbolSuite   "AI Symbol Suite"

#define kAISymbolSuiteVersion   kAISymbolSuiteVersion8

#define kAISymbolSuiteVersion8   AIAPI_VERSION(8)

#define kAISymbolVersion   kAISymbolSuiteVersion

#define kMaxSymbolNameLength   63

Maximum number of real characters in a symbol name.

When retrieving a name, the buffer size should be at least this value + 1. If it is less, the name is truncated.

---

Enumeration Type Documentation

enum AISymbolChangeType

The type of symbol change that triggered the notification, sent in AISymbolSetChangeNotifierData.

Enumerator:

kSymbolAdded
kSymbolDeleted
kSymbolRenamed
kSymbolChanged

enum AISymbolFlashExportType

Symbol type used when exporting to Flash.

See also:

AISymbolSuite::SetSymbolExportType(), AISymbolSuite::GetSymbolExportType()

Enumerator:

kGraphicType	Corresponds to Graphic Symbol type in Flash.
kMovieClipType	Corresponds to Movie Clip Symbol type in Flash.

enum AISymbolGlobalObjectUsage

Bit flags for the global object usage result from AISymbolSuite::ArtUsesSymbolPattern().

Enumerator:

kUsedInGraphDesigns	Used in graph designs.
kUsedInUsedGraphDesigns	Used in graph designs that are themselves in use.
kUsedInOtherSymbols	Used in the definition of other symbols.
kUsedInUsedSymbols	Used in the definition of symbols that are themselves in use.

enum AISymbolRegistrationPoint

Symbol registration point.

AISymbolSuite::NewSymbolPattern() AISymbolSuite::NewSymbolPatternFromSel() AISymbolSuite::NewSymbolPatternFromSelGetBounds()

Enumerator:

kSymbolTopLeftPoint
kSymbolTopMiddlePoint
kSymbolTopRightPoint
kSymbolMiddleLeftPoint
kSymbolCenterPoint
kSymbolMiddleRightPoint
kSymbolBottomLeftPoint
kSymbolBottomMiddlePoint
kSymbolBottomRightPoint
kSymbolRegistrationPointUndefined

enum AISymbolSearchScope

Bit flags for the search scope in AISymbolSuite::ArtUsesSymbolPattern().

If none of the first five flags is set, then the only objects that report using a symbol are actual instances of that symbol.

Enumerator:

kSearchArtDictionary	Search dictionary of the input art object (that is, inside the art style definition attached to the root object.
kSearchDescendants	Search children of groups and other containers. Note: If on, also searches in effect dictionaries in descendants, regardless of kSearchArtDictionary value.
kSearchVisualRepresentation	Search styled art and the result groups of plug-in groups.
kSearchNestedSymbolPatterns	Search the symbol pattern definitions of any symbol instances.
kSearchEffectDictionaries	Search for symbols in effect parameters.
kSymbolSearchEverywhere	Turns on all previous flags.
kSearchPrintingOnly	Do not search invisible objects or the edit groups of plug-in groups.
kSymbolSearchListedOnly	Check only for symbols listed in the palette; ignore unlisted ones.

enum SymbolDeleteChoice

Enumerator:

kExpandInstances
kDeleteInstances