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 CURSOR_H
48 #define CURSOR_H
49 
50 #include "misc.h"
51 #include "screenint.h"
52 #include "window.h"
53 #include "privates.h"
54 
55 #define NullCursor ((CursorPtr)NULL)
56 
57 /* Provide support for alpha composited cursors */
58 #define ARGB_CURSOR
59 
60 struct _DeviceIntRec;
61 
62 typedef struct _Cursor *CursorPtr;
63 typedef struct _CursorMetric *CursorMetricPtr;
64 
65 extern _X_EXPORT DevScreenPrivateKeyRec cursorScreenDevPriv;
66 
67 #define CursorScreenKey (&cursorScreenDevPriv)
68 
69 extern _X_EXPORT CursorPtr rootCursor;
70 
71 extern _X_EXPORT int FreeCursor(void *pCurs,
72                                 XID cid);
73 
74 extern _X_EXPORT CursorPtr RefCursor(CursorPtr /* cursor */);
75 extern _X_EXPORT CursorPtr UnrefCursor(CursorPtr /* cursor */);
76 extern _X_EXPORT int CursorRefCount(const CursorPtr /* cursor */);
77 
78 extern _X_EXPORT int AllocARGBCursor(unsigned char * /*psrcbits */ ,
79                                      unsigned char * /*pmaskbits */ ,
80                                      CARD32 * /*argb */ ,
81                                      CursorMetricPtr /*cm */ ,
82                                      unsigned /*foreRed */ ,
83                                      unsigned /*foreGreen */ ,
84                                      unsigned /*foreBlue */ ,
85                                      unsigned /*backRed */ ,
86                                      unsigned /*backGreen */ ,
87                                      unsigned /*backBlue */ ,
88                                      CursorPtr * /*ppCurs */ ,
89                                      ClientPtr /*client */ ,
90                                      XID /*cid */ );
91 
92 extern _X_EXPORT int AllocGlyphCursor(Font /*source */ ,
93                                       unsigned int /*sourceChar */ ,
94                                       Font /*mask */ ,
95                                       unsigned int /*maskChar */ ,
96                                       unsigned /*foreRed */ ,
97                                       unsigned /*foreGreen */ ,
98                                       unsigned /*foreBlue */ ,
99                                       unsigned /*backRed */ ,
100                                       unsigned /*backGreen */ ,
101                                       unsigned /*backBlue */ ,
102                                       CursorPtr * /*ppCurs */ ,
103                                       ClientPtr /*client */ ,
104                                       XID /*cid */ );
105 
106 extern _X_EXPORT CursorPtr CreateRootCursor(char * /*pfilename */ ,
107                                             unsigned int /*glyph */ );
108 
109 extern _X_EXPORT int ServerBitsFromGlyph(FontPtr /*pfont */ ,
110                                          unsigned int /*ch */ ,
111                                          CursorMetricPtr /*cm */ ,
112                                          unsigned char ** /*ppbits */ );
113 
114 extern _X_EXPORT Bool CursorMetricsFromGlyph(FontPtr /*pfont */ ,
115                                              unsigned /*ch */ ,
116                                              CursorMetricPtr /*cm */ );
117 
118 extern _X_EXPORT void CheckCursorConfinement(WindowPtr /*pWin */ );
119 
120 extern _X_EXPORT void NewCurrentScreen(struct _DeviceIntRec * /*pDev */ ,
121                                        ScreenPtr /*newScreen */ ,
122                                        int /*x */ ,
123                                        int /*y */ );
124 
125 extern _X_EXPORT Bool PointerConfinedToScreen(struct _DeviceIntRec * /* pDev */
126                                               );
127 
128 extern _X_EXPORT void GetSpritePosition(struct _DeviceIntRec * /* pDev */ ,
129                                         int * /*px */ ,
130                                         int * /*py */ );
131 
132 #ifdef PANORAMIX
133 extern _X_EXPORT int XineramaGetCursorScreen(struct _DeviceIntRec *pDev);
134 #endif                          /* PANORAMIX */
135 
136 #endif                          /* CURSOR_H */
137