home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / odtlktv4.zip / ODTLKT / TOOLKIT / IDL / OSASC.IDL < prev    next >
Text File  |  1995-12-13  |  9KB  |  233 lines
  1. /********************************************************************/
  2. /*  Licensed Materials - Property of IBM                            */
  3. /*                                                                  */
  4. /*                                                                  */
  5. /* Copyright (C) International Business Machines Corp., 1994.       */
  6. /* Copyright (C) Apple Computer, Inc., 1994                         */
  7. /*                                                                  */
  8. /*  US Government Users Restricted Rights -                         */
  9. /*  Use, duplication, or disclosure restricted                      */
  10. /*  by GSA ADP Schedule Contract with IBM Corp.                     */
  11. /*                                                                  */
  12. /*                                                                  */
  13. /********************************************************************/
  14.  
  15. #ifndef _OSASCRIPTINGCOMPONENT_
  16. #define _OSASCRIPTINGCOMPONENT_
  17.  
  18. #ifndef _COMPONENT_
  19. #include <comp.idl>
  20. #endif
  21.  
  22. //==============================================================================
  23. // Class defined in this interface
  24. //==============================================================================
  25.  
  26. interface OSAScriptingComponent;
  27.  
  28. //==============================================================================
  29. // Classes used by this interface
  30. //==============================================================================
  31.  
  32. interface Component;
  33.  
  34. //==============================================================================
  35. // Implementation Types
  36. //==============================================================================
  37.  
  38. typedef somToken Handle;
  39. typedef somToken AEDesc;
  40. typedef somToken AEDescList;
  41. typedef somToken OSAError;
  42. typedef somToken OSAID;
  43. typedef somToken OSAEvent;
  44. typedef somToken OSAActiveUPP;
  45. typedef somToken OSASendUPP;
  46. typedef somToken OSACreateOSAEventUPP;
  47. typedef somToken AEEventHandlerUPP;
  48. typedef somToken AEAddressDesc;
  49.  
  50.  
  51. //==============================================================================
  52. // Class OSAScriptingComponent
  53. //==============================================================================
  54.  
  55. interface OSAScriptingComponent : Component {
  56.  
  57. OSErr    OSAAddStorageType(in ODUByte *oldScriptData, in ODULong oldSize,
  58.                            out ODUByte newScriptData, inout ODULong newSize, in DescType dtype);
  59.  
  60. OSErr    OSAGetStorageType(in ODUByte *scriptData, in ODULong size, out DescType pdtype);
  61.  
  62. OSErr    OSARemoveStorageType(in ODUByte *oldScriptData, in ODULong oldSize,
  63.                               out ODUByte newScriptData, inout ODULong newSize);
  64.  
  65. OSAError OSAAvailableDialectCodeList(out AEDesc presultingDialectCodeList);
  66.  
  67. OSAError OSAAvailableDialects(out AEDesc presultingDialectInfoList);
  68.  
  69. OSAError OSACoerceFromDesc(in AEDesc* pscriptData, in ODSLong modeFlags,
  70.                            out OSAID presultingScriptID);
  71.  
  72. OSAError OSACoerceToDesc(in OSAID scriptID, in DescType desiredType,
  73.                          in ODSLong modeFlags, out AEDesc presult);
  74.  
  75. OSAError OSACompile(in AEDesc* psourceData, in ODSLong modeFlags,
  76.                     inout OSAID ppreviousAndResultingScriptID);
  77.  
  78. OSAError OSACompileExecute(in AEDesc* psourceData, in OSAID contextID,
  79.                       in ODSLong modeFlags, out OSAID presultingScriptValueID);
  80.  
  81. OSAError OSACopyID(in OSAID fromID, out OSAID ptoID);
  82.  
  83. OSAError OSADisplay(in OSAID scriptValueID, in DescType desiredType,
  84.                  in ODULong modeFlags, out AEDesc presultingText);
  85.  
  86. OSAError OSADispose(in OSAID scriptID);
  87.  
  88. OSAError OSADoEvent(in OSAEvent* ptheOSAEvent, in OSAID contextID,
  89.                  in ODSLong modeFlags, inout OSAEvent preply);
  90.  
  91. OSAError OSADoScript(in AEDesc* psourceData, in OSAID contextID,
  92.                   in DescType desiredType, in ODSLong modeFlags,
  93.                   out AEDesc presultingText);
  94.  
  95. OSAError OSAExecute(in OSAID compiledScriptID, in OSAID contextID,
  96.                  in ODSLong modeFlags, out OSAID presultingScriptValueID);
  97.  
  98. OSAError OSAExecuteEvent(in OSAEvent* ptheOSAEvent, in OSAID contextID,
  99.                       in ODSLong modeFlags, out OSAID presultingScriptValueID);
  100.  
  101. OSAError OSAGetActiveProc(out OSAActiveUPP pactiveProc, out ODSLong prefCon);
  102.  
  103. OSAError OSAGetCreateProc(out OSACreateOSAEventUPP pcreateProc,
  104.                           out ODSLong prefCon);
  105.  
  106. OSAError OSAGetCurrentDialect(out ODSShort presultingDialectCode);
  107.  
  108. OSAError OSAGetDialectInfo(in ODSShort dialectCode, in OSType selector,
  109.                            out AEDesc presultingDialectInfo);
  110.  
  111. OSAError OSAGetResumeDispatchProc(out AEEventHandlerUPP presumeDispatchProc,
  112.                                   out ODSLong prefCon);
  113.  
  114. OSAError OSAGetScriptInfo(in OSAID scriptID, in OSType selector,
  115.                           out ODSLong presult);
  116.  
  117. OSAError OSAGetSendProc(out OSASendUPP psendProc, out ODSLong prefCon);
  118.  
  119. OSAError OSAGetSource(in OSAID scriptID, in DescType desiredType,
  120.                       out AEDesc presultingSourceData);
  121.  
  122. OSAError OSALoad(inout AEDesc pscriptData, in ODSLong modeFlags,
  123.                  out OSAID presultingScriptID);
  124.  
  125. OSAError OSALoadExecute(in AEDesc *pscriptData, in OSAID contextID,
  126.                         in ODSLong modeFlags, out OSAID presultingScriptValueID);
  127.  
  128. OSAError OSAMakeContext(in AEDesc *pcontextName, in OSAID parentContext,
  129.                         out OSAID presultingContextID);
  130.  
  131. OSAError OSAScriptError(in OSType selector, in DescType desiredType,
  132.                         out AEDesc presultingErrorDescription);
  133.  
  134. OSAError OSAScriptingComponentName(out AEDesc presultingScriptingComponentName);
  135.  
  136. OSAError OSASetActiveProc(in OSAActiveUPP activeProc, in ODSLong refCon);
  137.  
  138. OSAError OSASetCreateProc(in OSACreateOSAEventUPP createProc,
  139.                           in ODSLong refCon);
  140.  
  141. OSAError OSASetCurrentDialect(in ODSShort dialectCode);
  142.  
  143. OSAError OSASetDefaultTarget(in AEAddressDesc *ptarget);
  144.  
  145. OSAError OSASetScriptInfo(in OSAID scriptID, in OSType selector, in ODSLong value);
  146.  
  147. OSAError OSASetSendProc(in OSASendUPP sendProc, in ODSLong refCon);
  148.  
  149. OSAError OSASetResumeDispatchProc(in AEEventHandlerUPP resumeDispatchProc,
  150.                                   in ODSLong refCon);
  151.  
  152. OSAError OSAStartRecording(inout OSAID pcompiledScriptToModifyID);
  153.  
  154. OSAError OSAStopRecording(in OSAID compiledScriptID);
  155.  
  156. OSAError OSAStore(in OSAID scriptID, in DescType desiredType,
  157.                   in ODSLong modeFlags, out AEDesc presultingScriptData);
  158.  
  159.  
  160. #ifdef __SOMIDL__
  161.  
  162. implementation {
  163.  
  164.         ODSShort                        dialectCode;
  165.         AEDescList                      dialectCodeList;
  166.         ODBoolean                       recordingMode;
  167.         OSASendUPP                      sendProc;
  168.         AEEventHandlerUPP               resumeDispatchProc;
  169.         OSACreateOSAEventUPP            createProc;
  170.         OSAActiveUPP                    activeProc;
  171.         AEAddressDesc                   targetApplication;
  172.  
  173.         majorversion = 1;
  174.         minorversion = 0;
  175.         somDefaultInit: override, init;
  176.         somDestruct: override;
  177.         functionprefix = OSASC_;
  178.         releaseorder :  OSAAddStorageType,
  179.                         OSAGetStorageType,
  180.                         OSARemoveStorageType,
  181.                         OSAAvailableDialectCodeList,
  182.                         OSAAvailableDialects,
  183.                         OSACoerceFromDesc,
  184.                         OSACoerceToDesc,
  185.                         OSACompile,
  186.                         OSACompileExecute,
  187.                         OSACopyID,
  188.                         OSADisplay,
  189.                         OSADispose,
  190.                         OSADoEvent,
  191.                         OSADoScript,
  192.                         OSAExecute,
  193.                         OSAExecuteEvent,
  194.                         OSAGetActiveProc,
  195.                         OSAGetCreateProc,
  196.                         OSAGetCurrentDialect,
  197.                         OSAGetDialectInfo,
  198.                         OSAGetResumeDispatchProc,
  199.                         OSAGetScriptInfo,
  200.                         OSAGetSendProc,
  201.                         OSAGetSource,
  202.                         OSALoad,
  203.                         OSALoadExecute,
  204.                         OSAMakeContext,
  205.                         OSAScriptError,
  206.                         OSAScriptingComponentName,
  207.                         OSASetActiveProc,
  208.                         OSASetCreateProc,
  209.                         OSASetCurrentDialect,
  210.                         OSASetDefaultTarget,
  211.                         OSASetResumeDispatchProc,
  212.                         OSASetScriptInfo,
  213.                         OSASetSendProc,
  214.                         OSAStartRecording,
  215.                         OSAStopRecording,
  216.                         OSAStore,
  217.                         Reserved1,
  218.                         Reserved2,
  219.                         Reserved3,
  220.                         Reserved4
  221.                         ;
  222.         nooverride :    OSAAddStorageType,
  223.                         OSAGetStorageType,
  224.                         OSARemoveStorageType;
  225.         dllname = "OPENDOC.DLL";
  226. };
  227.  
  228. #endif
  229.  
  230. };
  231.  
  232. #endif
  233.