home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / warphead.zip / H / SHPLUGIN.H < prev    next >
C/C++ Source or Header  |  1997-02-28  |  3KB  |  90 lines
  1. /* @(#)Z 1.2 com/src/include/c/ShPlugIn.h, odcore, od96os2, odos29646d 96/11/15 15:29:35 (96/07/15 18:14:37) */
  2. /*====START_GENERATED_PROLOG======================================
  3.  */
  4. /*
  5.  *   COMPONENT_NAME: odcore
  6.  *
  7.  *   CLASSES: none
  8.  *
  9.  *   ORIGINS: 82,27
  10.  *
  11.  *
  12.  *   (C) COPYRIGHT International Business Machines Corp. 1995,1996
  13.  *   All Rights Reserved
  14.  *   Licensed Materials - Property of IBM
  15.  *   US Government Users Restricted Rights - Use, duplication or
  16.  *   disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  17.  *       
  18.  *   IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  19.  *   ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20.  *   PURPOSE. IN NO EVENT SHALL IBM BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  21.  *   CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  22.  *   USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  23.  *   OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
  24.  *   OR PERFORMANCE OF THIS SOFTWARE.
  25.  */
  26. /*====END_GENERATED_PROLOG========================================
  27.  */
  28. /*
  29.     File:        ShPlugIn.h
  30.  
  31.     Contains:    Interface and constants for ShellPlugin Shared Libraries
  32.  
  33.     Owned by: Eric House
  34.  
  35.     Copyright:    ⌐ 1993-95 by Apple Computer, Inc., all rights reserved.
  36.  
  37.     Change History (most recent first):
  38.  
  39.          <5>     9/27/95    eeh        1284893: fix capitalization
  40.          <4>     9/26/95    eeh        1284893: remove macros, fix
  41.                                     kODShellPluginCloseConnection
  42.          <3>     9/19/95    eeh        1284893: add kODShellPluginCloseConnection
  43.                                     etc.
  44.          <2>     9/12/95    eeh        1253309: make ODShellPluginInstallProc
  45.                                     extern 'C'
  46.          <1>     9/11/95    eeh        first checked in
  47.  
  48.     To Do:
  49.     In Progress:
  50.         
  51. */
  52.  
  53. #ifndef _SHPLUGIN_
  54. #define _SHPLUGIN_
  55.  
  56. typedef ODULong ODShellPlugInActionCodes;
  57.  
  58. // action codes.  ODShellPlugInActionCodes is a bit vector.
  59. // Now there is but one action to be turned
  60. // on or off: kODShellPlugInCloseConnection, which asks the Shell to
  61. // close the connection that was opened in order to call the 
  62. // ODShellPlugInInstallProc.  Later we'll add up to 31 others, among
  63. // which kODShellPlugInCallOnShutdown is an obvious candidate.
  64.  
  65. #define kODShellPlugInCloseConnection        1<<0
  66. // others to follow (next is 1<<1, then 1<<2, etc.)
  67.  
  68. // kODShellPlugInNoAction is the value to which action is initalized
  69. // before the ODShellPlugInInstall proc is called.  Clients need only
  70. // set those bits corresponding to actions they want taken on return.
  71. // Leaving them cleared gets them the default behavior: no action.
  72.  
  73. #define kODShellPlugInNoAction        0x00000000
  74.  
  75. #ifdef __cplusplus
  76. extern "C" {
  77. #endif
  78.  
  79. class Environment;
  80. class ODDraft;
  81.  
  82. typedef OSErr (*ODShellPlugInInstallProc)( Environment*,
  83.         ODDraft*, ODShellPlugInActionCodes* );
  84.  
  85. #ifdef __cplusplus
  86. }
  87. #endif
  88.  
  89. #endif
  90.