man/XIDefineCursor.txt

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