Git init
[framework/uifw/xorg/lib/libx11.git] / man / XConfigureEvent.man
1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
2 .\"
3 .\" Permission is hereby granted, free of charge, to any person obtaining
4 .\" a copy of this software and associated documentation files (the
5 .\" "Software"), to deal in the Software without restriction, including
6 .\" without limitation the rights to use, copy, modify, merge, publish,
7 .\" distribute, sublicense, and/or sell copies of the Software, and to
8 .\" permit persons to whom the Software is furnished to do so, subject to
9 .\" the following conditions:
10 .\"
11 .\" The above copyright notice and this permission notice shall be included
12 .\" in all copies or substantial portions of the Software.
13 .\"
14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 .\" OTHER DEALINGS IN THE SOFTWARE.
21 .\"
22 .\" Except as contained in this notice, the name of the X Consortium shall
23 .\" not be used in advertising or otherwise to promote the sale, use or
24 .\" other dealings in this Software without prior written authorization
25 .\" from the X Consortium.
26 .\"
27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
28 .\" Digital Equipment Corporation
29 .\"
30 .\" Portions Copyright \(co 1990, 1991 by
31 .\" Tektronix, Inc.
32 .\"
33 .\" Permission to use, copy, modify and distribute this documentation for
34 .\" any purpose and without fee is hereby granted, provided that the above
35 .\" copyright notice appears in all copies and that both that copyright notice
36 .\" and this permission notice appear in all copies, and that the names of
37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
38 .\" to this documentation without specific, written prior permission.
39 .\" Digital and Tektronix makes no representations about the suitability
40 .\" of this documentation for any purpose.
41 .\" It is provided ``as is'' without express or implied warranty.
42 .\" 
43 .\"
44 .ds xT X Toolkit Intrinsics \- C Language Interface
45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
46 .ds xL Xlib \- C Language X Interface
47 .ds xC Inter-Client Communication Conventions Manual
48 .na
49 .de Ds
50 .nf
51 .\\$1D \\$2 \\$1
52 .ft 1
53 .\".ps \\n(PS
54 .\".if \\n(VS>=40 .vs \\n(VSu
55 .\".if \\n(VS<=39 .vs \\n(VSp
56 ..
57 .de De
58 .ce 0
59 .if \\n(BD .DF
60 .nr BD 0
61 .in \\n(OIu
62 .if \\n(TM .ls 2
63 .sp \\n(DDu
64 .fi
65 ..
66 .de FD
67 .LP
68 .KS
69 .TA .5i 3i
70 .ta .5i 3i
71 .nf
72 ..
73 .de FN
74 .fi
75 .KE
76 .LP
77 ..
78 .de IN          \" send an index entry to the stderr
79 ..
80 .de C{
81 .KS
82 .nf
83 .D
84 .\"
85 .\"     choose appropriate monospace font
86 .\"     the imagen conditional, 480,
87 .\"     may be changed to L if LB is too
88 .\"     heavy for your eyes...
89 .\"
90 .ie "\\*(.T"480" .ft L
91 .el .ie "\\*(.T"300" .ft L
92 .el .ie "\\*(.T"202" .ft PO
93 .el .ie "\\*(.T"aps" .ft CW
94 .el .ft R
95 .ps \\n(PS
96 .ie \\n(VS>40 .vs \\n(VSu
97 .el .vs \\n(VSp
98 ..
99 .de C}
100 .DE
101 .R
102 ..
103 .de Pn
104 .ie t \\$1\fB\^\\$2\^\fR\\$3
105 .el \\$1\fI\^\\$2\^\fP\\$3
106 ..
107 .de ZN
108 .ie t \fB\^\\$1\^\fR\\$2
109 .el \fI\^\\$1\^\fP\\$2
110 ..
111 .de hN
112 .ie t <\fB\\$1\fR>\\$2
113 .el <\fI\\$1\fP>\\$2
114 ..
115 .de NT
116 .ne 7
117 .ds NO Note
118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
120 .ie n .sp
121 .el .sp 10p
122 .TB
123 .ce
124 \\*(NO
125 .ie n .sp
126 .el .sp 5p
127 .if '\\$1'C' .ce 99
128 .if '\\$2'C' .ce 99
129 .in +5n
130 .ll -5n
131 .R
132 ..
133 .               \" Note End -- doug kraft 3/85
134 .de NE
135 .ce 0
136 .in -5n
137 .ll +5n
138 .ie n .sp
139 .el .sp 10p
140 ..
141 .ny0
142 .TH XConfigureEvent __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
143 .SH NAME
144 XConfigureEvent \- ConfigureNotify event structure
145 .SH STRUCTURES
146 The structure for
147 .ZN ConfigureNotify
148 events contains:
149 .LP
150 .Ds 0
151 .TA .5i 3i
152 .ta .5i 3i
153 typedef struct {
154         int type;       /\&* ConfigureNotify */
155         unsigned long serial;   /\&* # of last request processed by server */
156         Bool send_event;        /\&* true if this came from a SendEvent request */
157         Display *display;       /\&* Display the event was read from */
158         Window event;
159         Window window;
160         int x, y;
161         int width, height;
162         int border_width;
163         Window above;
164         Bool override_redirect;
165 } XConfigureEvent;
166 .De
167 .LP
168 When you receive this event,
169 the structure members are set as follows.
170 .LP
171 The type member is set to the event type constant name that uniquely identifies
172 it.
173 For example, when the X server reports a
174 .ZN GraphicsExpose
175 event to a client application, it sends an
176 .ZN XGraphicsExposeEvent
177 structure with the type member set to
178 .ZN GraphicsExpose .
179 The display member is set to a pointer to the display the event was read on.
180 The send_event member is set to
181 .ZN True
182 if the event came from a
183 .ZN SendEvent
184 protocol request.
185 The serial member is set from the serial number reported in the protocol
186 but expanded from the 16-bit least-significant bits to a full 32-bit value.
187 The window member is set to the window that is most useful to toolkit
188 dispatchers.
189 .LP
190 The event member is set either to the reconfigured window or to its parent,
191 depending on whether
192 .ZN StructureNotify
193 or
194 .ZN SubstructureNotify
195 was selected.
196 The window member is set to the window whose size, position, 
197 border, and/or stacking
198 order was changed.
199 .LP
200 The x and y members are set to the coordinates relative to the parent window's 
201 origin and indicate the position of the upper-left outside corner of the window.
202 The width and height members are set to the inside size of the window, 
203 not including
204 the border.
205 The border_width member is set to the width of the window's border, in pixels.
206 .LP
207 The above member is set to the sibling window and is used 
208 for stacking operations.
209 If the X server sets this member to
210 .ZN None ,
211 the window whose state was changed is on the bottom of the stack
212 with respect to sibling windows.
213 However, if this member is set to a sibling window, 
214 the window whose state was changed is placed on top of this sibling window.
215 .LP
216 The override_redirect member is set to the override-redirect attribute of the
217 window.
218 Window manager clients normally should ignore this window if the 
219 override_redirect member
220 is
221 .ZN True .
222 .SH "SEE ALSO"
223 XAnyEvent(__libmansuffix__),
224 XButtonEvent(__libmansuffix__),
225 XCreateWindowEvent(__libmansuffix__),
226 XCirculateEvent(__libmansuffix__),
227 XCirculateRequestEvent(__libmansuffix__),
228 XColormapEvent(__libmansuffix__),
229 XConfigureRequestEvent(__libmansuffix__),
230 XCrossingEvent(__libmansuffix__),
231 XDestroyWindowEvent(__libmansuffix__),
232 XErrorEvent(__libmansuffix__),
233 XExposeEvent(__libmansuffix__),
234 XFocusChangeEvent(__libmansuffix__),
235 XGraphicsExposeEvent(__libmansuffix__),
236 XGravityEvent(__libmansuffix__),
237 XKeymapEvent(__libmansuffix__),
238 XMapEvent(__libmansuffix__),
239 XMapRequestEvent(__libmansuffix__),
240 XPropertyEvent(__libmansuffix__),
241 XReparentEvent(__libmansuffix__),
242 XResizeRequestEvent(__libmansuffix__),
243 XSelectionClearEvent(__libmansuffix__),
244 XSelectionEvent(__libmansuffix__),
245 XSelectionRequestEvent(__libmansuffix__),
246 XUnmapEvent(__libmansuffix__),
247 XVisibilityEvent(__libmansuffix__)
248 .br
249 \fI\*(xL\fP