XIconifyWindow(3X) XIconifyWindow(3X)
NAME
XIconifyWindow, XWithdrawWindow, XReconfigureWMWindow -
manipulate top-level windows
SYNOPSIS
Status XIconifyWindow(display, w, screen-number)
Display *display;
Window w;
int screen-number;
Status XWithdrawWindow(display, w, screen-number)
Display *display;
Window w;
int screen-number;
Status XReconfigureWMWindow(display, w, screen-number,
value-mask, values)
Display *display;
Window w;
int screen-number;
unsigned int value-mask;
XWindowChanges *values;
DESCRIPTION
The XIconifyWindow function sends a WM_CHANGE_STATE
ClientMessage event with a format of 32 and a first data
element of IconicState (as described in Section 4.1.4 of the
Inter-Client Communication Conventions Manual) to the root
window of the specified screen. Window managers may elect
to receive this message and, if the window is in its normal
state, may treat it as a request to change the window's
state from normal to iconic. If the WM_CHANGE_STATE proper-
ty cannot be interned, XIconifyWindow does not send a mes-
sage and returns a zero status. It returns a nonzero status
if the client message is sent successfully; otherwise, it
returns a zero status.
The XWithdrawWindow function unmaps the specified window and
sends a synthetic UnmapNotify event to the root window of
the specified screen. Window managers may elect to receive
this message and may treat it as a request to change the
window's state to withdrawn. When a window is in the with-
drawn state, neither its normal nor its iconic representa-
tions is visible. It returns a nonzero status if the Unmap-
Notify event is successfully sent; otherwise, it returns a
zero status.
The XReconfigureWMWindow function issues a ConfigureWindow
request on the specified top-level window. If the stacking
mode is changed and the request fails with a BadMatch error,
the error event is trapped and a synthetic ConfigureRe-
questEvent containing the same configuration parameters is
November, 1990 1
XIconifyWindow(3X) XIconifyWindow(3X)
sent to the root of the specified window. Window managers
may elect to receive this event and treat it as a request to
reconfigure the indicated window.
Arguments
These functions accept the following arguments:
display Specifies the connection to the X server.
screen-number
Specifies the appropriate screen number on the host
server.
value-mask
Specifies which values are to be set using informa-
tion in the values structure. This mask is the bit-
wise inclusive OR of the valid configure window
values bits.
values Specifies a pointer to the XWindowChanges structure.
8 w Specifies the window.
ERRORS
BadMatch
An argument or pair of arguments has the correct
type and range but fails to match in some other re-
quired way.
BadValue
Some 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 XIconifyWindow and XWithdrawWindow functions can gen-
erate a BadWindow error.
The XReconfigureWMWindow function can generate BadValue and
BadWindow errors.
SEE ALSO
XChangeWindowAttributes(3X), XConfigureWindow(3X),
XCreateWindow(3X), XDestroyWindow(3X), XRaiseWindow(3X),
XMapWindow(3X), XUnmapWindow(3X)
2 November, 1990
Inter-Client Communication Conventions Manual
Xlib - C Language Interface
November, 1990 3