← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libxi/trusty-security

« back to all changes in this revision

Viewing changes to man/XIQueryDevice.txt

  • Committer: Package Import Robot
  • Author(s): Christopher James Halse Rogers
  • Date: 2012-01-18 11:44:39 UTC
  • mfrom: (1.1.8) (4.1.4 experimental)
  • Revision ID: package-import@ubuntu.com-20120118114439-bm7qksg514zh51do
Tags: 2:1.5.99.2-0ubuntu3
Bump build depends on x11proto-input-dev to 2.1.99.5.  Our 2.1.99.4 package
is really 2.0.2, so 2.1.99.5 is the first version with MT support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/XIQueryDevice.txt
100
100
 
101
101
   The type field specifies the type of the input class.
102
102
   Currently, the following types are defined:
103
 
       XIKeyClass, XIButtonClass, XIValuatorClass
 
103
       XIKeyClass, XIButtonClass, XIValuatorClass, XIScrollClass,
 
104
       XITouchClass
104
105
 
105
106
   In the future, additional types may be added. Clients are
106
107
   required to ignore unknown input classes.
175
176
                   double      value;
176
177
                   int         resolution;
177
178
                   int         mode;
178
 
               } XIValuatorInfo;
 
179
               } XIValuatorClassInfo;
179
180
 
180
181
   The number field specifies the number of the axis on the
181
182
   physical device.
194
195
   XIModeAbsolute this axis sends absolute coordinates. If the
195
196
   mode is XIModeRelative, this device sends relative coordinates.
196
197
 
 
198
               typedef struct
 
199
               {
 
200
                   int         type;
 
201
                   int         sourceid;
 
202
                   int         number;
 
203
                   int         scroll_type;
 
204
                   double      increment;
 
205
                   int         flags;
 
206
               } XIScrollClassInfo;
 
207
 
 
208
   This class describes scrolling capability on a valuator. For
 
209
   each XIScrollClassInfo, an XIValuatorClassInfo with the same
 
210
   number is present on the device.
 
211
 
 
212
   The number field specifies the valuator number on the physical
 
213
   device that this scroll information applies to. See the
 
214
   respective XIValuatorClassInfo for detailed information on this
 
215
   valuator.
 
216
 
 
217
   The scroll_type field specifies the type of scrolling, either
 
218
   XIScrollTypeVertical or XIScrollTypeHorizontal.
 
219
 
 
220
   The increment specifies the value change considered one unit of
 
221
   scrolling down.
 
222
 
 
223
   The flags field specifies flags that apply to this scrolling
 
224
   information:
 
225
 
 
226
   If XIScrollFlagNoEmulation is set, the server will not
 
227
   emulate legacy button events for valuator changes on this
 
228
   valuator.
 
229
 
 
230
   If XIScrollFlagPreferred is set, this axis is the
 
231
   preferred axis for this scroll type and will be used for
 
232
   the emulation of XI_Motion events when the driver submits
 
233
   legacy scroll button events.
 
234
 
 
235
               typedef struct
 
236
               {
 
237
                   int         type;
 
238
                   int         sourceid;
 
239
                   int         mode;
 
240
                   int         num_touches;
 
241
               } XITouchClassInfo;
 
242
 
 
243
   A device may have zero or one XITouchClassInfo, denoting
 
244
   multi-touch capability on the device. A device with a XITouchClassInfo
 
245
   may send TouchBegin, TouchUpdate, TouchEnd and TouchOwnership events.
 
246
 
 
247
   The mode field is either XIDirectTouch for direct-input touch devices
 
248
   such as touchscreens or XIDependentTouch for indirect input devices such
 
249
   as touchpads. For XIDirectTouch devices, touch events are sent to window
 
250
   at the position the touch occured. For XIDependentTouch devices, touch
 
251
   events are sent to the window at the position of the device's sprite.
 
252
 
 
253
   The num_touches field defines the maximum number of simultaneous touches
 
254
   the device supports. A num_touches of 0 means the maximum number of
 
255
   simultaneous touches is undefined or unspecified. This field should be
 
256
   used as a guide only, devices will lie about their capabilities.
 
257
 
 
258
   A device with an XITouchClassInfo may still send pointer events. The
 
259
   valuators must be defined with the respective XIValuatorClass
 
260
   classes. A valuator may send both pointer and touch-events.
 
261
 
197
262
   XIQueryDevice can generate a BadDevice error.
198
263
 
199
264
   XIFreeDeviceInfo frees the information returned by