Click above to get retro games delivered to your door ever month!

  WSCROLL()                                                  Window Function
 Purpose..: Scroll an entire window, one line or an area
-------------------------------------------------------------------------------
 Syntax...: wScroll( [<uWin> [, <nT>, [<nL>,
                       [<nB>, [<nR>]]]]], <nDir> ) --> NIL

 Arguments: [<uWin>] = the string identifier of the window
                       OR the reference to the window structure
                       returned as an array by wNew() or wArray().
                       If not passed, the function will operate on
                       the window in focus.

            [<nT>]   = Relative row address. If passed, wScroll()
                       will scroll only one line rather than the entire
                       window text area. If <nB> is passed wScroll()
                       will scroll FROM row <nT> TO row <nB>.

            [<nL>]   = Relative left column address. If not passed,
                       the default is to the window's column 0.

            [<nB>]   = If passed, this will act as the TO window row.

            [<nR>]   = Relative right column address. If not passed,
                       the default is to the window's far left column.

            <nDir>   = The direction to scroll. To go up, use a
                       positive value and a negative one to scroll
                       down.

 Returns..: NIL

 Remark...: Scrolls all of a window text area, one line
            or an area. When scrolling an entire window's text area,
            the relative row and column positions are zeroed out.
            The function works predictably ONLY on the
            open window in focus.

 Source...: WSCROLL.PRG
-------------------------------------------------------------------------------
 Example..:.The example will scroll portions of the window
            up one line, wait half a second and then scroll
            up another line. This takes place after centering
            a sentence in the window and pausing half of a
            second.

   wPutC( ,wLength(), "The routine can copy files onto your PC." )
   inkey( .5 ) ; wScroll( ,,,,,1 )
   inkey( .5 ) ; wScroll( ,,,,,1 )

            As with all FreshWin window functions that alter the display,
            this function hides and redisplays automatically the mouse
            cursor if it is active.