Imported Upstream version 1.15.1
[deb_xorg-server.git] / include / window.h
1 /***********************************************************
2
3 Copyright 1987, 1998 The Open Group
4
5 Permission to use, copy, modify, distribute, and sell this software and its
6 documentation for any purpose is hereby granted without fee, provided that
7 the above copyright notice appear in all copies and that both that
8 copyright notice and this permission notice appear in supporting
9 documentation.
10
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
18 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20
21 Except as contained in this notice, the name of The Open Group shall not be
22 used in advertising or otherwise to promote the sale, use or other dealings
23 in this Software without prior written authorization from The Open Group.
24
25 Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
26
27 All Rights Reserved
28
29 Permission to use, copy, modify, and distribute this software and its
30 documentation for any purpose and without fee is hereby granted,
31 provided that the above copyright notice appear in all copies and that
32 both that copyright notice and this permission notice appear in
33 supporting documentation, and that the name of Digital not be
34 used in advertising or publicity pertaining to distribution of the
35 software without specific, written prior permission.
36
37 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
38 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
39 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
40 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
41 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
42 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
43 SOFTWARE.
44
45 ******************************************************************/
46
47 #ifndef WINDOW_H
48 #define WINDOW_H
49
50 #include "misc.h"
51 #include "region.h"
52 #include "screenint.h"
53 #include <X11/Xproto.h>
54
55 #define TOTALLY_OBSCURED 0
56 #define UNOBSCURED 1
57 #define OBSCURED 2
58
59 #define VisibilityNotViewable 3
60
61 /* return values for tree-walking callback procedures */
62 #define WT_STOPWALKING 0
63 #define WT_WALKCHILDREN 1
64 #define WT_DONTWALKCHILDREN 2
65 #define WT_NOMATCH 3
66 #define NullWindow ((WindowPtr) 0)
67
68 /* Forward declaration, we can't include input.h here */
69 struct _DeviceIntRec;
70 struct _Cursor;
71
72 typedef struct _BackingStore *BackingStorePtr;
73 typedef struct _Window *WindowPtr;
74
75 typedef int (*VisitWindowProcPtr) (WindowPtr /*pWin */ ,
76 pointer /*data */ );
77
78 extern _X_EXPORT int TraverseTree(WindowPtr /*pWin */ ,
79 VisitWindowProcPtr /*func */ ,
80 pointer /*data */ );
81
82 extern _X_EXPORT int WalkTree(ScreenPtr /*pScreen */ ,
83 VisitWindowProcPtr /*func */ ,
84 pointer /*data */ );
85
86 extern _X_EXPORT Bool CreateRootWindow(ScreenPtr /*pScreen */ );
87
88 extern _X_EXPORT void InitRootWindow(WindowPtr /*pWin */ );
89
90 typedef WindowPtr (*RealChildHeadProc) (WindowPtr pWin);
91
92 extern _X_EXPORT void RegisterRealChildHeadProc(RealChildHeadProc proc);
93
94 extern _X_EXPORT WindowPtr RealChildHead(WindowPtr /*pWin */ );
95
96 extern _X_EXPORT WindowPtr CreateWindow(Window /*wid */ ,
97 WindowPtr /*pParent */ ,
98 int /*x */ ,
99 int /*y */ ,
100 unsigned int /*w */ ,
101 unsigned int /*h */ ,
102 unsigned int /*bw */ ,
103 unsigned int /*class */ ,
104 Mask /*vmask */ ,
105 XID * /*vlist */ ,
106 int /*depth */ ,
107 ClientPtr /*client */ ,
108 VisualID /*visual */ ,
109 int * /*error */ );
110
111 extern _X_EXPORT int DeleteWindow(pointer /*pWin */ ,
112 XID /*wid */ );
113
114 extern _X_EXPORT int DestroySubwindows(WindowPtr /*pWin */ ,
115 ClientPtr /*client */ );
116
117 /* Quartz support on Mac OS X uses the HIToolbox
118 framework whose ChangeWindowAttributes function conflicts here. */
119 #ifdef __APPLE__
120 #define ChangeWindowAttributes Darwin_X_ChangeWindowAttributes
121 #endif
122 extern _X_EXPORT int ChangeWindowAttributes(WindowPtr /*pWin */ ,
123 Mask /*vmask */ ,
124 XID * /*vlist */ ,
125 ClientPtr /*client */ );
126
127 extern _X_EXPORT int ChangeWindowDeviceCursor(WindowPtr /*pWin */ ,
128 struct _DeviceIntRec * /*pDev */ ,
129 struct _Cursor * /*pCursor */ );
130
131 extern _X_EXPORT struct _Cursor *WindowGetDeviceCursor(WindowPtr /*pWin */ ,
132 struct _DeviceIntRec *
133 /*pDev */ );
134
135 /* Quartz support on Mac OS X uses the HIToolbox
136 framework whose GetWindowAttributes function conflicts here. */
137 #ifdef __APPLE__
138 #define GetWindowAttributes(w,c,x) Darwin_X_GetWindowAttributes(w,c,x)
139 extern void Darwin_X_GetWindowAttributes(
140 #else
141 extern _X_EXPORT void GetWindowAttributes(
142 #endif
143 WindowPtr /*pWin */ ,
144 ClientPtr /*client */ ,
145 xGetWindowAttributesReply *
146 /* wa */ );
147
148 extern _X_EXPORT void GravityTranslate(int /*x */ ,
149 int /*y */ ,
150 int /*oldx */ ,
151 int /*oldy */ ,
152 int /*dw */ ,
153 int /*dh */ ,
154 unsigned /*gravity */ ,
155 int * /*destx */ ,
156 int * /*desty */ );
157
158 extern _X_EXPORT int ConfigureWindow(WindowPtr /*pWin */ ,
159 Mask /*mask */ ,
160 XID * /*vlist */ ,
161 ClientPtr /*client */ );
162
163 extern _X_EXPORT int CirculateWindow(WindowPtr /*pParent */ ,
164 int /*direction */ ,
165 ClientPtr /*client */ );
166
167 extern _X_EXPORT int ReparentWindow(WindowPtr /*pWin */ ,
168 WindowPtr /*pParent */ ,
169 int /*x */ ,
170 int /*y */ ,
171 ClientPtr /*client */ );
172
173 extern _X_EXPORT int MapWindow(WindowPtr /*pWin */ ,
174 ClientPtr /*client */ );
175
176 extern _X_EXPORT void MapSubwindows(WindowPtr /*pParent */ ,
177 ClientPtr /*client */ );
178
179 extern _X_EXPORT int UnmapWindow(WindowPtr /*pWin */ ,
180 Bool /*fromConfigure */ );
181
182 extern _X_EXPORT void UnmapSubwindows(WindowPtr /*pWin */ );
183
184 extern _X_EXPORT void HandleSaveSet(ClientPtr /*client */ );
185
186 extern _X_EXPORT Bool PointInWindowIsVisible(WindowPtr /*pWin */ ,
187 int /*x */ ,
188 int /*y */ );
189
190 extern _X_EXPORT RegionPtr NotClippedByChildren(WindowPtr /*pWin */ );
191
192 extern _X_EXPORT void SendVisibilityNotify(WindowPtr /*pWin */ );
193
194 extern _X_EXPORT int dixSaveScreens(ClientPtr client, int on, int mode);
195
196 extern _X_EXPORT int SaveScreens(int on, int mode);
197
198 extern _X_EXPORT WindowPtr FindWindowWithOptional(WindowPtr /*w */ );
199
200 extern _X_EXPORT void CheckWindowOptionalNeed(WindowPtr /*w */ );
201
202 extern _X_EXPORT Bool MakeWindowOptional(WindowPtr /*pWin */ );
203
204 extern _X_EXPORT WindowPtr MoveWindowInStack(WindowPtr /*pWin */ ,
205 WindowPtr /*pNextSib */ );
206
207 extern _X_EXPORT void SetWinSize(WindowPtr /*pWin */ );
208
209 extern _X_EXPORT void SetBorderSize(WindowPtr /*pWin */ );
210
211 extern _X_EXPORT void ResizeChildrenWinSize(WindowPtr /*pWin */ ,
212 int /*dx */ ,
213 int /*dy */ ,
214 int /*dw */ ,
215 int /*dh */ );
216
217 extern _X_EXPORT void SendShapeNotify(WindowPtr /* pWin */ ,
218 int /* which */);
219
220 extern _X_EXPORT RegionPtr CreateBoundingShape(WindowPtr /* pWin */ );
221
222 extern _X_EXPORT RegionPtr CreateClipShape(WindowPtr /* pWin */ );
223
224 extern _X_EXPORT void SetRootClip(ScreenPtr pScreen, Bool enable);
225 extern _X_EXPORT void PrintWindowTree(void);
226
227 extern _X_EXPORT VisualPtr WindowGetVisual(WindowPtr /*pWin*/);
228 #endif /* WINDOW_H */