Retro video games delivered to your door every month!
Click above to get retro games delivered to your door ever month!
X-Hacker.org- Clipper Tools One Guide - <b>wformat()</b> http://www.X-Hacker.org [<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
WFORMAT()

Syntax:     WFORMAT() ([<expN1>,<expN2>,<expN3>,<expN4>])

Arguments:  <expN1>...<expN4> corresponds to the values by which the
            coordinates of the text output area of a selected window will
            be changed.

Returns:    A numeric value.
            The number of the current window selected.

Usage:      This WFORMAT() function can be used to reduce the area in
            which the text output will occur compared to the actual area
            of the window.  It is also possible to define a margin between
            the text area and the edges of a window that is to remain
            blank.  The four arguments denote the distance  between
            the old edge and the output area respectively in the order
            top row, left-hand column, bottom row and right-hand column.

Note:       The sum of values <expN1>...<expN3> must not
            exceed the internal height of the window, while the sum of
            <expN1>...<expN3> must not exceed the internal width.
            Negative values will increase the output area, whereas
            positive values will reduce it.  A WFORMAT() with no
            arguments will reset the format and remove any previous
            WFORMAT() settings.  The function can not be used with the
            physical screen (window 0).  Alternatively, it is possible
            to use negative line values in @...SAY in order to be able to
            write only one output line in the margin (for example a title:
            @ -1,5 SAY "Aid to input").

Library:    CT1.LIB


--------------------------------- Example ------------------------------

Examples:   window_no = 5
            WSELECT(window_no)
            WFORMAT(1,2,1,2)


            *   The function  will reduce the output area of
            *   the window selected at top and bottom by one
            *   row in each case, and left-hand and
            *   right-hand sides by two columns in each
            *   case.  The area will therefore be reduced by
            *   two rows and four columns.

            WFORMAT(-100,-100,-100,-100,)

            *   All the edges set previously by WFORMAT()
            *   will in this case be cancelled, although it
            *   will be possible to write within the whole
            *   window again.



See Also: WBOX() WSELECT()

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