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