XClearArea(3X)                                     XClearArea(3X)



NAME
     XClearArea, XClearWindow - clear windows

SYNOPSIS
     XClearArea (display, w, x, y, width, height,
     exposures)
     Display *display;
     Window w;
     int x,y;
     unsigned int width, height;
     Bool exposures;

     XClearWindow (display, w)
     Display *display;
     Window w;

DESCRIPTION
     The XClearArea function paints a rectangular area in the
     specified window according to the specified dimensions with
     the window's background pixel or pixel map.  The subwindow-
     mode effectively is ClipByChildren.  If width is 0, it is
     replaced with the current width of the window minus x.  If
     height is 0, it is replaced with the current height of the
     window minus y.  If the window has a defined background
     tile, the rectangle clipped by any children is filled with
     this tile.  If the window has background None, the contents
     of the window are not changed. In either case, if exposures
     is TRUE, one or more Expose events are generated for regions
     of the rectangle that are either visible or are being re-
     tained in a backing store.  If you specify a window whose
     class is InputOnly, a BadMatch error results.

     The XClearWindow function clears the entire area in the
     specified window and is equivalent to

        XClearArea(display, w, 0, 0, 0, 0, FALSE)

     If the window has a defined background tile, the rectangle
     is tiled with a plane-mask of all 1s and GXcopy function.
     If the window has background None, the contents of the win-
     dow are not changed. If you specify a window whose class is
     InputOnly, a BadMatch error results.

   Arguments
     These functions accept the following arguments:

     display Specifies the connection to the X server.

     exposures
             Specifies a Boolean value of TRUE or FALSE that in-
             dicates if Expose events are to be generated.




November, 1990                                                  1

XClearArea(3X)                                     XClearArea(3X)



     w       Specifies the window ID.

     width, height
             Specify the width and height, which are the dimen-
             sions of the rectangle.

     x, y    Specify the x and y coordinates, which are relative
             to the origin of the window and specify the upper-
             left corner of the rectangle.

ERRORS
     BadMatch
             An InputOnly window is used as a drawable.

     BadValue
             A numeric value falls outside the range of values
             accepted by the request.  Unless a range is speci-
             fied for an argument, the full range defined by the
             argument's type is accepted.  Any argument defined
             as a set of alternatives can generate this error.

     BadWindow
             A value for a Window argument does not name a de-
             fined window.

     The XClearArea function can generate BadMatch,
     BadValue, and BadWindow errors.

     The XClearWindow function can generate BadMatch and BadWin-
     dow errors.

SEE ALSO
     XCopyArea(3X)

     Xlib - C Language Interface





















2                                                  November, 1990