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

  WCLOSE()                                                   Window Function
 Purpose..: Close an window in focus
-------------------------------------------------------------------------------
 Syntax...: wClose( [<uWin> [, <bHow>]] ) --> 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.

            [<bHow>] = code block used as a closing method
                       to override that defined originally. You
                       can use one of FreshWin's pre-defined
                       methods or create one of your own. Using
                       one of the supplied methods, the
                       delay rate can be set, the lower the value
                       the faster the method will execute.

            bHow Translate Directive as found in FW_BOX.CH
            ---------------------------------------------------------
            FW_BOX.CH         Description
            ---------------------------------------------------------
            B_IMPLODEDN( n )  Implode from the top down;      delay n
            B_IMPLODEUP( n )  Implode from the bottom up;     delay n
            B_IMPLODERT( n )  Implode from right to left;     delay n
            B_IMPLODELT( n )  Implode from left to right;     delay n
            B_VBLIND( n )     Use a vertical blind effect;    delay n
            B_IMPLODE( n )    Implode the window to center;   delay n
            ---------------------------------------------------------
            B_EXPLODEDN( n )  Explode from the top down;      delay n
            B_EXPLODEUP( n )  Explode from the bottom up;     delay n
            B_EXPLODERT( n )  Explode from right to left;     delay n
            B_EXPLODELT( n )  Explode from left to right;     delay n
            B_EXPLODE( n )    Explode the window from center; delay n
            ---------------------------------------------------------

 Returns..: NIL

 Remark...: If you use wZoom(), the function will remember the size
            of the window. Thus, if plans call for the window to be
            reopened, it will appear in the state it was when closed.

            If you close the window by clicking the mouse on the closing
            icon (.) and you have used wClose(), remember the command is
            still active. You must name the window in wClose().
            Otherwise, the command will be applied to the window opened
            immediately before the one clicked closed.

            The delay rate is not hardware-related. Rather it is a
            sliding scale to allow you to vary the delay in closing
            or opening. A rate of, say, 30, will be no faster
            on a '486 than it would be on a '286 machine.

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

 Source...: WCLOSE.PRG
-------------------------------------------------------------------------------
 Example..: . The example closes the window in focus with its
              originally defined closing method, say, B_IMPLODEDN( 35 ).

            wNew     ( "MyWin" )
            wHowClose( "MyWin", B_IMPLODEDN( 35 ) )
            ...
            wOpen ( "MyWin" )
            ...
            wClose()

            . The example overrides the pre-defined closing effect,
              B_IMPLODEDN( 35 ), to implode the window off the screen.

            wOpen ( "MyWin" )
            ...
            wClose( , B_IMPLODE( 60 ) )