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

NAME

6       XConfigureWindow,    XMoveWindow,   XResizeWindow,   XMoveResizeWindow,
7       XSetWindowBorderWidth, XWindowChanges - configure  windows  and  window
8       changes structure
9

SYNTAX

11       int  XConfigureWindow(Display  *display, Window w, unsigned value_mask,
12              XWindowChanges *changes);
13
14       int XMoveWindow(Display *display, Window w, int x, y);
15
16       int XResizeWindow(Display *display, Window w, unsigned width,  unsigned
17              height);
18
19       int  XMoveResizeWindow(Display  *display,  Window  w, int x, int y, un‐
20              signed width, unsigned height);
21
22       int XSetWindowBorderWidth(Display *display, Window w, unsigned width);
23

ARGUMENTS

25       display   Specifies the connection to the X server.
26
27       value_mask
28                 Specifies which values are to be set using information in the
29                 values  structure.   This mask is the bitwise inclusive OR of
30                 the valid configure window values bits.
31
32       values    Specifies the XWindowChanges structure.
33
34       w         Specifies the window to be reconfigured, moved, or resized..
35
36       width     Specifies the width of the window border.
37
38       width
39       height    Specify the width and height, which are the  interior  dimen‐
40                 sions of the window.
41
42       x
43       y         Specify  the  x and y coordinates, which define the new loca‐
44                 tion of the top-left pixel of the window's border or the win‐
45                 dow  itself if it has no border or define the new position of
46                 the window relative to its parent.
47

DESCRIPTION

49       The XConfigureWindow function uses the values specified  in  the  XWin‐
50       dowChanges  structure to reconfigure a window's size, position, border,
51       and stacking order.  Values not specified are taken from  the  existing
52       geometry of the window.
53
54       If  a sibling is specified without a stack_mode or if the window is not
55       actually a sibling, a BadMatch error results.  Note that  the  computa‐
56       tions  for  BottomIf, TopIf, and Opposite are performed with respect to
57       the window's final geometry  (as  controlled  by  the  other  arguments
58       passed  to  XConfigureWindow),  not  its initial geometry.  Any backing
59       store contents of the window, its inferiors, and  other  newly  visible
60       windows  are  either discarded or changed to reflect the current screen
61       contents (depending on the implementation).
62
63       XConfigureWindow can generate BadMatch, BadValue, and BadWindow errors.
64
65       The XMoveWindow function moves the specified window to the specified  x
66       and  y coordinates, but it does not change the window's size, raise the
67       window, or change the mapping state of the  window.   Moving  a  mapped
68       window  may  or  may not lose the window's contents depending on if the
69       window is obscured by nonchildren and if no backing store  exists.   If
70       the  contents  of  the  window  are lost, the X server generates Expose
71       events.  Moving a mapped window generates Expose events on any formerly
72       obscured windows.
73
74       If  the  override-redirect  flag  of the window is False and some other
75       client has selected  SubstructureRedirectMask  on  the  parent,  the  X
76       server generates a ConfigureRequest event, and no further processing is
77       performed.  Otherwise, the window is moved.
78
79       XMoveWindow can generate a BadWindow error.
80
81       The XResizeWindow function changes the inside dimensions of the  speci‐
82       fied  window, not including its borders.  This function does not change
83       the window's upper-left coordinate or the origin and does  not  restack
84       the window.  Changing the size of a mapped window may lose its contents
85       and generate Expose events.  If a mapped window is made smaller, chang‐
86       ing  its size generates Expose events on windows that the mapped window
87       formerly obscured.
88
89       If the override-redirect flag of the window is  False  and  some  other
90       client  has  selected  SubstructureRedirectMask  on  the  parent, the X
91       server generates a ConfigureRequest event, and no further processing is
92       performed.   If  either  width  or height is zero, a BadValue error re‐
93       sults.
94
95       XResizeWindow can generate BadValue and BadWindow errors.
96
97       The XMoveResizeWindow function changes the size  and  location  of  the
98       specified window without raising it.  Moving and resizing a mapped win‐
99       dow may generate an Expose event on the window.  Depending on  the  new
100       size and location parameters, moving and resizing a window may generate
101       Expose events on windows that the window formerly obscured.
102
103       If the override-redirect flag of the window is  False  and  some  other
104       client  has  selected  SubstructureRedirectMask  on  the  parent, the X
105       server generates a ConfigureRequest event, and no further processing is
106       performed.  Otherwise, the window size and location are changed.
107
108       XMoveResizeWindow can generate BadValue and BadWindow errors.
109
110       The  XSetWindowBorderWidth  function sets the specified window's border
111       width to the specified width.
112
113       XSetWindowBorderWidth can generate a BadWindow error.
114

STRUCTURES

116       The XWindowChanges structure contains:
117
118       /* Configure window value mask bits */
119
120       #de‐    CWX                         (1<<0)
121       fine
122       #de‐    CWY                         (1<<1)
123       fine
124       #de‐    CWWidth                     (1<<2)
125       fine
126       #de‐    CWHeight                    (1<<3)
127       fine
128       #de‐    CWBorderWidth               (1<<4)
129       fine
130       #de‐    CWSibling                   (1<<5)
131       fine
132
133       #de‐    CWStackMode                 (1<<6)
134       fine
135       /* Values */
136
137       typedef struct {
138               int x, y;
139               int width, height;
140               int border_width;
141               Window sibling;
142               int stack_mode;
143       } XWindowChanges;
144
145       The  x  and y members are used to set the window's x and y coordinates,
146       which are relative to the parent's origin and indicate the position  of
147       the  upper-left  outer corner of the window.  The width and height mem‐
148       bers are used to set the inside size of the window, not  including  the
149       border,  and must be nonzero, or a BadValue error results.  Attempts to
150       configure a root window have no effect.
151
152       The border_width member is used to set the width of the border in  pix‐
153       els.   Note  that  setting  just the border width leaves the outer-left
154       corner of the window in a fixed position but moves the  absolute  posi‐
155       tion  of  the  window's origin.  If you attempt to set the border-width
156       attribute of an InputOnly window nonzero, a BadMatch error results.
157
158       The sibling member is used to set the sibling window for stacking oper‐
159       ations.   The  stack_mode member is used to set how the window is to be
160       restacked and can be set to Above, Below, TopIf, BottomIf, or Opposite.
161

DIAGNOSTICS

163       BadMatch  An InputOnly window is used as a Drawable.
164
165       BadMatch  Some argument or pair of arguments has the correct  type  and
166                 range  but  fails  to match in some other way required by the
167                 request.
168
169       BadValue  Some numeric value falls outside the range of values accepted
170                 by  the request.  Unless a specific range is specified for an
171                 argument, the full range defined by the  argument's  type  is
172                 accepted.   Any argument defined as a set of alternatives can
173                 generate this error.
174
175       BadWindow A value for a Window argument does not name a defined Window.
176

SEE ALSO

178       XChangeWindowAttributes(3), XCreateWindow(3), XDestroyWindow(3),  XMap‐
179       Window(3), XRaiseWindow(3), XUnmapWindow(3)
180       Xlib - C Language X Interface
181
182
183
184X Version 11                    libX11 1.7.3.1             XConfigureWindow(3)
Impressum