XIconifyWindow(3X11)RISC/os Reference Manual XIconifyWindow(3X11)



NAME
     XIconifyWindow, XWithdrawWindow, XReconfigureWMWindow -
     manipulate top-level windows

SYNTAX
     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;

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 infor-
               mation in the values structure.  This mask is the
               bitwise inclusive OR of the valid configure window
               values bits.

     values    Specifies a pointer to the XWindowChanges struc-
               ture.

     w         Specifies the window.

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 pro-
     perty cannot be interned, XIconifyWindow does not send a
     message and returns a zero status.  It returns a nonzero



                         Printed 1/24/91         Release 4 Page 1

XIconifyWindow(3X11)RISC/os Reference Manual XIconifyWindow(3X11)



     status if the client message is sent successfully; other-
     wise, it returns a zero status.

     XIconifyWindow can generate a BadWindow error.

     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.

     XWithdrawWindow can generate a BadWindow error.

     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
     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.

     XReconfigureWMWindow can generate BadValue and BadWindow
     errors.

DIAGNOSTICS
     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 gen-
               erate this error.

     BadWindow A value for a Window argument does not name a
               defined Window.

SEE ALSO
     XChangeWindowAttributes(3X11), XConfigureWindow(3X11),
     XCreateWindow(3X11), XDestroyWindow(3X11),
     XRaiseWindow(3X11), XMapWindow(3X11), XUnmapWindow(3X11)
     Xlib - C Language X Interface










Release 4 Page 2         Printed 1/24/91