1XIconifyWindow(3)               XLIB FUNCTIONS               XIconifyWindow(3)
2
3
4

NAME

6       XIconifyWindow, XWithdrawWindow, XReconfigureWMWindow - manipulate top-
7       level windows
8

SYNTAX

10       Status XIconifyWindow(Display *display, Window w, int screen_number);
11
12       Status XWithdrawWindow(Display *display, Window w, int screen_number);
13
14       Status XReconfigureWMWindow(Display *display, Window w, int screen_num‐
15              ber, unsigned int value_mask, XWindowChanges *values);
16

ARGUMENTS

18       display   Specifies the connection to the X server.
19
20       screen_number
21                 Specifies the appropriate screen number on the host server.
22
23       value_mask
24                 Specifies which values are to be set using information in the
25                 values structure.  This mask is the bitwise inclusive  OR  of
26                 the valid configure window values bits.
27
28       values    Specifies the XWindowChanges structure.
29
30       w         Specifies the window.
31

DESCRIPTION

33       The XIconifyWindow function sends a WM_CHANGE_STATE ClientMessage event
34       with a format of 32  and  a  first  data  element  of  IconicState  (as
35       described  in  section  4.1.4 of the Inter-Client Communication Conven‐
36       tions Manual) and a window of w to the root  window  of  the  specified
37       screen  with  an event mask set to SubstructureNotifyMask| Substructur‐
38       eRedirectMask.  Window managers may elect to receive this  message  and
39       if  the  window  is  in  its normal state, may treat it as a request to
40       change  the  window's  state   from   normal   to   iconic.    If   the
41       WM_CHANGE_STATE  property  cannot  be interned, XIconifyWindow does not
42       send a message and returns a zero status.  It returns a nonzero  status
43       if  the  client  message  is sent successfully; otherwise, it returns a
44       zero status.
45
46       The XWithdrawWindow function unmaps the specified window  and  sends  a
47       synthetic UnmapNotify event to the root window of the specified screen.
48       Window managers may elect to receive this message and may treat it as a
49       request to change the window's state to withdrawn.  When a window is in
50       the withdrawn state, neither its normal nor its iconic  representations
51       is  visible.   It  returns a nonzero status if the UnmapNotify event is
52       successfully sent; otherwise, it returns a zero status.
53
54       XWithdrawWindow can generate a BadWindow error.
55
56       The XReconfigureWMWindow function issues a ConfigureWindow  request  on
57       the  specified  top-level  window.  If the stacking mode is changed and
58       the request fails with a BadMatch error, the error is trapped  by  Xlib
59       and a synthetic ConfigureRequestEvent containing the same configuration
60       parameters is sent to the root of the specified  window.   Window  man‐
61       agers  may  elect  to  receive  this event and treat it as a request to
62       reconfigure the indicated window.  It returns a nonzero status  if  the
63       request  or  event  is  successfully sent; otherwise, it returns a zero
64       status.
65
66       XReconfigureWMWindow can generate BadValue and BadWindow errors.
67

DIAGNOSTICS

69       BadValue  Some numeric value falls outside the range of values accepted
70                 by  the request.  Unless a specific range is specified for an
71                 argument, the full range defined by the  argument's  type  is
72                 accepted.   Any argument defined as a set of alternatives can
73                 generate this error.
74
75       BadWindow A value for a Window argument does not name a defined Window.
76

SEE ALSO

78       XChangeWindowAttributes(3), XConfigureWindow(3), XCreateWindow(3), XDe‐
79       stroyWindow(3), XRaiseWindow(3), XMapWindow(3), XUnmapWindow(3)
80       Xlib - C Language X Interface
81
82
83
84X Version 11                     libX11 1.6.12               XIconifyWindow(3)
Impressum