man/XSetDeviceValuators.man

   1 '\" t
   2 .\"     Title: xsetdevicevaluators
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 09/23/2011
   6 .\"    Manual: [FIXME: manual]
   7 .\"    Source: [FIXME: source]
   8 .\"  Language: English
   9 .\"
  10 .TH "XSETDEVICEVALUATORS" "libmansuffix" "09/23/2011" "[FIXME: source]" "[FIXME: manual]"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 XSetDeviceValuators \- initialize the valuators on an extension input device
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 #include <X11/extensions/XInput\&.h>
  36 .fi
  37 .sp
  38 .nf
  39 XSetDeviceValuators( Display *display,
  40                      XDevice *device,
  41                      int *valuators,
  42                      int first_valuator,
  43                      int num_valuators);
  44 .fi
  45 .sp
  46 .nf
  47 display
  48        Specifies the connection to the X server\&.
  49 .fi
  50 .sp
  51 .nf
  52 device
  53        Specifies the device whose valuators are to be
  54        initialized\&.
  55 .fi
  56 .sp
  57 .nf
  58 valuators
  59        Specifies a pointer to an array of integer values to be
  60        used to initialize thedevice valuators\&.
  61 .fi
  62 .sp
  63 .nf
  64 first_valuator
  65        Specifies the first valuator to be set\&. Valuators are
  66        numbered beginning withzero\&.
  67 .fi
  68 .sp
  69 .nf
  70 num_valuators
  71        Specifies the number of valuators to be set\&.
  72 .fi
  73 .SH "DESCRIPTION"
  74 .sp
  75 .if n \{\
  76 .RS 4
  77 .\}
  78 .nf
  79 The XSetDeviceValuators request sets the current values of the
  80 valuators of an input device\&. The valuators in the range
  81 first_valuator to (first_valuator + num_valuators) are set to
  82 the specified values\&. Valuators are numbered beginning with 0\&.
  83 Not all input devices support initialization of valuator
  84 values\&. If this request is made to a device that does not
  85 support valuators initialization, a BadMatch error will occur\&.
  86 .fi
  87 .if n \{\
  88 .RE
  89 .\}
  90 .sp
  91 .if n \{\
  92 .RS 4
  93 .\}
  94 .nf
  95 If the request succeeds, a status of Success is returned\&. If
  96 another client has the device grabbed, a status of
  97 AlreadyGrabbed is returned\&.
  98 .fi
  99 .if n \{\
 100 .RE
 101 .\}
 102 .sp
 103 .if n \{\
 104 .RS 4
 105 .\}
 106 .nf
 107 XSetDeviceValuators can generate a BadLength, BadDevice,
 108 BadMatch, or BadValue error\&.
 109 .fi
 110 .if n \{\
 111 .RE
 112 .\}
 113 .SH "DIAGNOSTICS"
 114 .sp
 115 .if n \{\
 116 .RS 4
 117 .\}
 118 .nf
 119 BadDevice
 120        An invalid device was specified\&. The specified device
 121        does not exist or has not been opened by this client via
 122        XOpenInputDevice\&.
 123 .fi
 124 .if n \{\
 125 .RE
 126 .\}
 127 .sp
 128 .if n \{\
 129 .RS 4
 130 .\}
 131 .nf
 132 BadMatch
 133        This error may occur if an XSetDeviceValuators request
 134        is made specifying a device that has no valuators and
 135        reports no axes of motion, or if such a request is made
 136        specifying a device that does not support valuator
 137        initialization\&.
 138 .fi
 139 .if n \{\
 140 .RE
 141 .\}
 142 .sp
 143 .if n \{\
 144 .RS 4
 145 .\}
 146 .nf
 147 BadValue
 148        An invalid first_valuator or num_valuators values was
 149        specified\&.
 150 .fi
 151 .if n \{\
 152 .RE
 153 .\}