/sys$common/syshlp/TPUHELP.HLB  —  SCROLL
  SCROLL

  Scrolls text in the current buffer up or down on the screen by the number
  of lines specified.  The cursor stays at at the same relative screen
  location.

  Syntax

     [integer1 :=] SCROLL (window [,integer2])

  Parameters

     window     The window associated with the buffer whose text you want to
                scroll.

     integer    The number of lines you want the text to scroll.  Positive
                values cause the text to scroll up (toward the top of the
                screen).  Negative values cause the text to scroll down
                (toward the bottom of the screen.) If you specify 0, no
                scrolling occurs.

  Comments

  The current character position will be different from the character
  position that was current before you issued the SCROLL built-in.

  SCROLL optionally returns (integer1) the number and direction of lines
  actually scrolled:  A negative value indicates the number of lines
  scrolled up; a positive value indicates the number of lines scrolled down.
  (This value may be different from what you specified in integer2.)

  If you omit integer2, the text is scrolled in the current direction of the
  buffer until you press a key.  Commands or procedures bound to that key
  are executed.  In forward direction, scrolling continues until the end of
  the buffer or a key press; in reverse direction, until the beginning of
  the buffer or a key press.

  Examples

  1.  SCROLL (main_window, +10);

      Scrolls text up 10 lines.

  2.  SET (FORWARD, my_buffer);
      SCROLL (my_window);

      Scrolls up the text in MY_BUFFER (mapped to MY_WINDOW) until the end
      of the buffer is reached or until you a key is pressed.

  Related topics

     SET(CROSS_WINDOW_BOUNDS)   SET(FORWARD)   SET(REVERSE)   SET(SCROLLING)
Close Help