1c27c18e8SmrgXIDEFINECURSOR(libmansuffix)
2c27c18e8Smrg============================
3c27c18e8Smrg
4c27c18e8SmrgNAME
5c27c18e8Smrg----
6c27c18e8Smrg
7c27c18e8Smrg   XIDefineCursor, XIUndefineCursor - define device cursors.
8c27c18e8Smrg
9c27c18e8SmrgSYNOPSIS
10c27c18e8Smrg--------
11c27c18e8Smrg
12c27c18e8Smrg   #include <X11/extensions/XInput2.h>
13c27c18e8Smrg
14c27c18e8Smrg   int XIDefineCursor( Display *display,
15c27c18e8Smrg                       int deviceid,
16c27c18e8Smrg                       Window win,
17c27c18e8Smrg                       Cursor cursor);
18c27c18e8Smrg
19c27c18e8Smrg   int XIUndefineCursor( Display *display,
20c27c18e8Smrg                         int deviceid,
21c27c18e8Smrg                         Window win);
22c27c18e8Smrg
23c27c18e8Smrg   cursor
24c27c18e8Smrg          Specifies the cursor that is to be displayed or None.
25c27c18e8Smrg
26c27c18e8Smrg   deviceid
27c27c18e8Smrg          Specifies the device whose cursor is to change.
28c27c18e8Smrg
29c27c18e8Smrg   display
30c27c18e8Smrg          Specifies the connection to the X server.
31c27c18e8Smrg
32c27c18e8Smrg   win
33c27c18e8Smrg          Specifies the window.
34c27c18e8Smrg
35c27c18e8SmrgDESCRIPTION
36c27c18e8Smrg-----------
37c27c18e8Smrg
38c27c18e8Smrg   If a cursor is set, it will be used when the device's pointer
39c27c18e8Smrg   is in the window. If the cursor is None, it is equivalent to
40c27c18e8Smrg   XIUndefineCursor.
41c27c18e8Smrg
42c27c18e8Smrg   The deviceid must be a master pointer device or a BadDevice error is
43c27c18e8Smrg   returned.
44c27c18e8Smrg
45c27c18e8Smrg   XIDefineCursor can generate BadDevice, BadCursor and BadWindow.
46c27c18e8Smrg
47c27c18e8Smrg   The XIUndefineCursor function undoes the effect of a previous
48c27c18e8Smrg   XIDefineCursor for this window. When the pointer is in the
49c27c18e8Smrg   window, the window's default cursor will now be used. If no
50c27c18e8Smrg   default cursor is defined, the parent's cursor for this device
51c27c18e8Smrg   will be used (if defined) or the parent's default cursor will
52c27c18e8Smrg   be used.
53c27c18e8Smrg
54c27c18e8Smrg   XIDefineCursor and XIUndefineCursor are identical to
55c27c18e8Smrg   XDefineCursor and XUndefineCursor but specify the device
56c27c18e8Smrg   explicitly.
57c27c18e8Smrg
58c27c18e8Smrg   XIUndefineCursor can generate a BadDevice and a BadWindow
59c27c18e8Smrg   error.
60c27c18e8Smrg
61c27c18e8SmrgDIAGNOSTICS
62c27c18e8Smrg-----------
63c27c18e8Smrg
64c27c18e8Smrg   BadCursor
65c27c18e8Smrg          A value for a cursor argument does not name a defined
66c27c18e8Smrg          cursor.
67c27c18e8Smrg
68c27c18e8Smrg   BadDevice
69c27c18e8Smrg          An invalid device was specified. The device does not
70c27c18e8Smrg          exist or is not a pointer device.
71c27c18e8Smrg
72c27c18e8Smrg   BadWindow
73c27c18e8Smrg          A value for a Window argument does not name a defined
74c27c18e8Smrg          window.
75c27c18e8Smrg
76c27c18e8SmrgSee also
77c27c18e8Smrg
78c27c18e8Smrg   XDefineCursor, XUndefineCursor
79c27c18e8Smrg
80