home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 5 / 05.iso / a / a524 / 33.ddi / lib / iapuxw.h < prev    next >
Encoding:
C/C++ Source or Header  |  1991-03-04  |  4.3 KB  |  139 lines
  1. /*
  2.  * $Header: iapuxw.h,v 3000600.1 89/04/25 12:35:29 rcs Exp $ iapuxw.h Copyr (c) 1989 Oracle
  3.  */
  4.  
  5. /* SQLFORMS3030006,DUA11:[FREEZE_SQLFORMS30.UTILH.30006] */
  6. /* Copyright (c) 1988 by Oracle Corporation */
  7.  
  8. /* NAME
  9.      iapuxw - User eXit Windows
  10.  
  11.    FUNCTION
  12.      Externalization of user exit pop-up routines.  
  13.  
  14.      Because this is an external routine, we use generic C data types
  15.      instead of Oracle data types.  That makes this module an OSD 
  16.      modules, so Porters take note.
  17.  
  18.    RETURN
  19.      These routines return an error code if there is any problem
  20.      manipulating the windows.  These are defined below.
  21.  
  22.    NOTES
  23.  
  24.    MODIFIED
  25.     Vijayar    04/04/89 - Lint
  26.     Vijayar    03/31/89 - Lint
  27.     Blinn      03/20/89 - Wrong area
  28.     Blinn      03/01/89 - Creation
  29.     Blinn      02/24/89 - Creation
  30.      Blinn      02/23/89 - Created.
  31. */
  32.  
  33. #ifndef IAPUXW
  34. #define IAPUXW
  35.  
  36. /*****************************************************************/
  37. /* Return codes for the various functions                        */
  38.  
  39. #define UXW_SUCCESS                   0
  40. #define UXW_WIN_EXISTS                1
  41. #define UXW_WIN_NONEXISTENT           2
  42.  
  43. /****************************************************************/
  44. /* Window data type is a uxwind.  It is the clients             */
  45. /* responsibility to maintain his window pointers.              */
  46. typedef char * uxwind;
  47.  
  48. /****************************************************************/
  49. /* Prototypes for the various windowing functions               */
  50.  
  51. /*
  52. ** UXWADD -- User WIndowing ADD a window
  53. **    Creates a window. The window is 
  54. **    located at x,y on the screen and has size h,v.  The window will have
  55. **    a border if border is non-0 (TRUE).  Damage is a callback function
  56. **    supplied by the user which will be called whenever damage
  57. **    occurs within a window.  It is the clients responsibility to provide
  58. **    this function and repair the window whenever necessary.  This
  59. **    function will be given a pointer to the user-window, the x,y,h,v 
  60. **    defining the damaged region, and a client supplied parameter.
  61. */
  62. extern uxwind uxwadd( /*_ int, int, int, int,  bool,
  63.          void (*)(char *, int, int, int, int, char *), char * _*/ );
  64.  
  65.  
  66. /*
  67. ** UXWREM -- User eXit Windowing REMOVE
  68. **    Deletes a window if it exists.  Returns the appropriate error
  69. **    code.  This will also hide and dispose of the window.
  70. */
  71. extern int uxwrem( /*_ uxwind  _*/ );
  72.  
  73.  
  74. /*
  75. ** UXWSHO -- User eXit Windowing SHOw a window
  76. **    Shows a window, Simply a
  77. **    mapping function. Note that this will cause the damage function to
  78. **    be called.
  79. */
  80. extern int uxwsho( /*_ uxwind  _*/ );
  81.  
  82. /*
  83. ** UXWHID -- User eXit Windowing HIDe
  84. **   Hides a window (unmaps).  Note that this will cause the damage functions
  85. **   to be called on any previously occluded windows.
  86. */
  87. extern int uxwhid( /*_ uxwind  _*/ );
  88.  
  89.  
  90. /*
  91. ** UXWPOP -- User eXit Windowing POP to the top
  92. **    Raises the window to the top of all windows on the screen.
  93. **    Note that this may cause the damage function to be called.
  94. */
  95. extern int uxwpop( /*_ uxwind  _*/ );
  96.  
  97. /*
  98. ** UXWGXY -- User eXit Window Goto XY
  99. **    Sends the internal cursor of the window to X,Y.  If the window is
  100. **    activated, the cursor for that window will be displayed at that
  101. **    location of the window (if not occluded....otherwise will display
  102. **    the cursor at the bottom right hand corner of the screen).  Note this
  103. **    only applies to character mode, as other devices have no cursor.
  104. */
  105. extern int uxwgxy( /*_ uxwind, int, int _*/ );
  106.  
  107.  
  108. /*
  109. ** UXWPUS -- User eXit Window PUt String
  110. **    Puts a string of characters at the given location in the window. 
  111. **    The string need not be NULL terminated, but the length must be
  112. **    specified.
  113. */
  114. extern int uxwpus( /*_ uxwind, char *, int, int, int _*/ );
  115.  
  116. /*
  117. ** UXWPUC -- User eXit Window PUt Character
  118. **    Puts a character in a window at the specified x,y location.
  119. */
  120. extern int uxwpuc( /*_ uxwind, char, int, int _*/ );
  121.  
  122. /*
  123. ** UXWMOV -- User eXit Window MOVe
  124. **   Moves the specified window to the location x,y on the screen.
  125. **   Note that this may cause the damage function to be called.
  126. */
  127. extern int uxwmov( /*_ uxwind, int, int, _*/ );
  128.  
  129. /*
  130. ** UXWACT -- User eXit Windowing ACTivate
  131. **    Causes the cursor to be displayed in that window.  The cursor will
  132. **    be sent back to the active IAP window when the user-exit is finished.
  133. */
  134. extern int uxwact( /*_ uxwind  _*/ );
  135.  
  136. #endif
  137.  
  138.  
  139.