API: SPInterf.h Source File

00001 /***********************************************************************/
00002 /*                                                                     */
00003 /* SPInterf.h                                                          */
00004 /*                                                                     */
00005 /* ADOBE SYSTEMS INCORPORATED                                          */
00006 /* Copyright 1995-2007 Adobe Systems Incorporated.                     */
00007 /* All Rights Reserved.                                                */
00008 /*                                                                     */
00009 /* NOTICE:  Adobe permits you to use, modify, and distribute this file */
00010 /* in accordance with the terms of the Adobe license agreement         */
00011 /* accompanying it. If you have received this file from a source other */
00012 /* than Adobe, then your use, modification, or distribution of it      */
00013 /* requires the prior written permission of Adobe.                     */
00014 /*                                                                     */
00015 /* Patents Pending                                                     */
00016 /*                                                                     */
00017 /*                                                                     */
00018 /***********************************************************************/
00019 
00020 #ifndef __SPInterface__
00021 #define __SPInterface__
00022 
00023 
00024 /*******************************************************************************
00025  **
00026  **     Imports
00027  **
00028  **/
00029 
00030 #include "SPTypes.h"
00031 #include "SPBasic.h"
00032 #include "SPFiles.h"
00033 #include "SPMData.h"
00034 #include "SPPlugs.h"
00035 #include "SPProps.h"
00036 
00037 #include "SPHeaderBegin.h"
00038 
00039 #ifdef __cplusplus
00040 extern "C" {
00041 #endif
00042 
00043 
00044 /*******************************************************************************
00045  **
00046  ** Constants
00047  **
00048  **/
00050 #define kSPInterfaceSuite                               "SP Interface Suite"
00051 
00052 #define kSPInterfaceSuiteVersion                2
00053 
00055 #define kSPInterfaceCaller                              "SP Interface"
00056 
00057 #define kSPInterfaceStartupSelector             "Startup"
00058 
00059 #define kSPInterfaceShutdownSelector    "Shutdown"
00060 
00063 #define kSPInterfaceAboutSelector               "About"
00064 
00066 #define kSPSweetPea2Adapter                             "Sweet Pea 2 Adapter"
00067 
00068 #define kSPSweetPea2AdapterVersion              1
00069 
00070 /*******************************************************************************
00071  **
00072  ** Types
00073  **
00074  **/
00075 
00077 typedef struct SPInterfaceMessage {
00078 
00080         SPMessageData d;
00081 
00082 } SPInterfaceMessage;
00083 
00084 
00085 /*******************************************************************************
00086  **
00087  ** Suite
00088  **
00089  **/
00108 typedef struct SPInterfaceSuite {
00109 
00119         SPAPI SPErr (*SendMessage)( SPPluginRef plugin, const char *caller, const char *selector,
00120                                 void *message, SPErr *result );
00121 
00130         SPAPI SPErr (*SetupMessageData)( SPPluginRef plugin, SPMessageData *data );
00137         SPAPI SPErr (*EmptyMessageData)( SPPluginRef plugin, SPMessageData *data );
00138 
00150         SPAPI SPErr (*StartupExport)( SPPluginListRef pluginList, const char *name, ai::int32 version,
00151                                 ai::int32 *started );
00152 
00153 } SPInterfaceSuite;
00154 
00155 
00157 SPAPI SPErr SPSendMessage( SPPluginRef plugin, const char *caller, const char *selector,
00158                         void *message, SPErr *result );
00159 
00161 SPAPI SPErr SPSetupMessageData( SPPluginRef plugin, SPMessageData *data );
00163 SPAPI SPErr SPEmptyMessageData( SPPluginRef plugin, SPMessageData *data );
00164 
00166 SPAPI SPErr SPStartupExport( SPPluginListRef pluginList, const char *name, ai::int32 version,
00167                         ai::int32 *started );
00168 
00169 
00170 /*******************************************************************************
00171  **
00172  ** Errors
00173  **
00174  **/
00175 
00176 #include "SPErrorCodes.h"
00177 
00178 #ifdef __cplusplus
00179 }
00180 #endif
00181 
00182 #include "SPHeaderEnd.h"
00183 
00184 #endif