home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK2.toast / Development Kits (Disc 2) / OpenDoc Development Framework / ODFDev / ODF / Internet / SLCyPart.h < prev    next >
Encoding:
Text File  |  1996-09-17  |  5.6 KB  |  130 lines  |  [TEXT/MPS ]
  1. //========================================================================================
  2. //
  3. //    File:                SLCyPart.h
  4. //    Release Version:    $ ODF 2 $
  5. //
  6. //    Copyright:    (c) 1993 - 1996 by Apple Computer, Inc., all rights reserved.
  7. //    
  8. //    Callback struct for FW_OCyberPartExtension.
  9. //    See FWCyber.doc for theory and operation.
  10. //
  11. //========================================================================================
  12.  
  13. #ifndef SLCYPART_H
  14. #define SLCYPART_H
  15.  
  16. #ifndef FWSTRING_H
  17. #include "FWString.h"
  18. #endif
  19.  
  20. //----------------------------------------------------------------------------------------
  21. // Includes and Class Declarations
  22. //----------------------------------------------------------------------------------------
  23.  
  24. #ifndef __SOM__
  25. #include <som.xh>
  26. #endif
  27.  
  28. #ifndef SOM_CyberItem_xh
  29. #include <CyberItem.xh>    // CyberItemList
  30. #endif
  31.  
  32. struct Environment;
  33. struct FW_SCyberPartExtensionCallbacks;
  34. class ODFrame;
  35. class CyberItem;
  36. class ParameterSet;
  37.  
  38. //----------------------------------------------------------------------------------------
  39. // UPP Information Enums. Unused; kept only because we might choose to use
  40. // them in the future.
  41. //----------------------------------------------------------------------------------------
  42.  
  43. #if 0
  44.  
  45. enum {
  46.     FW_kDoCyberCommandInfo = kCStackBased
  47.         | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(Environment*)))
  48.         | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(FW_SCyberPartExtensionCallbacks*))),
  49.         | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(long))),
  50.         | STACK_ROUTINE_PARAMETER(4, SIZE_CODE(sizeof(ODFrame*))),
  51.         | STACK_ROUTINE_PARAMETER(5, SIZE_CODE(sizeof(somToken))),
  52.     FW_kOpenCyberItemInfo = kCStackBased
  53.         | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(Environment*)))
  54.         | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(FW_SCyberPartExtensionCallbacks*))),
  55.         | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(CyberItem*))),
  56.         | STACK_ROUTINE_PARAMETER(4, SIZE_CODE(sizeof(ODPart*))),
  57.         | STACK_ROUTINE_PARAMETER(5, SIZE_CODE(sizeof(ParameterSet*))),
  58.     FW_kSetCyberItemInfo = kCStackBased
  59.         | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(Environment*)))
  60.         | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(FW_SCyberPartExtensionCallbacks*))),
  61.         | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(CyberItem*))),
  62.         | STACK_ROUTINE_PARAMETER(4, SIZE_CODE(sizeof(ParameterSet*))),
  63.     FW_kShowCyberItemInfo = kCStackBased
  64.         | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(Environment*)))
  65.         | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(FW_SCyberPartExtensionCallbacks*))),
  66.         | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(CyberItem*))),
  67.     FW_kIsSelectedURLInfo = kCStackBased
  68.         | RESULT_SIZE(SIZE_CODE(sizeof(Boolean)))
  69.         | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(Environment*)))
  70.         | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(FW_SCyberPartExtensionCallbacks*))),
  71.         | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(ODFrame*))),
  72.     FW_kGetSelectedURLInfo = kCStackBased
  73.         | RESULT_SIZE(SIZE_CODE(sizeof(corbastring)))
  74.         | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(Environment*)))
  75.         | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(FW_SCyberPartExtensionCallbacks*))),
  76.         | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(ODFrame*))),
  77.     FW_kIsSelectedCyberItemInfo = kCStackBased
  78.         | RESULT_SIZE(SIZE_CODE(sizeof(Boolean)))
  79.         | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(Environment*)))
  80.         | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(FW_SCyberPartExtensionCallbacks*))),
  81.         | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(ODFrame*))),
  82.     FW_kAcquireSelectedCyberItemsInfo = kCStackBased
  83.         | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(Environment*)))
  84.         | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(FW_SCyberPartExtensionCallbacks*))),
  85.         | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(ODFrame*))),
  86.         | STACK_ROUTINE_PARAMETER(4, SIZE_CODE(sizeof(CyberItemList*))),
  87.     FW_kGetCyberItemWindowInfo = kCStackBased
  88.         | RESULT_SIZE(SIZE_CODE(sizeof(ODWindow*)))
  89.         | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(Environment*)))
  90.         | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(FW_SCyberPartExtensionCallbacks*)))
  91.         | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(CyberItem*)))
  92. };
  93.  
  94. #endif
  95.  
  96. //========================================================================================
  97. // Struct FW_SCyberPartExtensionCallbacks
  98. //========================================================================================
  99.  
  100. /*
  101.     Since this structure is part of the FW_OCyberPartExtension API, and
  102.     may be compiled into a shared library, it needs to have compiler-
  103.     independent alignment.
  104. */
  105.  
  106. #if PRAGMA_ALIGN_SUPPORTED
  107. #pragma options align=mac68k
  108. #endif
  109.  
  110. struct FW_SCyberPartExtensionCallbacks {
  111.     void             (*openCyberItem)         (Environment*, FW_SCyberPartExtensionCallbacks*, CyberItem*, ODPart*, ParameterSet*);
  112.     void             (*setCyberItem)         (Environment*, FW_SCyberPartExtensionCallbacks*, CyberItem*, ParameterSet*);
  113.     ODBoolean         (*canShowCyberItem)        (Environment*, FW_SCyberPartExtensionCallbacks*, CyberItem*);
  114.     void             (*showCyberItem)         (Environment*, FW_SCyberPartExtensionCallbacks*, CyberItem*);
  115.     ODWindow*         (*getCyberItemWindow)     (Environment*, FW_SCyberPartExtensionCallbacks*, CyberItem*);
  116.     ODBoolean         (*isCyberItemSelected)     (Environment*, FW_SCyberPartExtensionCallbacks*, ODFrame*);
  117.     void             (*acquireSelectedCyberItems) (Environment*, FW_SCyberPartExtensionCallbacks*, ODFrame*, CyberItemList*);
  118.     ODBoolean        (*isURLSelected)         (Environment*, FW_SCyberPartExtensionCallbacks*, ODFrame*);
  119.     void             (*getSelectedURL)         (Environment*, FW_SCyberPartExtensionCallbacks*, ODFrame*, FW_CString& url);
  120.     ODBoolean         (*handleCommand)         (Environment*, FW_SCyberPartExtensionCallbacks*, long, long, ODFrame*, somToken);
  121.     void             (*extensionRemoved)        (Environment*, FW_SCyberPartExtensionCallbacks*);
  122. };
  123.  
  124. #if PRAGMA_ALIGN_SUPPORTED
  125. #pragma options align=reset
  126. #endif
  127.  
  128. #endif // SLCYPART_H
  129.  
  130.