1 03/19/85  cb_window_
  2 
  3 
  4 This is the basic video interface subroutine to be used by COBOL to
  5 create/destroy/change windows.  (If usage-mode = 0 (see cb_menu_$init2)
  6 this subroutine should not be called.)
  7 
  8 
  9 Entry points in cb_window_:
 10    (List is generated by the help command)
 11 
 12 
 13 :Entry:  change:  03/19/85 cb_window_$change
 14 
 15 
 16 Function:  This entry points provides a facility for changing the size
 17 of an existing window.  The size of a window can always be "shrunk",
 18 however it can be increased only it does not overlap with another
 19 defined window.  (If usage-mode = 0 (see cb_menu_$init2) this entry
 20 point should not be called.)
 21 
 22 
 23 Syntax:
 24    declarations:
 25      77  window-id   USAGE IS COMP-6.
 26      77  first-line  USAGE IS COMP-6.
 27      77  height      USAGE IS COMP-6.
 28      77  ret-code    USAGE IS COMP-6.
 29      call "cb_window_$change" USING window-id, first-line, height,
 30           ret-code.
 31 
 32 
 33 Arguments:
 34 window-id
 35    window identifier returned by cb_window_$create.  (Input)
 36 first-line
 37    new first line number for the window being changed.  (Input) A
 38    positive value.
 39 height
 40    new height for the window being changed.  (Input) A positive value.
 41 ret-code
 42    return code.  (Output)
 43 
 44 
 45 :Entry:  clear_window:  03/19/85 cb_window_$clear_window
 46 
 47 
 48 Function:  Used to clear a specified window.
 49 
 50 
 51 Syntax:
 52    declarations:
 53      77  window-id      USAGE IS COMP-6.
 54      77  ret-code       USAGE IS COMP-6.
 55      call "cb_window_$clear_window" USING  window-id, ret-code.
 56 
 57 
 58 Arguments:
 59 window-id
 60    the window identifier (returned by cb_window_$create) of the window
 61    to be cleared.  (Input)
 62 ret-code
 63    return code.  (Output)
 64 
 65 
 66 :Entry:  create:  03/19/85 cb_window_$create
 67 
 68 
 69 Function:  This entry is used to create a new window on the terminal
 70 screen.  (If usage-mode = 0 (see cb_menu_$init2) this entry point
 71 should not be called.)
 72 
 73 
 74 Syntax:
 75    declarations:
 76      77  switch-name    PIC X(32).
 77      77  first-line     USAGE IS COMP-6.
 78      77  height         USAGE IS COMP-6.
 79      77  window-id      USAGE IS COMP-6.
 80      77  ret-code       USAGE IS COMP-6.
 81      call "cb_window_$create" USING first-line, height, switch-name,
 82           window-id, ret-code.
 83 
 84 
 85 Arguments:
 86 first-line
 87    is the line number where the window is to start.  (Input)
 88 height
 89    the number of lines used by the window, i.e., its height.  (Input)
 90 switch-name
 91    the  name  that  the caller  wishes  to associate  with  the switch.
 92    (Input)
 93 window-id
 94    the returned id of the window just created.  (Output) It must not be
 95    altered in any way by the application program.
 96 ret-code
 97    return code.  (Output)
 98 
 99 
100 :Entry:  destroy:  03/19/85 cb_window_$destroy
101 
102 
103 Function:  Used to destroy a previously created window.  (If usage-mode
104 = 0 (see cb_menu_$init2) this entry point should not be called.)
105 
106 
107 Syntax
108    declarations:
109      77  window-id   USAGE IS COMP-6.
110      77  ret-code    USAGE IS COMP-6.
111      call "cb_window_$destroy"  USING  window-id, ret-code.
112 
113 
114 Arguments:
115 window-id
116    window    identifier    (returned    by    the   cb_window_$create).
117    (Input/Output) It is reset to an illegal value by this call.
118 ret-code
119    return code.  (Output)