File: XIDefineCursor.txt

package info (click to toggle)
libxi 2:1.3-8
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,476 kB
  • ctags: 906
  • sloc: sh: 10,500; ansic: 6,600; makefile: 454
file content (79 lines) | stat: -rw-r--r-- 1,966 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
XIDEFINECURSOR(libmansuffix)
============================

NAME
----

   XIDefineCursor, XIUndefineCursor - define device cursors.

SYNOPSIS
--------

   #include <X11/extensions/XInput2.h>

   int XIDefineCursor( Display *display,
                       int deviceid,
                       Window win,
                       Cursor cursor);

   int XIUndefineCursor( Display *display,
                         int deviceid,
                         Window win);

   cursor
          Specifies the cursor that is to be displayed or None.

   deviceid
          Specifies the device whose cursor is to change.

   display
          Specifies the connection to the X server.

   win
          Specifies the window.

DESCRIPTION
-----------

   If a cursor is set, it will be used when the device's pointer
   is in the window. If the cursor is None, it is equivalent to
   XIUndefineCursor.

   The deviceid must be a master pointer device or a BadDevice error is
   returned.

   XIDefineCursor can generate BadDevice, BadCursor and BadWindow.

   The XIUndefineCursor function undoes the effect of a previous
   XIDefineCursor for this window. When the pointer is in the
   window, the window's default cursor will now be used. If no
   default cursor is defined, the parent's cursor for this device
   will be used (if defined) or the parent's default cursor will
   be used.

   XIDefineCursor and XIUndefineCursor are identical to
   XDefineCursor and XUndefineCursor but specify the device
   explicitly.

   XIUndefineCursor can generate a BadDevice and a BadWindow
   error.

DIAGNOSTICS
-----------

   BadCursor
          A value for a cursor argument does not name a defined
          cursor.

   BadDevice
          An invalid device was specified. The device does not
          exist or is not a pointer device.

   BadWindow
          A value for a Window argument does not name a defined
          window.

See also

   XDefineCursor, XUndefineCursor