Files
2024-02-19 00:21:16 -05:00

234 lines
5.0 KiB
Plaintext

.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
.na
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.\".ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
..
.de De
.ce 0
.if \\n(BD .DF
.nr BD 0
.in \\n(OIu
.if \\n(TM .ls 2
.sp \\n(DDu
.fi
..
.de FD
.LP
.KS
.TA .5i 3i
.ta .5i 3i
.nf
..
.de FN
.fi
.KE
.LP
..
.de IN \" send an index entry to the stderr
..
.de C{
.KS
.nf
.D
.\"
.\" choose appropriate monospace font
.\" the imagen conditional, 480,
.\" may be changed to L if LB is too
.\" heavy for your eyes...
.\"
.ie "\\*(.T"480" .ft L
.el .ie "\\*(.T"300" .ft L
.el .ie "\\*(.T"202" .ft PO
.el .ie "\\*(.T"aps" .ft CW
.el .ft R
.ps \\n(PS
.ie \\n(VS>40 .vs \\n(VSu
.el .vs \\n(VSp
..
.de C}
.DE
.R
..
.de Pn
.ie t \\$1\fB\^\\$2\^\fR\\$3
.el \\$1\fI\^\\$2\^\fP\\$3
..
.de ZN
.ie t \fB\^\\$1\^\fR\\$2
.el \fI\^\\$1\^\fP\\$2
..
.de NT
.ne 7
.ds NO Note
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
.ie n .sp
.el .sp 10p
.TB
.ce
\\*(NO
.ie n .sp
.el .sp 5p
.if '\\$1'C' .ce 99
.if '\\$2'C' .ce 99
.in +5n
.ll -5n
.R
..
. \" Note End -- doug kraft 3/85
.de NE
.ce 0
.in -5n
.ll +5n
.ie n .sp
.el .sp 10p
..
.ny0
.TH XClearArea 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
.SH NAME
XClearArea, XClearWindow \- clear area or window
.SH SYNTAX
.\" $Header: XClearArea.f,v 1.1 88/02/26 09:58:46 mento Exp $
XClearArea\^(\^\fIdisplay\fP, \fIw\fP\^, \fIx\fP\^, \fIy\fP\^, \fIwidth\fP\^, \fIheight\fP\^, \fIexposures\fP\^)
.br
Display *\fIdisplay\fP\^;
.br
Window \fIw\fP\^;
.br
int \fIx\fP\^, \fIy\fP\^;
.br
unsigned int \fIwidth\fP\^, \fIheight\fP\^;
.br
Bool \fIexposures\fP\^;
.LP
.\" $Header: XClear.f,v 1.1 88/02/26 09:58:45 mento Exp $
XClearWindow\^(\^\fIdisplay\fP, \fIw\fP\^)
.br
Display *\fIdisplay\fP\^;
.br
Window \fIw\fP\^;
.SH ARGUMENTS
.\" $Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
.IP \fIdisplay\fP 1i
Specifies the connection to the X server.
.\" $Header: exposures.a,v 1.2 88/05/13 07:34:33 mento Exp $
.IP \fIexposures\fP 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 $
.IP \fIw\fP 1i
Specifies the window.
.ds Wh , which are the dimensions of the rectangle
.\" $Header: w+h_gen.a,v 1.2 88/08/04 11:21:28 mento Exp $
.IP \fIwidth\fP 1i
.br
.ns
.IP \fIheight\fP 1i
Specify the width and height\*(Wh.
.ds Xy , which are relative to the origin of the window \
and specify the upper-left corner of the rectangle
.\" $Header: xy_gen.a,v 1.2 88/08/04 11:22:37 mento Exp $
.IP \fIx\fP 1i
.br
.ns
.IP \fIy\fP 1i
Specify the x and y coordinates\*(Xy.
.SH 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.
.LP
.ZN XClearArea
can generate
.ZN BadMatch ,
.ZN BadValue ,
and
.ZN BadWindow
errors.
.LP
.\" $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.
.LP
.ZN XClearWindow
can generate
.ZN BadMatch
and
.ZN BadWindow
errors.
.SH DIAGNOSTICS
.\" $Header: badmatch1.e,v 1.3 87/09/09 18:18:54 mento Exp $
.TP 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 $
.TP 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 $
.TP 1i
.ZN BadWindow
A value for a Window argument does not name a defined Window.
.SH "SEE ALSO"
XCopyArea(3X11)
.br
\fI\*(xL\fP