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

DIAGNOSTICS

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

SEE ALSO

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