home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / TSXPLUG.H < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  4.2 KB  |  119 lines
  1. //******************************************************************************
  2. //    File: tsxplug.h
  3. //  Module: trueSpace eXtensions Installation Interface
  4. //
  5. //******************************************************************************
  6.  
  7. #ifndef TSXPLUG_H
  8. #define TSXPLUG_H
  9.  
  10. //------------------------------------------------------------------------------
  11. //    tsxData
  12. //------------------------------------------------------------------------------
  13.  
  14. // Every trueSpace eXtension must define a function (see below) that returns
  15. // information about the eXtension in the following `tsxData' structure.
  16.  
  17. struct tsxData
  18. {
  19.     char  m_Title[32];    //Brief name of this eXtension.
  20.     char  m_Author[64]; //Name of author|company.
  21.     short m_ResidBtnBmp;  //Resource id used for Button Bitmap
  22.     short m_ResidBtnHelp; //Resource id used for Button Help Message
  23. };
  24.  
  25. #ifndef __cplusplus
  26. typedef struct tsxData tsxData;
  27. #endif
  28.  
  29. // Each ts-eXtension will be associated with a button in the trueSpace
  30. // interface. This requires:
  31. //     - a bitmap (m_ResidBtnBmp), 34x34 pixels, 256 colors.
  32. //     - and a brief help message (m_ResidBtnHelp) that gets
  33. //       displayed on the status bar when a cursor moves over the button.
  34.  
  35.  
  36. //------------------------------------------------------------------------------
  37. //    TSX API Version Info
  38. //------------------------------------------------------------------------------
  39.  
  40. // This is the version number for this copy of the API (SDK).
  41. // To check the version number of an installed trueSpace, see "tsxMisc.h".
  42.  
  43. // Base alpha minor-version nbr
  44. #define tsxVERSION_ALPHA_BASE -200
  45. // Base beta minor-version nbr
  46. #define tsxVERSION_BETA_BASE  -100
  47.  
  48. #define tsxVERSION_MAJOR    ((short) 320)
  49. #define tsxVERSION_MINOR    ((short) 4)
  50.  
  51. //------------------------------------------------------------------------------
  52. //    Access function names
  53. //------------------------------------------------------------------------------
  54.  
  55. #define tsxGetData    tsxGetData
  56. #define tsxOnLeftClick  tsxOnLeftClick
  57. #define tsxOnRightClick tsxOnRightClick
  58.  
  59. #define FUNCNAME( x )  #x
  60. #define TSX_GDFNAME FUNCNAME( tsxGetData )
  61. #define TSX_LCFNAME FUNCNAME( tsxOnLeftClick )
  62. #define TSX_DAFNAME FUNCNAME( tsxDeactivate )
  63. #define TSX_RCFNAME FUNCNAME( tsxOnRightClick )
  64.  
  65. //------------------------------------------------------------------------------
  66. //    Access function Return Values
  67. //------------------------------------------------------------------------------
  68.  
  69. #define tsxPLUG_DONE       0
  70. #define tsxPLUG_FAILED    -1
  71. #define tsxPLUG_STAYON     1
  72.  
  73. //------------------------------------------------------------------------------
  74. //    Access function declarations
  75. //------------------------------------------------------------------------------
  76.  
  77. // Every ts-eXtension must define the following functions.
  78.  
  79. extern "C" {
  80.  
  81. // Function type for getting tsxData
  82. typedef int (*tsxGetDataFP)(tsxData*, int);
  83. // And the function ... copies data into supplied struct.
  84. // `tsxid' is the id assigned to this extension while it is installed.
  85. // You can use this function to initialize the eXtension, 
  86. // and check version compatibility.
  87. // Return: 
  88. //  tsxPLUG_DONE = successful install and initialization of this eXtension.
  89. //  tsxPLUG_FAILED = failed - do not install.
  90. int tsxGetData( tsxData* tsx_data, int tsxid );
  91.  
  92. // Function type for Left-click on eXtension button.
  93. // Invokes the eXtension.
  94. typedef int (*tsxOnLeftClickFP)(void);
  95. // And the function.
  96. // Return:
  97. //  tsxPLUG_STAYON = Keep button enabled, as eXtension stays active.
  98. //  tsxPLUG_DONE = eXtension work completed, return to normal tS interface mode.
  99. int tsxOnLeftClick(void);
  100.  
  101. // Function type for deactivating an active extension
  102. typedef void (*tsxDeactivateFP)(void);
  103. // And the function.
  104. // This function called to deactivate an eXtension that requested staying
  105. // activated thru `tsxOnLeftClick' returning `tsxPLUG_STAYON'.
  106. void tsxDeactivate(void);
  107.  
  108. // Function type for Right-click on eXtension button.
  109. // Invokes eXtension Parameter / About window.
  110. typedef void (*tsxOnRightClickFP)(void);
  111. // And the function.
  112. void tsxOnRightClick(void);
  113.  
  114. }
  115.  
  116.  
  117. //******************************************************************************
  118. #endif // TSXPLUG_H
  119.