xref: /386bsd/usr/X386/man/man3/XClearArea.3x (revision a2142627)
.\\$1D \\$2 \\$1
.ps \\n(PS
.if \\n(VS>=40 .vs \\n(VSu
.if \\n(VS<=39 .vs \\n(VSp
..

0 .nr BD 0

..

.KS .TA .5i 3i

..
.KE

.. .. .KS

.D

choose appropriate monospace font
the imagen conditional, 480,
may be changed to L if LB is too
heavy for your eyes...

.. .R .. .. .. .TB

\\*(NO .R .. . \" Note End -- doug kraft 3/85

0 .. .ny0

XClearArea 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
NAME
XClearArea, XClearWindow - clear area or window
SYNTAX
$Header: XClearArea.f,v 1.1 88/02/26 09:58:46 mento Exp $
XClearArea\^(\^display, w\^, x\^, y\^, width\^, height\^, exposures\^)

Display *display\^;

Window w\^;

int x\^, y\^;

unsigned int width\^, height\^;

Bool exposures\^;

$Header: XClear.f,v 1.1 88/02/26 09:58:45 mento Exp $
XClearWindow\^(\^display, w\^)

Display *display\^;

Window w\^;

ARGUMENTS
$Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
display 1i
Specifies the connection to the X server. $Header: exposures.a,v 1.2 88/05/13 07:34:33 mento Exp $
exposures 1i
Specifies a Boolean value that indicates if .ZN Expose events are to be generated. $Header: w.a,v 1.2 88/05/07 11:35:31 mento Exp $
w 1i
Specifies the window. $Header: w+h_gen.a,v 1.2 88/08/04 11:21:28 mento Exp $
width 1i

.ns

height 1i
Specify the width and height\*(Wh. and specify the upper-left corner of the rectangle $Header: xy_gen.a,v 1.2 88/08/04 11:22:37 mento Exp $
x 1i

.ns

y 1i
Specify the x and y coordinates\*(Xy.
DESCRIPTION
$Header: XClearArea.d,v 1.3 88/08/18 08:25:30 mento Exp $
The .ZN XClearArea function paints a rectangular area in the specified window according to the specified dimensions with the window's background pixel or pixmap. The subwindow-mode effectively is .ZN ClipByChildren . If width is zero, it is replaced with the current width of the window minus x. If height is zero, 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 .ZN None , the contents of the window are not changed. In either case, if exposures is .ZN True , one or more .ZN Expose events are generated for regions of the rectangle that are either visible or are being retained in a backing store. If you specify a window whose class is .ZN InputOnly , a .ZN BadMatch error results.

.ZN XClearArea can generate .ZN BadMatch , .ZN BadValue , and .ZN BadWindow errors.

$Header: XClear.d,v 1.2 88/06/11 07:49:21 mento Exp $
The .ZN XClearWindow function clears the entire area in the specified window and is equivalent to .ZN XClearArea (display, w, 0, 0, 0, 0, .ZN False ). If the window has a defined background tile, the rectangle is tiled with a plane-mask of all ones and .ZN GXcopy function. If the window has background .ZN None , the contents of the window are not changed. If you specify a window whose class is .ZN InputOnly , a .ZN BadMatch error results.

.ZN XClearWindow can generate .ZN BadMatch and .ZN BadWindow errors.

DIAGNOSTICS
$Header: badmatch1.e,v 1.3 87/09/09 18:18:54 mento Exp $

1i .ZN BadMatch An .ZN InputOnly window is used as a Drawable. $Header: badvalue.e,v 1.1 87/09/04 08:23:19 mento Exp $

1i .ZN BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified 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. $Header: badwindow.e,v 1.1 87/09/04 08:23:20 mento Exp $

1i .ZN BadWindow A value for a Window argument does not name a defined Window.

"SEE ALSO"
XCopyArea(3X11)

\*(xL