NAME
XClearArea, XClearWindow - clear area or window
SYNTAX
int XClearArea(Display *_d_i_s_p_l_a_y, Window _w, int _x,
int _y, unsigned _w_i_d_t_h, unsigned _h_e_i_g_h_t,
Bool _e_x_p_o_s_u_r_e_s);
int XClearWindow(Display *_d_i_s_p_l_a_y, Window _w);
ARGUMENTS
-
_d_i_s_p_l_a_y
Specifies the connection to the X server.
-
-
_e_x_p_o_s_u_r_e_s
Specifies a Boolean value that indicates if
-
_E_x_p_o_s_e
events are to be generated.
-
_w
Specifies the window.
-
-
_w_i_d_t_h
-
-
_h_e_i_g_h_t
Specify the width and height, which are the dimensions of the rectangle.
-
and specify the upper-left corner of the rectangle
-
_x
-
-
_y
Specify the x and y coordinates, which are relative to the origin of the window .
-
DESCRIPTION
The
_X_C_l_e_a_r_A_r_e_a
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
_C_l_i_p_B_y_C_h_i_l_d_r_e_n.
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
_N_o_n_e,
the contents of the window are not changed.
In either
case, if exposures is
_T_r_u_e,
one or more
_E_x_p_o_s_e
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
_I_n_p_u_t_O_n_l_y,
a
_B_a_d_M_a_t_c_h
error results.
_X_C_l_e_a_r_A_r_e_a
can generate
_B_a_d_M_a_t_c_h,
_B_a_d_V_a_l_u_e,
and
_B_a_d_W_i_n_d_o_w
errors.
The
_X_C_l_e_a_r_W_i_n_d_o_w
function clears the entire area in the specified window and is
equivalent to
_X_C_l_e_a_r_A_r_e_a
(display, w, 0, 0, 0, 0,
_F_a_l_s_e).
If the window has a defined background tile, the rectangle is tiled with a
plane-mask of all ones and
_G_X_c_o_p_y
function.
If the window has
background
_N_o_n_e,
the contents of the window are not changed.
If you specify a window whose class is
_I_n_p_u_t_O_n_l_y,
a
_B_a_d_M_a_t_c_h
error results.
_X_C_l_e_a_r_W_i_n_d_o_w
can generate
_B_a_d_M_a_t_c_h
and
_B_a_d_W_i_n_d_o_w
errors.
DIAGNOSTICS
-
_B_a_d_M_a_t_c_h
-
An
_I_n_p_u_t_O_n_l_y
window is used as a Drawable.
-
_B_a_d_V_a_l_u_e
-
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.
-
_B_a_d_W_i_n_d_o_w
-
A value for a Window argument does not name a defined Window.
SEE ALSO
XCopyArea(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e