SPInterf.h File Reference

#include "SPTypes.h"
#include "SPBasic.h"
#include "SPFiles.h"
#include "SPMData.h"
#include "SPPlugs.h"
#include "SPProps.h"
#include "SPHeaderBegin.h"
#include "SPErrorCodes.h"
#include "SPHeaderEnd.h"

Go to the source code of this file.

Classes
struct	SPInterfaceMessage
	A basic message, sent with kSPInterfaceCaller. More...
struct	SPInterfaceSuite
	This suite provides is the ability for a plug-in to call other plug-ins, by sending a message to the main entry point. More...
Defines
#define	kSPInterfaceSuite   "SP Interface Suite"
	PICA Interface suite name.
#define	kSPInterfaceSuiteVersion   2
	PICA Interface suite version.
#define	kSPInterfaceCaller   "SP Interface"
	PICA messaging system caller; see SPInterfaceSuite.
#define	kSPInterfaceStartupSelector   "Startup"
	PICA messaging system startup; see SPInterfaceSuite.
#define	kSPInterfaceShutdownSelector   "Shutdown"
	PICA messaging system shutdown; see SPInterfaceSuite.
#define	kSPInterfaceAboutSelector   "About"
	PICA messaging system request for information; see SPInterfaceSuite.
#define	kSPSweetPea2Adapter   "Sweet Pea 2 Adapter"
	Adapter name for PICA version 2.
#define	kSPSweetPea2AdapterVersion   1
	Adapter version for PICA version 2.
Functions
SPAPI SPErr	SPSendMessage (SPPluginRef plugin, const char *caller, const char *selector, void *message, SPErr *result)
	Internal.
SPAPI SPErr	SPSetupMessageData (SPPluginRef plugin, SPMessageData *data)
	Internal.
SPAPI SPErr	SPEmptyMessageData (SPPluginRef plugin, SPMessageData *data)
	Internal.
SPAPI SPErr	SPStartupExport (SPPluginListRef pluginList, const char *name, ai::int32 version, ai::int32 *started)
	Internal.

---

Define Documentation

#define kSPInterfaceAboutSelector   "About"

PICA messaging system request for information; see SPInterfaceSuite.

Illustrator sends this call to all plug-ins to implement the "About Plug-ins" feature.

#define kSPInterfaceCaller   "SP Interface"

PICA messaging system caller; see SPInterfaceSuite.

#define kSPInterfaceShutdownSelector   "Shutdown"

PICA messaging system shutdown; see SPInterfaceSuite.

#define kSPInterfaceStartupSelector   "Startup"

PICA messaging system startup; see SPInterfaceSuite.

#define kSPInterfaceSuite   "SP Interface Suite"

PICA Interface suite name.

#define kSPInterfaceSuiteVersion   2

PICA Interface suite version.

#define kSPSweetPea2Adapter   "Sweet Pea 2 Adapter"

Adapter name for PICA version 2.

#define kSPSweetPea2AdapterVersion   1

Adapter version for PICA version 2.

---

Function Documentation

SPAPI SPErr SPEmptyMessageData	(	SPPluginRef	plugin,
		SPMessageData *	data
	)

Internal.

SPAPI SPErr SPSendMessage	(	SPPluginRef	plugin,
		const char *	caller,
		const char *	selector,
		void *	message,
		SPErr *	result
	)

Internal.

SPAPI SPErr SPSetupMessageData	(	SPPluginRef	plugin,
		SPMessageData *	data
	)

Internal.

SPAPI SPErr SPStartupExport	(	SPPluginListRef	pluginList,
		const char *	name,
		ai::int32	version,
		ai::int32 *	started
	)

Internal.