xorg-server-1.4/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
  26 Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
  27
  28                         All Rights Reserved
  29
  30 Permission to use, copy, modify, and distribute this software and its
  31 documentation for any purpose and without fee is hereby granted,
  32 provided that the above copyright notice appear in all copies and that
  33 both that copyright notice and this permission notice appear in
  34 supporting documentation, and that the name of Digital not be
  35 used in advertising or publicity pertaining to distribution of the
  36 software without specific, written prior permission.
  37
  38 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  39 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  40 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  41 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  42 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  43 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  44 SOFTWARE.
  45
  46 ******************************************************************/
  47
  48 #ifndef WINDOW_H
  49 #define WINDOW_H
  50
  51 #include "misc.h"
  52 #include "region.h"
  53 #include "screenint.h"
  54 #include <X11/Xproto.h>
  55
  56 #define TOTALLY_OBSCURED 0
  57 #define UNOBSCURED 1
  58 #define OBSCURED 2
  59
  60 #define VisibilityNotViewable   3
  61
  62 /* return values for tree-walking callback procedures */
  63 #define WT_STOPWALKING          0
  64 #define WT_WALKCHILDREN         1
  65 #define WT_DONTWALKCHILDREN     2
  66 #define WT_NOMATCH 3
  67 #define NullWindow ((WindowPtr) 0)
  68
  69 typedef struct _BackingStore *BackingStorePtr;
  70 typedef struct _Window *WindowPtr;
  71
  72 typedef int (*VisitWindowProcPtr)(
  73     WindowPtr /*pWin*/,
  74     pointer /*data*/);
  75
  76 extern int TraverseTree(
  77     WindowPtr /*pWin*/,
  78     VisitWindowProcPtr /*func*/,
  79     pointer /*data*/);
  80
  81 extern int WalkTree(
  82     ScreenPtr /*pScreen*/,
  83     VisitWindowProcPtr /*func*/,
  84     pointer /*data*/);
  85
  86 extern WindowPtr AllocateWindow(
  87     ScreenPtr /*pScreen*/);
  88
  89 extern Bool CreateRootWindow(
  90     ScreenPtr /*pScreen*/);
  91
  92 extern void InitRootWindow(
  93     WindowPtr /*pWin*/);
  94
  95 typedef WindowPtr (* RealChildHeadProc) (WindowPtr pWin);
  96
  97 void RegisterRealChildHeadProc (RealChildHeadProc proc);
  98
  99 extern WindowPtr RealChildHead(
 100     WindowPtr /*pWin*/);
 101
 102 extern WindowPtr CreateWindow(
 103     Window /*wid*/,
 104     WindowPtr /*pParent*/,
 105     int /*x*/,
 106     int /*y*/,
 107     unsigned int /*w*/,
 108     unsigned int /*h*/,
 109     unsigned int /*bw*/,
 110     unsigned int /*class*/,
 111     Mask /*vmask*/,
 112     XID* /*vlist*/,
 113     int /*depth*/,
 114     ClientPtr /*client*/,
 115     VisualID /*visual*/,
 116     int* /*error*/);
 117
 118 extern int DeleteWindow(
 119     pointer /*pWin*/,
 120     XID /*wid*/);
 121
 122 extern void DestroySubwindows(
 123     WindowPtr /*pWin*/,
 124     ClientPtr /*client*/);
 125
 126 /* Quartz support on Mac OS X uses the HIToolbox
 127    framework whose ChangeWindowAttributes function conflicts here. */
 128 #ifdef __DARWIN__
 129 #define ChangeWindowAttributes Darwin_X_ChangeWindowAttributes
 130 #endif
 131 extern int ChangeWindowAttributes(
 132     WindowPtr /*pWin*/,
 133     Mask /*vmask*/,
 134     XID* /*vlist*/,
 135     ClientPtr /*client*/);
 136
 137 /* Quartz support on Mac OS X uses the HIToolbox
 138    framework whose GetWindowAttributes function conflicts here. */
 139 #ifdef __DARWIN__
 140 #define GetWindowAttributes(w,c,x) Darwin_X_GetWindowAttributes(w,c,x)
 141 extern void Darwin_X_GetWindowAttributes(
 142 #else
 143 extern void GetWindowAttributes(
 144 #endif
 145     WindowPtr /*pWin*/,
 146     ClientPtr /*client*/,
 147     xGetWindowAttributesReply* /* wa */);
 148
 149 extern RegionPtr CreateUnclippedWinSize(
 150     WindowPtr /*pWin*/);
 151
 152 extern void GravityTranslate(
 153     int /*x*/,
 154     int /*y*/,
 155     int /*oldx*/,
 156     int /*oldy*/,
 157     int /*dw*/,
 158     int /*dh*/,
 159     unsigned /*gravity*/,
 160     int* /*destx*/,
 161     int* /*desty*/);
 162
 163 extern int ConfigureWindow(
 164     WindowPtr /*pWin*/,
 165     Mask /*mask*/,
 166     XID* /*vlist*/,
 167     ClientPtr /*client*/);
 168
 169 extern int CirculateWindow(
 170     WindowPtr /*pParent*/,
 171     int /*direction*/,
 172     ClientPtr /*client*/);
 173
 174 extern int ReparentWindow(
 175     WindowPtr /*pWin*/,
 176     WindowPtr /*pParent*/,
 177     int /*x*/,
 178     int /*y*/,
 179     ClientPtr /*client*/);
 180
 181 extern int MapWindow(
 182     WindowPtr /*pWin*/,
 183     ClientPtr /*client*/);
 184
 185 extern void MapSubwindows(
 186     WindowPtr /*pParent*/,
 187     ClientPtr /*client*/);
 188
 189 extern int UnmapWindow(
 190     WindowPtr /*pWin*/,
 191     Bool /*fromConfigure*/);
 192
 193 extern void UnmapSubwindows(
 194     WindowPtr /*pWin*/);
 195
 196 extern void HandleSaveSet(
 197     ClientPtr /*client*/);
 198
 199 extern Bool PointInWindowIsVisible(
 200     WindowPtr /*pWin*/,
 201     int /*x*/,
 202     int /*y*/);
 203
 204 extern RegionPtr NotClippedByChildren(
 205     WindowPtr /*pWin*/);
 206
 207 extern void SendVisibilityNotify(
 208     WindowPtr /*pWin*/);
 209
 210 extern void SaveScreens(
 211     int /*on*/,
 212     int /*mode*/);
 213
 214 extern WindowPtr FindWindowWithOptional(
 215     WindowPtr /*w*/);
 216
 217 extern void CheckWindowOptionalNeed(
 218     WindowPtr /*w*/);
 219
 220 extern Bool MakeWindowOptional(
 221     WindowPtr /*pWin*/);
 222
 223 extern WindowPtr MoveWindowInStack(
 224     WindowPtr /*pWin*/,
 225     WindowPtr /*pNextSib*/);
 226
 227 void SetWinSize(
 228     WindowPtr /*pWin*/);
 229
 230 void SetBorderSize(
 231     WindowPtr /*pWin*/);
 232
 233 void ResizeChildrenWinSize(
 234     WindowPtr /*pWin*/,
 235     int /*dx*/,
 236     int /*dy*/,
 237     int /*dw*/,
 238     int /*dh*/);
 239
 240 extern void ShapeExtensionInit(void);
 241
 242 extern void SendShapeNotify(
 243     WindowPtr /* pWin */,
 244     int /* which */ );
 245
 246 extern RegionPtr CreateBoundingShape(
 247     WindowPtr /* pWin */ );
 248
 249 extern RegionPtr CreateClipShape(
 250     WindowPtr /* pWin */ );
 251
 252 extern void DisableMapUnmapEvents(
 253     WindowPtr /* pWin */ );
 254 extern void EnableMapUnmapEvents(
 255     WindowPtr /* pWin */ );
 256
 257 #endif /* WINDOW_H */