Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- FreshWin (c) Fresh Technologies - <b>wclear() window function</b> http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
  WCLEAR()                                                   Window Function
 Purpose..: Clear an entire window, one line or an area
-------------------------------------------------------------------------------
 Syntax...: wClear( [<uWin> [, <nT> [, <nL> [,
                       <nB> [, <nR> [, <cClr>]]]]]] ) --> 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, wClear() will
                       will clear only one line rather than the entire
                       windows text area. If <nB> is passed wClear()
                       will clear FROM row <nT> TO row <nB>.
                       If not passed, the default is to the window's row 0.

            [<nL>]   = Relative right 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.
                       If not passed, the default is to the window's
                       bottom row.

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

            [<cClr>] = color to display in cleared area.

 Returns..: NIL

 Remark...: Clears all window text area, one line or an area. When
            clearing an entire window's text area, the relative row
            and column positions are zeroed out.

            The function works whether the window is open or not. But it
            is important to remind you that if you use a window for more
            that one purpose, clear it. Otherwise, what was there before
            will appear when opened for the next purpose. As we have
            discovered, not clearing is a real annoyance with TBrowse.

 Source...:   WCLEAR.PRG
-------------------------------------------------------------------------------
 Example..: . The example will clear portions of the window.

            wClear( ,1 )      // Clears line number one.
            wClear( ,2,,4 )   // Clears lines two to four.
            wClear()          // Clears entire window viewport.

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

See Also: Cls() ClsAt() wScroll()

Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson