← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/XIQueryDevice.man

  • 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.man
2
2
.\"     Title: xiquerydevice
3
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4
4
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5
 
.\"      Date: 06/02/2011
 
5
.\"      Date: 12/22/2011
6
6
.\"    Manual: [FIXME: manual]
7
7
.\"    Source: [FIXME: source]
8
8
.\"  Language: English
9
9
.\"
10
 
.TH "XIQUERYDEVICE" "libmansuffix" "06/02/2011" "[FIXME: source]" "[FIXME: manual]"
 
10
.TH "XIQUERYDEVICE" "libmansuffix" "12/22/2011" "[FIXME: source]" "[FIXME: manual]"
11
11
.\" -----------------------------------------------------------------
12
12
.\" * Define some portability stuff
13
13
.\" -----------------------------------------------------------------
217
217
.nf
218
218
The type field specifies the type of the input class\&.
219
219
Currently, the following types are defined:
220
 
    XIKeyClass, XIButtonClass, XIValuatorClass
 
220
    XIKeyClass, XIButtonClass, XIValuatorClass, XIScrollClass,
 
221
    XITouchClass
221
222
.fi
222
223
.if n \{\
223
224
.RE
404
405
    double      value;
405
406
    int         resolution;
406
407
    int         mode;
407
 
} XIValuatorInfo;
 
408
} XIValuatorClassInfo;
408
409
.fi
409
410
.if n \{\
410
411
.RE
471
472
.RS 4
472
473
.\}
473
474
.nf
 
475
typedef struct
 
476
{
 
477
    int         type;
 
478
    int         sourceid;
 
479
    int         number;
 
480
    int         scroll_type;
 
481
    double      increment;
 
482
    int         flags;
 
483
} XIScrollClassInfo;
 
484
.fi
 
485
.if n \{\
 
486
.RE
 
487
.\}
 
488
.sp
 
489
.if n \{\
 
490
.RS 4
 
491
.\}
 
492
.nf
 
493
This class describes scrolling capability on a valuator\&. For
 
494
each XIScrollClassInfo, an XIValuatorClassInfo with the same
 
495
number is present on the device\&.
 
496
.fi
 
497
.if n \{\
 
498
.RE
 
499
.\}
 
500
.sp
 
501
.if n \{\
 
502
.RS 4
 
503
.\}
 
504
.nf
 
505
The number field specifies the valuator number on the physical
 
506
device that this scroll information applies to\&. See the
 
507
respective XIValuatorClassInfo for detailed information on this
 
508
valuator\&.
 
509
.fi
 
510
.if n \{\
 
511
.RE
 
512
.\}
 
513
.sp
 
514
.if n \{\
 
515
.RS 4
 
516
.\}
 
517
.nf
 
518
The scroll_type field specifies the type of scrolling, either
 
519
XIScrollTypeVertical or XIScrollTypeHorizontal\&.
 
520
.fi
 
521
.if n \{\
 
522
.RE
 
523
.\}
 
524
.sp
 
525
.if n \{\
 
526
.RS 4
 
527
.\}
 
528
.nf
 
529
The increment specifies the value change considered one unit of
 
530
scrolling down\&.
 
531
.fi
 
532
.if n \{\
 
533
.RE
 
534
.\}
 
535
.sp
 
536
.if n \{\
 
537
.RS 4
 
538
.\}
 
539
.nf
 
540
The flags field specifies flags that apply to this scrolling
 
541
information:
 
542
.fi
 
543
.if n \{\
 
544
.RE
 
545
.\}
 
546
.sp
 
547
.if n \{\
 
548
.RS 4
 
549
.\}
 
550
.nf
 
551
If XIScrollFlagNoEmulation is set, the server will not
 
552
emulate legacy button events for valuator changes on this
 
553
valuator\&.
 
554
.fi
 
555
.if n \{\
 
556
.RE
 
557
.\}
 
558
.sp
 
559
.if n \{\
 
560
.RS 4
 
561
.\}
 
562
.nf
 
563
If XIScrollFlagPreferred is set, this axis is the
 
564
preferred axis for this scroll type and will be used for
 
565
the emulation of XI_Motion events when the driver submits
 
566
legacy scroll button events\&.
 
567
.fi
 
568
.if n \{\
 
569
.RE
 
570
.\}
 
571
.sp
 
572
.if n \{\
 
573
.RS 4
 
574
.\}
 
575
.nf
 
576
typedef struct
 
577
{
 
578
    int         type;
 
579
    int         sourceid;
 
580
    int         mode;
 
581
    int         num_touches;
 
582
} XITouchClassInfo;
 
583
.fi
 
584
.if n \{\
 
585
.RE
 
586
.\}
 
587
.sp
 
588
.if n \{\
 
589
.RS 4
 
590
.\}
 
591
.nf
 
592
A device may have zero or one XITouchClassInfo, denoting
 
593
multi\-touch capability on the device\&. A device with a XITouchClassInfo
 
594
may send TouchBegin, TouchUpdate, TouchEnd and TouchOwnership events\&.
 
595
.fi
 
596
.if n \{\
 
597
.RE
 
598
.\}
 
599
.sp
 
600
.if n \{\
 
601
.RS 4
 
602
.\}
 
603
.nf
 
604
The mode field is either XIDirectTouch for direct\-input touch devices
 
605
such as touchscreens or XIDependentTouch for indirect input devices such
 
606
as touchpads\&. For XIDirectTouch devices, touch events are sent to window
 
607
at the position the touch occured\&. For XIDependentTouch devices, touch
 
608
events are sent to the window at the position of the device\*(Aqs sprite\&.
 
609
.fi
 
610
.if n \{\
 
611
.RE
 
612
.\}
 
613
.sp
 
614
.if n \{\
 
615
.RS 4
 
616
.\}
 
617
.nf
 
618
The num_touches field defines the maximum number of simultaneous touches
 
619
the device supports\&. A num_touches of 0 means the maximum number of
 
620
simultaneous touches is undefined or unspecified\&. This field should be
 
621
used as a guide only, devices will lie about their capabilities\&.
 
622
.fi
 
623
.if n \{\
 
624
.RE
 
625
.\}
 
626
.sp
 
627
.if n \{\
 
628
.RS 4
 
629
.\}
 
630
.nf
 
631
A device with an XITouchClassInfo may still send pointer events\&. The
 
632
valuators must be defined with the respective XIValuatorClass
 
633
classes\&. A valuator may send both pointer and touch\-events\&.
 
634
.fi
 
635
.if n \{\
 
636
.RE
 
637
.\}
 
638
.sp
 
639
.if n \{\
 
640
.RS 4
 
641
.\}
 
642
.nf
474
643
XIQueryDevice can generate a BadDevice error\&.
475
644
.fi
476
645
.if n \{\