Plug-in Callers

Allowed values for the caller parameter of plug-in entry point, see Adobe Plug-in Component Architecture (PICA). More...

Defines
#define	kActionCaller   "Action Manager"
	Caller id for messages sent to plug-ins from the action manager.
#define	kCallerAIAnnotation   "AI Annotation"
	The annotation caller.
#define	kCallerAIClipboard   "AI Clipboard"
	The clipboard caller.
#define	kCallerAICommand   "Plugin Command Manager"
	Caller for deprecated AICommandManagerSuite.
#define	kCallerAIFileFormat   "AI File Format"
	The file format caller.
#define	kCallerAIFilter   "AI Filter"
	The filter caller.
#define	kCallerAILayerList   "AI Layer List"
	Caller for layer list messages.
#define	kCallerAILiveEffect   "AI Live Effect"
	The Live Effect caller.
#define	kCallerAIMenu   "AI Menu"
	Menu caller, see AIMenuSuite.
#define	kCallerAINotify   "AI Notifier"
	See AINotifierSuite.
#define	kCallerAIObjectSet   "AI Object Set"
	Object set caller.
#define	kAIPaintStyleModifierCaller   "AI PaintStyle Modifier Caller"
	Caller for updating any paint style properties.
#define	kCallerAIPluginGroup   "AI Plugin Group"
	See AIPluginGroupSuite.
#define	kAIPreferenceCaller   "AI Preference"
	See AIPreferenceSuite.
#define	kAISwatchLibsCaller   "Swatch Libraries"
	Caller ID for messages sent to plug-ins from the Swatch Libraries plug-in.
#define	kCallerAITimer   "AI Timer"
	See AITimerSuite.
#define	kCallerAITool   "AI Tool"
	The tool caller.
#define	kCallerAIToolbox   "AI Toolbox"
	The toolbox caller.
#define	kCallerAITransformAgain   "AI Transform Again"
	The transform again caller.
#define	kAIWorkspaceCaller   "Workspace Manager"
	Sent to plug-ins from the workspace manager.
#define	kSPAccessCaller   "SP Access"
	The SPAccessSuite sends a reload message (kSPAccessReloadSelector) to a plug-in when it has just been loaded, and an unload message (kSPAccessUnloadSelector) when it is about to be unloaded.
#define	kSPAdaptersCaller   "SP Adapters"
	Caller for a plug-in adapter.
#define	kSPCacheCaller   "SP Cache"
	The cache management caller.
#define	kSPPropertiesCaller   "SP Properties"
	PICA plug-in property operation; sent with SPPropertiesMessage.

---

Detailed Description

Allowed values for the caller parameter of plug-in entry point, see Adobe Plug-in Component Architecture (PICA).

---

Define Documentation

#define kActionCaller   "Action Manager"

Caller id for messages sent to plug-ins from the action manager.

See AIActionManagerSuite.

#define kAIPaintStyleModifierCaller   "AI PaintStyle Modifier Caller"

Caller for updating any paint style properties.

See AIPaintStyleSuite.

#define kAIPreferenceCaller   "AI Preference"

See AIPreferenceSuite.

#define kAISwatchLibsCaller   "Swatch Libraries"

Caller ID for messages sent to plug-ins from the Swatch Libraries plug-in.

#define kAIWorkspaceCaller   "Workspace Manager"

Sent to plug-ins from the workspace manager.

See AIWorkspaceSuite.

#define kCallerAIAnnotation   "AI Annotation"

The annotation caller.

See AIAnnotatorSuite

#define kCallerAIClipboard   "AI Clipboard"

The clipboard caller.

See AIClipboardSuite.

#define kCallerAICommand   "Plugin Command Manager"

Caller for deprecated AICommandManagerSuite.

Deprecated:

Use AIMenuSuite instead.

#define kCallerAIFileFormat   "AI File Format"

The file format caller.

See AIFileFormatSuite.

#define kCallerAIFilter   "AI Filter"

The filter caller.

See AIFilterSuite.

#define kCallerAILayerList   "AI Layer List"

Caller for layer list messages.

See AILayerListSuite.

#define kCallerAILiveEffect   "AI Live Effect"

The Live Effect caller.

See AILiveEffectSuite.

#define kCallerAIMenu   "AI Menu"

Menu caller, see AIMenuSuite.

#define kCallerAINotify   "AI Notifier"

See AINotifierSuite.

#define kCallerAIObjectSet   "AI Object Set"

Object set caller.

Object sets are deprecated in favor of dictionaries, see AIDictionarySuite

#define kCallerAIPluginGroup   "AI Plugin Group"

See AIPluginGroupSuite.

#define kCallerAITimer   "AI Timer"

See AITimerSuite.

#define kCallerAITool   "AI Tool"

The tool caller.

See AIToolSuite.

#define kCallerAIToolbox   "AI Toolbox"

The toolbox caller.

See AIToolboxSuite.

#define kCallerAITransformAgain   "AI Transform Again"

The transform again caller.

See AITransformAgainSuite.

#define kSPAccessCaller   "SP Access"

The SPAccessSuite sends a reload message (kSPAccessReloadSelector) to a plug-in when it has just been loaded, and an unload message (kSPAccessUnloadSelector) when it is about to be unloaded.

A plug-in is automatically loaded when the application or another plug-in calls it or acquires as suite that it exports. A plug-in can be unloaded at any time if it is not being used.

A plug-in that exports a suite should unload the suite's procedure pointers when it is unloaded, and restore them when the plug-in is reloaded.

• On unload, replace the suite's procedure pointers with the address of the SPBasicSuite::Undefined() function (which is always available). This is a protective measure against other plug-ins that may mistakenly use the suite after they have released it.
• On reload, restore the suite's procedure pointers with the updated addresses of their functions.

For example:

                SPErr UnloadSuite( MySuite *mySuite, SPAccessMessage *message ) {
                        mySuite->functionA = (void *) message->d.basic->Undefined;
                        mySuite->functionB = (void *) message->d.basic->Undefined;
                }

                SPErr ReloadSuite( MySuite *mySuite, SPAccessMessage *message ) {
                        mySuite->functionA = functionA;
                        mySuite->functionB = functionB;
                }

#define kSPAdaptersCaller   "SP Adapters"

Caller for a plug-in adapter.

Sent to plug-ins with adapters to allow the adapter to load or unload files of managed types, or to make translations for compatibility with legacy versions of PICA, the application, or earlier versions of the plug-in. See SPAdaptersSuite.

#define kSPCacheCaller   "SP Cache"

The cache management caller.

See SPCachesSuite

#define kSPPropertiesCaller   "SP Properties"

PICA plug-in property operation; sent with SPPropertiesMessage.

See SPPropertiesSuite.