/usr/share/doc/libxi-dev/inputlib.html is in libxi-dev 2:1.7.4-1+deb8u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>X Input Device Extension Library</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><style xmlns="" type="text/css">/*
* Copyright (c) 2011 Gaetan Nadon
* Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
/*
* Shared stylesheet for X.Org documentation translated to HTML format
* http://www.sagehill.net/docbookxsl/UsingCSS.html
* http://www.w3schools.com/css/default.asp
* https://addons.mozilla.org/en-US/firefox/addon/web-developer/developers
* https://addons.mozilla.org/en-US/firefox/addon/font-finder/
*/
/*
* The sans-serif fonts are considered more legible on a computer screen
* http://dry.sailingissues.com/linux-equivalents-verdana-arial.html
*
*/
body {
font-family: "Bitstream Vera Sans", "DejaVu Sans", Tahoma, Geneva, Arial, Sans-serif;
/* In support of using "em" font size unit, the w3c recommended method */
font-size: 100%;
}
/*
* Selection: all elements requiring mono spaced fonts.
*
* The family names attempt to match the proportionally spaced font
* family names such that the same font name is used for both.
* We'd like to use Bitstream, for example, in both proportionally and
* mono spaced font text.
*/
.command,
.errorcode,
.errorname,
.errortype,
.filename,
.funcsynopsis,
.function,
.parameter,
.programlisting,
.property,
.screen,
.structname,
.symbol,
.synopsis,
.type
{
font-family: "Bitstream Vera Sans Mono", "DejaVu Sans Mono", Courier, "Liberation Mono", Monospace;
}
/*
* Books have a title page, a preface, some chapters and appendices,
* a glossary, an index and a bibliography, in that order.
*
* An Article has no preface and no chapters. It has sections, appendices,
* a glossary, an index and a bibliography.
*/
/*
* Selection: book main title and subtitle
*/
div.book>div.titlepage h1.title,
div.book>div.titlepage h2.subtitle {
text-align: center;
}
/*
* Selection: article main title and subtitle
*/
div.article>div.titlepage h2.title,
div.article>div.titlepage h3.subtitle,
div.article>div.sect1>div.titlepage h2.title,
div.article>div.section>div.titlepage h2.title {
text-align: center;
}
/*
* Selection: various types of authors and collaborators, individuals or corporate
*
* These authors are not always contained inside an authorgroup.
* They can be contained inside a lot of different parent types where they might
* not be centered.
* Reducing the margin at the bottom makes a visual separation between authors
* We specify here the ones on the title page, others may be added based on merit.
*/
div.titlepage .authorgroup,
div.titlepage .author,
div.titlepage .collab,
div.titlepage .corpauthor,
div.titlepage .corpcredit,
div.titlepage .editor,
div.titlepage .othercredit {
text-align: center;
margin-bottom: 0.25em;
}
/*
* Selection: the affiliation of various types of authors and collaborators,
* individuals or corporate.
*/
div.titlepage .affiliation {
text-align: center;
}
/*
* Selection: product release information (X Version 11, Release 7)
*
* The releaseinfo element can be contained inside a lot of different parent
* types where it might not be centered.
* We specify here the one on the title page, others may be added based on merit.
*/
div.titlepage p.releaseinfo {
font-weight: bold;
text-align: center;
}
/*
* Selection: publishing date
*/
div.titlepage .pubdate {
text-align: center;
}
/*
* The legal notices are displayed in smaller sized fonts
* Justification is only supported in IE and therefore not requested.
*
*/
.legalnotice {
font-size: small;
font-style: italic;
}
/*
* For documentation having multiple licenses, the copyright and legalnotice
* elements sequence cannot instantiated multiple times.
* The copyright notice and license text are therefore coded inside a legalnotice
* element. The role attribute on the paragraph is used to allow styling of the
* copyright notice text which should not be italicized.
*/
p.multiLicensing {
font-style: normal;
font-size: medium;
}
/*
* Selection: book or article main ToC title
* A paragraph is generated for the title rather than a level 2 heading.
* We do not want to select chapters sub table of contents, only the main one
*/
div.book>div.toc>p,
div.article>div.toc>p {
font-size: 1.5em;
text-align: center;
}
/*
* Selection: major sections of a book or an article
*
* Unlike books, articles do not have a titlepage element for appendix.
* Using the selector "div.titlepage h2.title" would be too general.
*/
div.book>div.preface>div.titlepage h2.title,
div.book>div.chapter>div.titlepage h2.title,
div.article>div.sect1>div.titlepage h2.title,
div.article>div.section>div.titlepage h2.title,
div.book>div.appendix>div.titlepage h2.title,
div.article>div.appendix h2.title,
div.glossary>div.titlepage h2.title,
div.index>div.titlepage h2.title,
div.bibliography>div.titlepage h2.title {
/* Add a border top over the major parts, just like printed books */
/* The Gray color is already used for the ruler over the main ToC. */
border-top-style: solid;
border-top-width: 2px;
border-top-color: Gray;
/* Put some space between the border and the title */
padding-top: 0.2em;
text-align: center;
}
/*
* A Screen is a verbatim environment for displaying text that the user might
* see on a computer terminal. It is often used to display the results of a command.
*
* http://www.css3.info/preview/rounded-border/
*/
.screen {
background: #e0ffff;
border-width: 1px;
border-style: solid;
border-color: #B0C4DE;
border-radius: 1.0em;
/* Browser's vendor properties prior to CSS 3 */
-moz-border-radius: 1.0em;
-webkit-border-radius: 1.0em;
-khtml-border-radius: 1.0em;
margin-left: 1.0em;
margin-right: 1.0em;
padding: 0.5em;
}
/*
* Emphasis program listings with a light shade of gray similar to what
* DocBook XSL guide does: http://www.sagehill.net/docbookxsl/ProgramListings.html
* Found many C API docs on the web using like shades of gray.
*/
.programlisting {
background: #F4F4F4;
border-width: 1px;
border-style: solid;
border-color: Gray;
padding: 0.5em;
}
/*
* Emphasis functions synopsis using a darker shade of gray.
* Add a border such that it stands out more.
* Set the padding so the text does not touch the border.
*/
.funcsynopsis, .synopsis {
background: #e6e6fa;
border-width: 1px;
border-style: solid;
border-color: Gray;
clear: both;
margin: 0.5em;
padding: 0.25em;
}
/*
* Selection: paragraphs inside synopsis
*
* Removes the default browser margin, let the container set the padding.
* Paragraphs are not always used in synopsis
*/
.funcsynopsis p,
.synopsis p {
margin: 0;
padding: 0;
}
/*
* Selection: variable lists, informal tables and tables
*
* Note the parameter name "variablelist.as.table" in xorg-xhtml.xsl
* A table with rows and columns is constructed inside div.variablelist
*
* Set the left margin so it is indented to the right
* Display informal tables with single line borders
*/
table {
margin-left: 0.5em;
border-collapse: collapse;
}
/*
* Selection: paragraphs inside tables
*
* Removes the default browser margin, let the container set the padding.
* Paragraphs are not always used in tables
*/
td p {
margin: 0;
padding: 0;
}
/*
* Add some space between the left and right column.
* The vertical alignment helps the reader associate a term
* with a multi-line definition.
*/
td, th {
padding-left: 1.0em;
padding-right: 1.0em;
vertical-align: top;
}
.warning {
border: 1px solid red;
background: #FFFF66;
padding-left: 0.5em;
}
</style></head><body><div class="book"><div class="titlepage"><div><div><h1 class="title"><a id="inputlib"></a>X Input Device Extension Library</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Mark</span> <span class="surname">Patrick</span></h3><div class="affiliation"><span class="orgname">Ardent Computer<br /></span></div></div><div class="othercredit"><h3 class="othercredit"><span class="firstname">George</span> <span class="surname">Sachs</span></h3><div class="affiliation"><span class="orgname">Hewlett-Packard<br /></span></div></div></div></div><div><p class="releaseinfo">X Version 11, Release 7.7</p></div><div><p class="releaseinfo">Version 1.0</p></div><div><p class="copyright">Copyright © 1989, 1990, 1991 Hewlett-Packard Company, Ardent Computer</p></div><div><div class="legalnotice"><a id="idm45418569064768"></a><p>
Permission to use, copy, modify, and distribute this documentation for any purpose and without
fee is hereby granted, provided that the above copyright notice and this permission notice appear
in all copies. Ardent and Hewlett-Packard make no representations about the suitability for any
purpose of the information in this document. It is provided "as is" without express or implied
warranty.
</p></div></div><div><div class="legalnotice"><a id="idm45418569479872"></a><p class="multiLicensing">
Copyright © 1989, 1990, 1991, 1992 X Consortium
</p><p>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the ‘‘Software’’), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
</p><p>
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
</p><p>
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
</p><p>
Except as contained in this notice, the name of the X Consortium shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from the X Consortium.
</p><p>X Window System is a trademark of The Open Group.</p></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="chapter"><a href="#idm45418571606240">1. Input Extension</a></span></dt><dd><dl><dt><span class="sect1"><a href="#Overview">Overview</a></span></dt><dd><dl><dt><span class="sect2"><a href="#Design_Approach">Design Approach</a></span></dt><dt><span class="sect2"><a href="#Core_Input_Devices">Core Input Devices</a></span></dt><dt><span class="sect2"><a href="#Extension_Input_Devices">Extension Input Devices</a></span></dt><dt><span class="sect2"><a href="#Using_Extension_Input_Devices">Using Extension Input Devices</a></span></dt></dl></dd><dt><span class="sect1"><a href="#Library_Extension_Requests">Library Extension Requests</a></span></dt><dd><dl><dt><span class="sect2"><a href="#Window_Manager_Functions">Window Manager Functions</a></span></dt><dt><span class="sect2"><a href="#Events">Events</a></span></dt><dt><span class="sect2"><a href="#Event_Handling_Functions">Event Handling Functions</a></span></dt></dl></dd></dl></dd><dt><span class="appendix"><a href="#Input_Extension_Protocol_Encoding">A. Input Extension Protocol Encoding</a></span></dt></dl></div><div class="chapter"><div class="titlepage"><div><div><h1 class="title"><a id="idm45418571606240"></a>Chapter 1. Input Extension</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="sect1"><a href="#Overview">Overview</a></span></dt><dd><dl><dt><span class="sect2"><a href="#Design_Approach">Design Approach</a></span></dt><dt><span class="sect2"><a href="#Core_Input_Devices">Core Input Devices</a></span></dt><dt><span class="sect2"><a href="#Extension_Input_Devices">Extension Input Devices</a></span></dt><dt><span class="sect2"><a href="#Using_Extension_Input_Devices">Using Extension Input Devices</a></span></dt></dl></dd><dt><span class="sect1"><a href="#Library_Extension_Requests">Library Extension Requests</a></span></dt><dd><dl><dt><span class="sect2"><a href="#Window_Manager_Functions">Window Manager Functions</a></span></dt><dt><span class="sect2"><a href="#Events">Events</a></span></dt><dt><span class="sect2"><a href="#Event_Handling_Functions">Event Handling Functions</a></span></dt></dl></dd></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Overview"></a>Overview</h2></div></div></div><p>
This document describes an extension to
the X11 server. The purpose of this extension is to support the use
of additional input devices beyond the pointer and keyboard devices
defined by the core X protocol. This first section gives an overview
of the input extension. The following sections correspond to
chapters 9, 10, and 11, ``Window and Session Manager Functions'',
``Events'', and ``Event Handling Functions'' of the
``Xlib - C Language Interface'' manual
and describe how to use the input device extension.
</p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Design_Approach"></a>Design Approach</h3></div></div></div><p>
The design approach of the extension is to define functions
and events analogous to the core functions and events.
This allows extension input devices and events to be individually
distinguishable from each other and from the core input devices and events.
These functions and events make use of a device identifier and support the
reporting of <span class="emphasis"><em>n</em></span>-dimensional motion data as well as other data that
is not currently reportable via the core input events.
</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Core_Input_Devices"></a>Core Input Devices</h3></div></div></div><p>
The X server core protocol supports two input devices: a pointer and a
keyboard. The pointer device has two major functions.
First, it may be used to generate motion information
that client programs can detect. Second, it may also be used to indicate the
current location and focus of the X keyboard. To accomplish this, the server
echoes a cursor at the current position of the X pointer. Unless the X
keyboard has been explicitly focused, this cursor also shows the current
location and focus of the X keyboard.
</p><p>
The X keyboard is used to generate input that client programs can detect.
</p><p>
The X keyboard and X pointer are referred to in this document as
the <span class="emphasis"><em>core devices</em></span>, and the input
events they generate
<code class="function">( KeyPress ,</code>
<code class="function">KeyRelease ,</code>
<code class="function">ButtonPress ,</code>
<code class="function">ButtonRelease ,</code>
and
<code class="function">MotionNotify )</code>
are known as the <span class="emphasis"><em>core input events</em></span>. All other
input devices are referred to as <span class="emphasis"><em>extension input devices</em></span>, and the
input events they generate are referred to as <span class="emphasis"><em>extension input events</em></span>.
This input extension does not change the behavior or functionality of the
core input devices, core events, or core protocol requests, with the
exception of the core grab requests. These requests may affect the
synchronization of events from extension devices. See the explanation
in the section titled ``Event Synchronization and Core Grabs.''
</p><p>
Selection of the physical devices to be initially used by the server as the
core devices is left implementation dependent. Functions are defined that
allow client programs to change which physical devices are used as the
core devices.
</p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Extension_Input_Devices"></a>Extension Input Devices</h3></div></div></div><p>
The input extension controls access to input devices other than the X keyboard
and X pointer. It allows client programs to select input from these devices
independently
from each other and independently from the core devices. Input events from
these devices are of extension types
<code class="function">( DeviceKeyPress ,</code>
<code class="function">DeviceKeyRelease ,</code>
<code class="function">DeviceButtonPress ,</code>
<code class="function">DeviceButtonRelease ,</code>
<code class="function">DeviceMotionNotify ,</code>
and so on) and contain
a device identifier so that events of the same type coming from different
input devices can be distinguished.
</p><p>
Extension input events are not limited in size by the size of the server
32-byte wire events. Extension input events
may be constructed by the server sending as many
wire-sized events as necessary to return the information required for
that event.
The library event reformatting routines
are responsible for combining these into one or more client XEvents.
</p><p>
Any input device that generates key, button, or motion data may be used as
an extension input device.
Extension input devices may have zero or more keys, zero or more buttons,
and may report zero or more axes of motion. Motion may be reported
as relative movements from a previous position or as an absolute
position. All valuators reporting motion information for a given
extension input device must report the same kind of motion information
(absolute or relative).
</p><p>
This extension is designed to accommodate new types of input devices that
may be added in the future. The protocol requests that refer to
specific characteristics of input devices organize that information
by <span class="emphasis"><em>input device classes</em></span>. Server implementors may add new
classes of input devices without changing the protocol requests.
</p><p>
All extension input
devices are treated like the core X keyboard in determining their location
and focus. The server does not track the location of these devices on an
individual basis and, therefore,
does not echo a cursor to indicate their current location.
Instead, their location is determined by the location of the core X pointer.
Like the core X keyboard, some may be explicitly focused. If they are
not explicitly focused, their focus
is determined by the location of the core X pointer.
</p><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Input_Device_Classes"></a>Input Device Classes</h4></div></div></div><p>
Some of the input extension requests divide input devices into classes
based on their functionality. This is intended to allow new classes of input
devices to be defined at a later time without changing the semantics of
these functions. The following input device classes are currently
defined:
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">KEY</span></p></td><td><p>
The device reports key events.
</p></td></tr><tr><td><p><span class="term">BUTTON</span></p></td><td><p>
The device reports button events.
</p></td></tr><tr><td><p><span class="term">VALUATOR</span></p></td><td><p>
The device reports valuator data in motion events.
</p></td></tr><tr><td><p><span class="term">PROXIMITY</span></p></td><td><p>
The device reports proximity events.
</p></td></tr><tr><td><p><span class="term">FOCUS</span></p></td><td><p>
The device can be focused.
</p></td></tr><tr><td><p><span class="term">FEEDBACK</span></p></td><td><p>
The device supports feedbacks.
</p></td></tr></tbody></table></div><p>
</p><p>
Additional classes may be added in the future.
Functions that support multiple input classes, such as the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
function that lists all available input devices,
organize the data they return by input class. Client programs that
use these functions should not access data unless it matches a
class defined at the time those clients were compiled. In this way,
new classes can be added without forcing existing clients that use
these functions to be recompiled.
</p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Using_Extension_Input_Devices"></a>Using Extension Input Devices</h3></div></div></div><p>
A client that wishes to access an input device does so through the library
functions defined in the following sections. A typical sequence of requests
that a client would make is as follows:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
- lists all of the available input devices. From the
information returned by this request, determine whether the desired input
device is attached to the server. For a description of the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
request, see the section entitled ``Listing Available Devices.''
</p></li><li class="listitem"><p>
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
- requests that the server open the device for access by this client.
This request returns an
<code class="function">XDevice</code>
structure that is used
by most other input extension requests to identify the specified device.
For a description of the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
request, see the section entitled ``Enabling and Disabling Extension Devices.''
</p></li><li class="listitem"><p>
Determine the event types and event classes needed to select the desired
input extension events, and identify them when they are received.
This is done via macros whose name corresponds to the desired event, for
example,
<code class="function">DeviceKeyPress .</code>
For a description of these macros,
see the section entitled ``Selecting Extension Device Events.''
</p></li><li class="listitem"><p>
<a class="xref" href="#XSelectExtensionEvent"><code class="function"> XSelectExtensionEvent</code></a>
- selects the desired events from the server.
For a description of the
<code class="function">XSelextExtensionEvent</code>
request, see the section entitled ``Selecting Extension Device Events.''
</p></li><li class="listitem"><p>
<span class="olink"><code class="function">XNextEvent</code></span>
- receives the next available event. This is the core
<span class="olink"><code class="function">XNextEvent</code></span>
function provided by the standard X libarary.
</p></li></ul></div><p>
Other requests are defined to grab and focus extension devices, to
change their key, button, or modifier mappings, to control the
propagation of input extension events, to get motion history from an
extension device, and to send input extension events to another client.
These functions are described in the following sections.
</p></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Library_Extension_Requests"></a>Library Extension Requests</h2></div></div></div><p>
Extension input devices are accessed by client programs through the
use of new protocol requests.
The following requests are provided as extensions to Xlib. Constants
and structures referenced by these functions may be found in the
files <code class="function"><X11/extensions/XI.h></code> and <code class="function"><X11/extensions/XInput.h></code>,
which are attached to this document as
Appendix A.
</p><p>
The library will return <code class="function">NoSuchExtension</code> if an extension request
is made to a server that does not support the input extension.
</p><p>
Input extension requests cannot be used to access the X keyboard and
X pointer devices.
</p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Window_Manager_Functions"></a>Window Manager Functions</h3></div></div></div><p>
This section discusses the following X Input Extension Window Manager topics:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
Changing the core devices
</p></li><li class="listitem"><p>
Event synchronization and core grabs
</p></li><li class="listitem"><p>
Extension active grabs
</p></li><li class="listitem"><p>
Passively grabbing a key
</p></li><li class="listitem"><p>
Passively grabbing a button
</p></li><li class="listitem"><p>
Thawing a device
</p></li><li class="listitem"><p>
Controlling device focus
</p></li><li class="listitem"><p>
Controlling device feedback
</p></li><li class="listitem"><p>
Ringing a bell on an input device
</p></li><li class="listitem"><p>
Controlling device encoding
</p></li><li class="listitem"><p>
Controlling button mapping
</p></li><li class="listitem"><p>
Obtaining the state of a device
</p></li></ul></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Changing_the_Core_Devices"></a>Changing the Core Devices</h4></div></div></div><p>
These functions are provided to change which physical device is used
as the X pointer or X keyboard.
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
Using these functions may change the characteristics of the core devices.
The new pointer device may have a different number of buttons from the
old one, or the new keyboard device may have a different number of
keys or report a different range of keycodes. Client programs may be
running that depend on those characteristics. For example, a client
program could allocate an array based on the number of buttons on the
pointer device and then use the button numbers received in button events
as indices into that array. Changing the core devices could cause
such client programs to behave improperly or to terminate abnormally
if they ignore the
<code class="function">ChangeDeviceNotify</code>
event generated by these requests.
</p></div><p>
These functions change the X keyboard or X pointer device and generate an
<code class="function">XChangeDeviceNotify</code>
event and a
<code class="function">MappingNotify</code>
event.
The specified device becomes the
new X keyboard or X pointer device. The location of the core device
does not change as a result of this request.
</p><p>
These requests fail and return
<code class="function">AlreadyGrabbed</code>
if either the specified
device or the core device it would replace are grabbed by some other client.
They fail and return
<code class="function">GrabFrozen</code>
if either device is frozen by the active grab of another client.
</p><p>
These requests fail with a
<code class="function">BadDevice</code>
error if the specified device is invalid, has not previously been opened via
<code class="function">XOpenDevice ,</code>
or is
not supported as a core device by the server implementation.
</p><p>
Once the device has successfully replaced one of the core devices, it
is treated as a core device until it is in turn replaced by another
<code class="function">ChangeDevice</code>
request or until the server terminates. The termination
of the client that changed the device will not cause it to change back.
Attempts to use the
<a class="xref" href="#XCloseDevice"><code class="function"> XCloseDevice</code></a>
request to close the new core device will fail with a
<code class="function">BadDevice</code>
error.
</p><p>
To change which physical device is used as the X keyboard, use the
<a class="xref" href="#XChangeKeyboardDevice"><code class="function"> XChangeKeyboardDevice</code></a>
function.
The specified device must support input class
<code class="function">Keys</code>
(as reported in the
<code class="function">ListInputDevices</code>
request) or the request will fail with a
<code class="function">BadMatch</code>
error.
</p><p>
</p><div class="funcsynopsis"><a id="XChangeKeyboardDevice"></a><p><code class="funcdef">int <strong class="fsfunc"> XChangeKeyboardDevice</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr></tbody></table></div><p>
</p><p>
If no error occurs,
<a class="xref" href="#XChangeKeyboardDevice"><code class="function"> XChangeKeyboardDevice</code></a>
returns
<code class="function">Success .</code>
A
<code class="function">ChangeDeviceNotify</code>
event with the request field set to
<code class="function">NewKeyboard</code>
is sent to all clients selecting that event.
A
<code class="function">MappingNotify</code>
event with the request field set to
<code class="function">MappingKeyboard</code>
is sent to all clients.
The requested device becomes the X keyboard, and the old keyboard becomes
available as an extension input device.
The focus state of the new keyboard is the same as
the focus state of the old X keyboard.
</p><p>
<a class="xref" href="#XChangeKeyboardDevice"><code class="function"> XChangeKeyboardDevice</code></a>
can generate
<code class="function">AlreadyGrabbed ,</code>
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
and
<code class="function">GrabFrozen</code>
errors.
</p><p>
To change which physical device is used as the X pointer,
use the
<a class="xref" href="#XChangePointerDevice"><code class="function"> XChangePointerDevice</code></a>
function.
The specified device must support input class
<code class="function">Valuators</code>
(as reported in the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
request) and report at least two axes of motion,
or the request will fail with a
<code class="function">BadMatch</code>
error.
If the specified device reports more than two axes, the two specified in
the xaxis and yaxis arguments will be used. Data from other
valuators on the device will be ignored.
</p><p>
If the specified device reports absolute positional information, and the
server implementation does not allow such a device to be used as the
X pointer, the request will fail with a
<code class="function">BadDevice</code>
error.
</p><div class="funcsynopsis"><a id="XChangePointerDevice"></a><p><code class="funcdef">int <strong class="fsfunc"> XChangePointerDevice</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int<var class="pdparam"> xaxis</var>, int<var class="pdparam"> yaxis</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>xaxis</em></span>
</span></p></td><td><p>
Specifies the zero-based index of the axis to be used as the x-axis of the
pointer device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>yaxis</em></span>
</span></p></td><td><p>
Specifies the zero-based index of the axis to be used as the y-axis of the
pointer device.
</p></td></tr></tbody></table></div><p>
</p><p>
If no error occurs,
<a class="xref" href="#XChangePointerDevice"><code class="function"> XChangePointerDevice</code></a>
returns
<code class="function">Success .</code>
A
<code class="function">ChangeDeviceNotify</code>
event with the request field set to
<code class="function">NewPointer</code>
is sent to all clients selecting that event.
A
<code class="function">MappingNotify</code>
event with the request field set to
<code class="function">MappingPointer</code>
is sent to all clients.
The requested device becomes the X pointer, and the old pointer becomes
available as an extension input device.
</p><p>
<a class="xref" href="#XChangePointerDevice"><code class="function"> XChangePointerDevice</code></a>
can generate
<code class="function">AlreadyGrabbed ,</code>
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
and
<code class="function">GrabFrozen</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Event_Synchronization_and_Core_Grabs"></a>Event Synchronization and Core Grabs</h4></div></div></div><p>
Implementation of the input extension requires an extension of the
meaning of event synchronization for the core grab requests. This is
necessary in order to allow window managers to freeze all input devices
with a single request.
</p><p>
The core grab requests require a pointer_mode and keyboard_mode
argument. The meaning of these modes is changed by the input extension.
For the
<span class="olink"><code class="function">XGrabPointer</code></span>
and
<span class="olink"><code class="function">XGrabButton</code></span>
requests, pointer_mode controls synchronization of the pointer device,
and keyboard_mode controls the synchronization of all other input devices.
For the
<span class="olink"><code class="function">XGrabKeyboard</code></span>
and
<span class="olink"><code class="function">XGrabKey</code></span>
requests, pointer_mode controls the synchronization
of all input devices, except the X keyboard, while keyboard_mode controls
the synchronization of the keyboard. When using one of the core grab
requests, the synchronization of extension devices
is controlled by the mode specified for the device not being grabbed.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Extension_Active_Grabs"></a>Extension Active Grabs</h4></div></div></div><p>
Active grabs of
extension devices are supported via the
<a class="xref" href="#XGrabDevice"><code class="function"> XGrabDevice</code></a>
function in the same way that core devices are grabbed using the core
<span class="olink"><code class="function">XGrabKeyboard</code></span>
function, except that an extension input device
is passed as a function parameter.
The
<a class="xref" href="#XUngrabDevice"><code class="function"> XUngrabDevice</code></a>
function allows a previous active grab for an extension device to be released.
</p><p>
Passive grabs of buttons and keys on extension devices are supported
via the
<a class="xref" href="#XGrabDeviceButton"><code class="function"> XGrabDeviceButton</code></a>
and
<a class="xref" href="#XGrabDeviceKey"><code class="function"> XGrabDeviceKey</code></a>
functions.
These passive grabs are released via the
<a class="xref" href="#XUngrabDeviceKey"><code class="function"> XUngrabDeviceKey</code></a>
and
<a class="xref" href="#XUngrabDeviceButton"><code class="function"> XUngrabDeviceButton</code></a>
functions.
</p><p>
To grab an extension device, use the
<a class="xref" href="#XGrabDevice"><code class="function"> XGrabDevice</code></a>
function.
The device must have previously been opened using the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
function.
</p><div class="funcsynopsis"><a id="XGrabDevice"></a><p><code class="funcdef">int <strong class="fsfunc"> XGrabDevice</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, Window<var class="pdparam"> grab_window</var>, Bool<var class="pdparam"> owner_events</var>, int<var class="pdparam"> event_count</var>, XEventClass<var class="pdparam"> *event_list</var>, int<var class="pdparam"> this_device_mode</var>, int<var class="pdparam"> other_device_mode</var>, Time<var class="pdparam"> time</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
"<span class="emphasis"><em>display</em></span>"
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>grab_window</em></span>
</span></p></td><td><p>
Specifies the ID of a window associated with the device specified above.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>owner_events</em></span>
</span></p></td><td><p>
Specifies a boolean value of either
<code class="function">True</code>
or
<code class="function">False .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_count</em></span>
</span></p></td><td><p>
Specifies the number of elements in the event_list array.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_list</em></span>
</span></p></td><td><p>
Specifies a pointer to a list of event classes that indicate which events
the client wishes to receive.
These event classes must have been obtained
using the device being grabbed.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>this_device_mode</em></span>
</span></p></td><td><p>
Controls further processing of events from this device. You can pass one
of these constants:
<code class="function">GrabModeSync</code>
or
<code class="function">GrabModeAsync .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>other_device_mode</em></span>
</span></p></td><td><p>
Controls further processing of events from all other devices. You can pass one
of these constants:
<code class="function">GrabModeSync</code>
or
<code class="function">GrabModeAsync .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>time</em></span>
</span></p></td><td><p>
Specifies the time. This may be either a timestamp expressed in
milliseconds or
<code class="function">CurrentTime .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGrabDevice"><code class="function"> XGrabDevice</code></a>
actively grabs an extension input device and generates
<code class="function">DeviceFocusIn</code>
and
<code class="function">DeviceFocusOut</code>
events.
Further input events from this device are reported only to the grabbing client.
This function overrides any previous active grab by this client for this device.
</p><p>
The event_list parameter is a pointer to a list of event classes. This list
indicates which events the client wishes to receive while the grab is active.
If owner_events is
<code class="function">False ,</code>
input events from this device are reported with respect to
grab_window and are reported only if specified in event_list.
If owner_events is
<code class="function">True ,</code>
then if a generated event would normally be reported to this client,
it is reported normally.
Otherwise, the event is reported with respect to the grab_window and is only
reported if specified in event_list.
</p><p>
The this_device_mode argument controls the further processing
of events from this device, and the other_device_mode argument controls
the further processing of input events from all other devices.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
If the this_device_mode argument is
<code class="function">GrabModeAsync ,</code>
device event processing continues
normally; if the device is currently frozen by this client, then
processing of device events is resumed.
If the this_device_mode argument is
<code class="function">GrabModeSync ,</code>
the state of the grabbed device
(as seen by client applications) appears to freeze,
and no further device events are generated by the server until the
grabbing client issues a releasing
<a class="xref" href="#XAllowDeviceEvents"><code class="function"> XAllowDeviceEvents</code></a>
call or until the device grab is released.
Actual device input events are not lost while the device is frozen; they are
simply queued for later processing.
</p></li><li class="listitem"><p>
If the other_device_mode is
<code class="function">GrabModeAsync ,</code>
event processing from other input devices is unaffected
by activation of the grab.
If other_device_mode is
<code class="function">GrabModeSync ,</code>
the state of all devices except the grabbed device
(as seen by client applications) appears to freeze, and no further
events are generated by the server until the grabbing client issues a
releasing
<span class="olink"><code class="function">XAllowEvents</code></span>
or
<a class="xref" href="#XAllowDeviceEvents"><code class="function"> XAllowDeviceEvents</code></a>
call or until the device grab is released.
Actual events are not lost
while the other devices are frozen; they are simply queued for later
processing.
</p></li></ul></div><p>
<a class="xref" href="#XGrabDevice"><code class="function"> XGrabDevice</code></a>
fails on the following conditions:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
If the device is actively grabbed by some other client, it returns
<code class="function">AlreadyGrabbed .</code>
</p></li><li class="listitem"><p>
If grab_window is not viewable, it returns
<code class="function">GrabNotViewable .</code>
</p></li><li class="listitem"><p>
If the specified time is earlier
than the last-grab-time for the specified device
or later than the current X server time, it returns
<code class="function">GrabInvalidTime .</code>
Otherwise,
the last-grab-time for the specified device is set
to the specified time and
<code class="function">CurrentTime</code>
is replaced by the current X server time.
</p></li><li class="listitem"><p>
If the device is frozen by an active grab of another client, it returns
<code class="function">GrabFrozen .</code>
</p></li></ul></div><p>
If a grabbed device is closed by a client while an active grab by that
client is in effect, that active grab will be released.
Any passive grabs established by that client will be released.
If the device is frozen only by an active grab
of the requesting client, it is thawed.
</p><p>
<a class="xref" href="#XGrabDevice"><code class="function"> XGrabDevice</code></a>
can generate
<code class="function">BadClass ,</code>
<code class="function">BadDevice ,</code>
<code class="function">BadValue ,</code>
and
<code class="function">BadWindow</code>
errors.
</p><p>
To release a grab of an extension device, use the
<a class="xref" href="#XUngrabDevice"><code class="function"> XUngrabDevice</code></a>
function.
</p><p>
</p><div class="funcsynopsis"><a id="XUngrabDevice"></a><p><code class="funcdef">int <strong class="fsfunc"> XUngrabDevice</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, Time<var class="pdparam"> time</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>time</em></span>
</span></p></td><td><p>
Specifies the time. This may be either a timestamp expressed in
milliseconds, or
<code class="function">CurrentTime .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XUngrabDevice"><code class="function"> XUngrabDevice</code></a>
allows a client to release an extension input device and any
queued events if this client has it grabbed from either
<a class="xref" href="#XGrabDevice"><code class="function"> XGrabDevice</code></a>
or
<code class="function">XGrabDeviceKey .</code>
If any other devices are frozen by the grab,
<a class="xref" href="#XUngrabDevice"><code class="function"> XUngrabDevice</code></a>
thaws them.
This function does not release the device and any
queued events if the specified time is earlier than the last-device-grab
time or is later than the current X server time. It also generates
<code class="function">DeviceFocusIn</code>
and
<code class="function">DeviceFocusOut</code>
events. The X server automatically performs an
<a class="xref" href="#XUngrabDevice"><code class="function"> XUngrabDevice</code></a>
if the event window for an active device grab becomes not viewable
or if the client terminates without releasing the grab.
</p><p>
<a class="xref" href="#XUngrabDevice"><code class="function"> XUngrabDevice</code></a>
can generate
<code class="function">BadDevice</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Passively_Grabbing_a_Key"></a>Passively Grabbing a Key</h4></div></div></div><p>
To passively grab a single key on an extension device, use
<code class="function">XGrabDeviceKey .</code>
That device must have previously been opened using the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
function, or the request will fail with a
<code class="function">BadDevice</code>
error.
If the specified device does not support input class
<code class="function">Keys ,</code>
the request will fail with a
<code class="function">BadMatch</code>
error.
</p><div class="funcsynopsis"><a id="XGrabDeviceKey"></a><p><code class="funcdef">int <strong class="fsfunc"> XGrabDeviceKey</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int<var class="pdparam"> keycode</var>, unsignedint<var class="pdparam"> modifiers</var>, XDevice<var class="pdparam"> *modifier_device</var>, Window<var class="pdparam"> grab_window</var>, Bool<var class="pdparam"> owner_events</var>, int<var class="pdparam"> event_count</var>, XEventClass<var class="pdparam"> *event_list</var>, int<var class="pdparam"> this_device_mode</var>, int<var class="pdparam"> other_device_mode</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>keycode</em></span>
</span></p></td><td><p>
Specifies the keycode of the key that is to be grabbed. You can pass
either the keycode or
<code class="function">AnyKey .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>modifiers</em></span>
</span></p></td><td><p>
Specifies the set of keymasks. This mask is the bitwise inclusive OR
of these keymask bits:
<code class="function">ShiftMask ,</code>
<code class="function">LockMask ,</code>
<code class="function">ControlMask ,</code>
<code class="function">Mod1Mask ,</code>
<code class="function">Mod2Mask ,</code>
<code class="function">Mod3Mask ,</code>
<code class="function">Mod4Mask ,</code>
and
<code class="function">Mod5Mask .</code>
</p></td></tr><tr><td><p><span class="term">
</span></p></td><td><p>
You can also pass
<code class="function">AnyModifier ,</code>
which is equivalent to issuing the grab key request
for all possible modifier combinations (including the combination
of no modifiers).
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>modifier_device</em></span>
</span></p></td><td><p>
Specifies the device whose modifiers are to be used. If NULL is
specified, the core X keyboard is used as the modifier_device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>grab_window</em></span>
</span></p></td><td><p>
Specifies the ID of a window associated with the device specified above.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>owner_events</em></span>
</span></p></td><td><p>
Specifies a boolean value of either
<code class="function">True</code>
or
<code class="function">False .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_count</em></span>
</span></p></td><td><p>
Specifies the number of elements in the event_list array.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_list</em></span>
</span></p></td><td><p>
Specifies a pointer to a list of event classes that indicate which events
the client wishes to receive.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>this_device_mode</em></span>
</span></p></td><td><p>
Controls further processing of events from this device.
You can pass one of these constants:
<code class="function">GrabModeSync</code>
or
<code class="function">GrabModeAsync .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>other_device_mode</em></span>
</span></p></td><td><p>
Controls further processing of events from all other devices.
You can pass one of these constants:
<code class="function">GrabModeSync</code>
or
<code class="function">GrabModeAsync .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGrabDeviceKey"><code class="function"> XGrabDeviceKey</code></a>
is analogous to the core
<span class="olink"><code class="function">XGrabKey</code></span>
function. It creates an
explicit passive grab for a key on an extension device.
The
<a class="xref" href="#XGrabDeviceKey"><code class="function"> XGrabDeviceKey</code></a>
function establishes a passive grab on a device.
Consequently, in the future,
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
IF the device is not grabbed and the specified key,
which itself can be a modifier key, is logically pressed
when the specified modifier keys logically are down on the specified
modifier device (and no other keys are down),
</p></li><li class="listitem"><p>
AND no other modifier keys logically are down,
</p></li><li class="listitem"><p>
AND EITHER the grab window is an ancestor of (or is) the focus window
or the grab window is a descendent of the focus window and contains the pointer,
</p></li><li class="listitem"><p>
AND a passive grab on the same device and key combination does not exist on any
ancestor of the grab window,
</p></li><li class="listitem"><p>
THEN the device is actively grabbed, as for
<code class="function">XGrabDevice ,</code>
the last-device-grab time is set to the time at which the key was pressed
(as transmitted in the
<code class="function">DeviceKeyPress</code>
event), and the
<code class="function">DeviceKeyPress</code>
event is reported.
</p></li></ul></div><p>
The interpretation of the remaining arguments is as for
<code class="function">XGrabDevice .</code>
The active grab is terminated automatically when the logical state of the
device has the specified key released
(independent of the logical state of the modifier keys).
</p><p>
Note that the logical state of a device (as seen by means of the X protocol)
may lag the physical state if device event processing is frozen.
</p><p>
A modifier of
<code class="function">AnyModifier</code>
is equivalent to issuing the request for all
possible modifier combinations (including the combination of no modifiers).
It is not required that all modifiers specified have
currently assigned keycodes.
A key of
<code class="function">AnyKey</code>
is equivalent to issuing
the request for all possible keycodes. Otherwise, the key must be in
the range specified by min_keycode and max_keycode in the
information returned by the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
function.
If it is not within that range,
<a class="xref" href="#XGrabDeviceKey"><code class="function"> XGrabDeviceKey</code></a>
generates a
<code class="function">BadValue</code>
error.
</p><p>
<a class="xref" href="#XGrabDeviceKey"><code class="function"> XGrabDeviceKey</code></a>
generates a
<code class="function">BadAccess</code>
error if some other client has issued a
<a class="xref" href="#XGrabDeviceKey"><code class="function"> XGrabDeviceKey</code></a>
with the same device and key combination on the same window.
When using
<code class="function">AnyModifier</code>
or
<code class="function">AnyKey ,</code>
the request fails completely and the X server generates a
<code class="function">BadAccess</code>
error, and no grabs are established if there is a conflicting grab
for any combination.
</p><p>
<a class="xref" href="#XGrabDeviceKey"><code class="function"> XGrabDeviceKey</code></a>
returns
<code class="function">Success</code>
upon successful completion of the request.
</p><p>
<a class="xref" href="#XGrabDeviceKey"><code class="function"> XGrabDeviceKey</code></a>
can generate
<code class="function">BadAccess ,</code>
<code class="function">BadClass ,</code>
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
<code class="function">BadValue ,</code>
and
<code class="function">BadWindow</code>
errors.
</p><p>
To release a passive grab of a single key on an extension device, use
<code class="function">XUngrabDeviceKey .</code>
</p><div class="funcsynopsis"><a id="XUngrabDeviceKey"></a><p><code class="funcdef">int <strong class="fsfunc"> XUngrabDeviceKey</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int<var class="pdparam"> keycode</var>, unsignedint<var class="pdparam"> modifiers</var>, XDevice<var class="pdparam"> *modifier_device</var>, Window<var class="pdparam"> ungrab_window</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>keycode</em></span>
</span></p></td><td><p>
Specifies the keycode of the key that is to be ungrabbed. You can pass
either the keycode or
<code class="function">AnyKey .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>modifiers</em></span>
</span></p></td><td><p>
Specifies the set of keymasks. This mask is the bitwise inclusive OR
of these keymask bits:
<code class="function">ShiftMask ,</code>
<code class="function">LockMask ,</code>
<code class="function">ControlMask , </code>
<code class="function">Mod1Mask ,</code>
<code class="function">Mod2Mask ,</code>
<code class="function">Mod3Mask ,</code>
<code class="function">Mod4Mask ,</code>
and
<code class="function">Mod5Mask .</code>
</p></td></tr><tr><td><p><span class="term">
</span></p></td><td><p>
You can also pass
<code class="function">AnyModifier ,</code>
which is equivalent to issuing the ungrab key
request for all possible modifier combinations (including the combination
of no modifiers).
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>modifier_device</em></span>
</span></p></td><td><p>
Specifies the device whose modifiers are to be used. If NULL is
specified, the core X keyboard is used as the modifier_device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>ungrab_window</em></span>
</span></p></td><td><p>
Specifies the ID of a window associated with the device specified above.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XUngrabDeviceKey"><code class="function"> XUngrabDeviceKey</code></a>
is analogous to the core
<span class="olink"><code class="function">XUngrabKey</code></span>
function. It releases an explicit passive grab for a key
on an extension input device.
</p><p>
<a class="xref" href="#XUngrabDeviceKey"><code class="function"> XUngrabDeviceKey</code></a>
can generate
<code class="function">BadAlloc ,</code>
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
<code class="function">BadValue ,</code>
and
<code class="function">BadWindow</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Passively_Grabbing_a_Button"></a>Passively Grabbing a Button</h4></div></div></div><p>
To establish a passive grab for a single button on an extension device, use
<code class="function">XGrabDeviceButton .</code>
The specified device must have previously been opened using the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
function, or the request will fail with a
<code class="function">BadDevice</code>
error. If the specified device does not support input class
<code class="function">Buttons ,</code>
the request will fail with a
<code class="function">BadMatch</code>
error.
</p><div class="funcsynopsis"><a id="XGrabDeviceButton"></a><p><code class="funcdef">int <strong class="fsfunc"> XGrabDeviceButton</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, unsignedint<var class="pdparam"> button</var>, unsignedint<var class="pdparam"> modifiers</var>, XDevice*modifier_device<var class="pdparam"> </var>, Window<var class="pdparam"> grab_window</var>, Bool<var class="pdparam"> owner_events</var>, int<var class="pdparam"> event_count</var>, XEventClass<var class="pdparam"> *event_list</var>, int<var class="pdparam"> this_device_mode</var>, int<var class="pdparam"> other_device_mode</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>button</em></span>
</span></p></td><td><p>
Specifies the code of the button that is to be grabbed. You can pass
either the button or
<code class="function">AnyButton .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>modifiers</em></span>
</span></p></td><td><p>
Specifies the set of keymasks. This mask is the bitwise inclusive OR
of these keymask bits:
<code class="function">ShiftMask ,</code>
<code class="function">LockMask ,</code>
<code class="function">ControlMask , </code>
<code class="function">Mod1Mask ,</code>
<code class="function">Mod2Mask ,</code>
<code class="function">Mod3Mask ,</code>
<code class="function">Mod4Mask ,</code>
and
<code class="function">Mod5Mask .</code>
</p></td></tr><tr><td><p><span class="term">
</span></p></td><td><p>
You can also pass
<code class="function">AnyModifier ,</code>
which is equivalent to issuing the grab request
for all possible modifier combinations (including the combination
of no modifiers).
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>modifier_device</em></span>
</span></p></td><td><p>
Specifies the device whose modifiers are to be used. If NULL is
specified, the core X keyboard is used as the modifier_device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>grab_window</em></span>
</span></p></td><td><p>
Specifies the ID of a window associated with the device specified above.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>owner_events</em></span>
</span></p></td><td><p>
Specifies a boolean value of either
<code class="function">True</code>
or
<code class="function">False .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_count</em></span>
</span></p></td><td><p>
Specifies the number of elements in the event_list array.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_list</em></span>
</span></p></td><td><p>
Specifies a list of event classes that indicates which device events are to be
reported to the client.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>this_device_mode</em></span>
</span></p></td><td><p>
Controls further processing of events from this device. You can pass one
of these constants:
<code class="function">GrabModeSync</code>
or
<code class="function">GrabModeAsync .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>other_device_mode</em></span>
</span></p></td><td><p>
Controls further processing of events from all other devices. You can pass one
of these constants:
<code class="function">GrabModeSync</code>
or
<code class="function">GrabModeAsync .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGrabDeviceButton"><code class="function"> XGrabDeviceButton</code></a>
is analogous to the core
<span class="olink"><code class="function">XGrabButton</code></span>
function.
It creates an explicit passive grab for a button on an extension input device.
Because the server does not track extension devices,
no cursor is specified with this request.
For the same reason, there is no confine_to parameter.
The device must have previously been opened using the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
function.
</p><p>
The
<a class="xref" href="#XGrabDeviceButton"><code class="function"> XGrabDeviceButton</code></a>
function establishes a passive grab on a device.
Consequently, in the future,
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
IF the device is not grabbed and the specified button is logically pressed
when the specified modifier keys logically are down
(and no other buttons or modifier keys are down),
</p></li><li class="listitem"><p>
AND EITHER the grab window is an ancestor of (or is) the focus window
OR the grab window is a descendent of the focus window and contains the pointer,
</p></li><li class="listitem"><p>
AND a passive grab on the same device and button/key combination does not
exist on any ancestor of the grab window,
</p></li><li class="listitem"><p>
THEN the device is actively grabbed, as for
<code class="function">XGrabDevice ,</code>
the last-grab time is set to the time at which the button was pressed
(as transmitted in the
<code class="function">DeviceButtonPress</code>
event), and the
<code class="function">DeviceButtonPress</code>
event is reported.
</p></li></ul></div><p>
The interpretation of the remaining arguments is as for
<code class="function">XGrabDevice .</code>
The active grab is terminated automatically when logical state of the
device has all buttons released (independent of the logical state of
the modifier keys).
</p><p>
Note that the logical state of a device (as seen by means of the X protocol)
may lag the physical state if device event processing is frozen.
</p><p>
A modifier of
<code class="function">AnyModifier</code>
is equivalent to issuing the request for all
possible modifier combinations (including the combination of no
modifiers).
It is not required that all modifiers specified have
currently assigned keycodes.
A button of
<code class="function">AnyButton</code>
is equivalent to issuing
the request for all possible buttons.
Otherwise, it is not required that the
specified button be assigned to a physical button.
</p><p>
<a class="xref" href="#XGrabDeviceButton"><code class="function"> XGrabDeviceButton</code></a>
generates a
<code class="function">BadAccess</code>
error if some other client has issued a
<a class="xref" href="#XGrabDeviceButton"><code class="function"> XGrabDeviceButton</code></a>
with the same device and button combination on the same window.
When using
<code class="function">AnyModifier</code>
or
<code class="function">AnyButton ,</code>
the request fails completely and the X server generates a
<code class="function">BadAccess</code>
error and no grabs are
established if there is a conflicting grab for any combination.
</p><p>
<a class="xref" href="#XGrabDeviceButton"><code class="function"> XGrabDeviceButton</code></a>
can generate
<code class="function">BadAccess , </code>
<code class="function">BadClass ,</code>
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
<code class="function">BadValue ,</code>
and
<code class="function">BadWindow</code>
errors.
</p><p>
To release a passive grab of a button on an extension device, use
<code class="function">XUngrabDeviceButton .</code>
</p><div class="funcsynopsis"><a id="XUngrabDeviceButton"></a><p><code class="funcdef">int <strong class="fsfunc"> XUngrabDeviceButton</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, unsignedint<var class="pdparam"> button</var>, unsignedint<var class="pdparam"> modifiers</var>, XDevice<var class="pdparam"> *modifier_device</var>, Window<var class="pdparam"> ungrab_window</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>button</em></span>
</span></p></td><td><p>
Specifies the code of the button that is to be ungrabbed. You can pass
either a button or
<code class="function">AnyButton .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>modifiers</em></span>
</span></p></td><td><p>
Specifies the set of keymasks. This mask is the bitwise inclusive OR
of these keymask bits:
<code class="function">ShiftMask ,</code>
<code class="function">LockMask ,</code>
<code class="function">ControlMask , </code>
<code class="function">Mod1Mask ,</code>
<code class="function">Mod2Mask ,</code>
<code class="function">Mod3Mask ,</code>
<code class="function">Mod4Mask ,</code>
and
<code class="function">Mod5Mask .</code>
</p></td></tr><tr><td><p><span class="term">
</span></p></td><td><p>
You can also pass
<code class="function">AnyModifier ,</code>
which is equivalent to issuing the ungrab key
request for all possible modifier combinations (including the combination
of no modifiers).
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>modifier_device</em></span>
</span></p></td><td><p>
Specifies the device whose modifiers are to be used. If NULL is
specified, the core X keyboard is used as the modifier_device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>ungrab_window</em></span>
</span></p></td><td><p>
Specifies the ID of a window associated with the device specified above.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XUngrabDeviceButton"><code class="function"> XUngrabDeviceButton</code></a>
is analogous to the core
<span class="olink"><code class="function">XUngrabButton</code></span>
function. It releases an explicit passive grab for a button
on an extension device.
That device must have previously been opened using the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
function, or a
<code class="function">BadDevice</code>
error will result.
</p><p>
A modifier of
<code class="function">AnyModifier</code>
is equivalent to issuing the request for all
possible modifier combinations (including the combination of no
modifiers).
</p><p>
<a class="xref" href="#XUngrabDeviceButton"><code class="function"> XUngrabDeviceButton</code></a>
can generate
<code class="function">BadAlloc , </code>
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
<code class="function">BadValue ,</code>
and
<code class="function">BadWindow</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Thawing_a_Device"></a>Thawing a Device</h4></div></div></div><p>
To allow further events to be processed when a device has been frozen, use
<code class="function">XAllowDeviceEvents .</code>
</p><div class="funcsynopsis"><a id="XAllowDeviceEvents"></a><p><code class="funcdef">int <strong class="fsfunc"> XAllowDeviceEvents</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int<var class="pdparam"> event_mode</var>, Time<var class="pdparam"> time</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_mode</em></span>
</span></p></td><td><p>
Specifies the event mode. You can pass one of these constants:
<code class="function">AsyncThisDevice ,</code>
<code class="function">SyncThisDevice ,</code>
<code class="function">AsyncOtherDevices ,</code>
<code class="function">ReplayThisDevice ,</code>
<code class="function">AsyncAll ,</code>
or
<code class="function">SyncAll .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>time</em></span>
</span></p></td><td><p>
Specifies the time. This may be either a timestamp expressed in
milliseconds, or
<code class="function">CurrentTime .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XAllowDeviceEvents"><code class="function"> XAllowDeviceEvents</code></a>
releases some queued events if the client has caused a device to freeze.
It has no effect if the specified time is earlier than the last-grab
time of the most recent active grab for the client and device,
or if the specified time is later than the current X server time.
The following describes the processing that occurs depending on what constant
you pass to the event_mode argument:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
<code class="function">AsyncThisDevice</code>
</p></li><li class="listitem"><p>
If the specified device is frozen by the client, event processing for that
continues as usual. If the device is frozen multiple times by the client on
behalf of multiple separate grabs,
<code class="function">AsyncThisDevice</code>
thaws for all.
<code class="function">AsyncThisDevice</code>
has no effect if the specified device is not frozen by the
client, but the device need not be grabbed by the client.
</p></li><li class="listitem"><p>
<code class="function">SyncThisDevice</code>
</p></li><li class="listitem"><p>
If the specified device is frozen and actively grabbed by the client,
event processing for that device continues normally until the next
key or button event is reported to the client.
At this time,
the specified device again appears to freeze.
However, if the reported event causes the grab to be released,
the specified device does not freeze.
<code class="function">SyncThisDevice</code>
has no effect if the specified device is not frozen by the client
or is not grabbed by the client.
</p></li><li class="listitem"><p>
<code class="function">ReplayThisDevice</code>
</p></li><li class="listitem"><p>
If the specified device is actively grabbed by the client
and is frozen as the result of an event having been sent to the client
(either from the activation of a
<code class="function">GrabDeviceButton</code>
or from a previous
<code class="function">AllowDeviceEvents</code>
with mode
<code class="function">SyncThisDevice , </code>
but not from a
<code class="function">Grab ),</code>
the grab is released and that event is completely reprocessed.
This time, however, the request ignores any passive grabs at or above
(toward the root) the grab-window of the grab just released.
The request has no effect if the specified device is not grabbed by the client
or if it is not frozen as the result of an event.
</p></li><li class="listitem"><p>
<code class="function">AsyncOtherDevices</code>
</p></li><li class="listitem"><p>
If the remaining devices are frozen by the client,
event processing for them continues as usual.
If the other devices are frozen multiple times by the client on behalf of
multiple separate grabs,
<code class="function">AsyncOtherDevices</code>
``thaws'' for all.
<code class="function">AsyncOtherDevices</code>
has no effect if the devices are not frozen by the client,
but those devices need not be grabbed by the client.
</p></li><li class="listitem"><p>
<code class="function">SyncAll</code>
</p></li><li class="listitem"><p>
If all devices are frozen by the client,
event processing (for all devices) continues normally until the next
button or key event is reported
to the client for a grabbed device,
at which time the devices again appear to
freeze. However, if the reported event causes the grab to be released,
then the devices do not freeze (but if any device is still
grabbed, then a subsequent event for it will still cause all devices
to freeze).
<code class="function">SyncAll</code>
has no effect unless all devices are frozen by the client.
If any device is frozen twice
by the client on behalf of two separate grabs,
<code class="function">SyncAll</code>
"thaws" for both (but a subsequent freeze for
<code class="function">SyncAll</code>
will freeze each device only once).
</p></li><li class="listitem"><p>
<code class="function">AsyncAll</code>
</p></li><li class="listitem"><p>
If all devices are frozen by the
client, event processing (for all devices) continues normally.
If any device is frozen multiple times by the client on behalf of multiple
separate grabs,
<code class="function">AsyncAll</code>
``thaws ''for all.
If any device is frozen twice by the client on behalf of two separate grabs,
<code class="function">AsyncAll</code>
``thaws'' for both.
<code class="function">AsyncAll</code>
has no effect unless all devices are frozen by the client.
</p></li></ul></div><p>
<code class="function">AsyncThisDevice ,</code>
<code class="function">SyncThisDevice ,</code>
and
<code class="function">ReplayThisDevice </code>
have no effect on the processing of events from the remaining devices.
<code class="function">AsyncOtherDevices</code>
has no effect on the processing of events from the specified device.
When the event_mode is
<code class="function">SyncAll</code>
or
<code class="function">AsyncAll ,</code>
the device parameter is ignored.
</p><p>
It is possible for several grabs of different devices (by the same
or different clients) to be active simultaneously.
If a device is frozen on behalf of any grab,
no event processing is performed for the device.
It is possible for a single device to be frozen because of several grabs.
In this case,
the freeze must be released on behalf of each grab before events can
again be processed.
</p><p>
<a class="xref" href="#XAllowDeviceEvents"><code class="function"> XAllowDeviceEvents</code></a>
can generate
<code class="function">BadDevice</code>
and
<code class="function">BadValue</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Controlling_Device_Focus"></a>Controlling Device Focus</h4></div></div></div><p>
The current focus window for an extension input device can be
determined using the
<a class="xref" href="#XGetDeviceFocus"><code class="function"> XGetDeviceFocus</code></a>
function.
Extension devices are focused using the
<a class="xref" href="#XSetDeviceFocus"><code class="function"> XSetDeviceFocus</code></a>
function in the same way that the keyboard is focused using the core
<span class="olink"><code class="function">XSetInputFocus</code></span>
function, except that a device ID is passed as
a function parameter. One additional focus state,
<code class="function">FollowKeyboard ,</code>
is provided for extension devices.
</p><p>
To get the current focus state, revert state,
and focus time of an extension device, use
<code class="function">XGetDeviceFocus .</code>
</p><div class="funcsynopsis"><a id="XGetDeviceFocus"></a><p><code class="funcdef">int <strong class="fsfunc"> XGetDeviceFocus</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, Window<var class="pdparam"> *focus_return</var>, int<var class="pdparam"> *revert_to_return</var>, Time<var class="pdparam"> *focus_time_return</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>focus_return</em></span>
</span></p></td><td><p>
Specifies the address of a variable into which the server can return the ID of
the window that contains the device focus or one of the constants
<code class="function">None ,</code>
<code class="function">PointerRoot ,</code>
or
<code class="function">FollowKeyboard . </code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>revert_to_return</em></span>
</span></p></td><td><p>
Specifies the address of a variable into which the server can
return the current revert_to status for the device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>focus_time_return</em></span>
</span></p></td><td><p>
Specifies the address of a variable into which the server can
return the focus time last set for the device.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetDeviceFocus"><code class="function"> XGetDeviceFocus</code></a>
returns the focus state, the revert-to state,
and the last-focus-time for an extension input device.
</p><p>
<a class="xref" href="#XGetDeviceFocus"><code class="function"> XGetDeviceFocus</code></a>
can generate
<code class="function">BadDevice</code>
and
<code class="function">BadMatch</code>
errors.
</p><p>
To set the focus of an extension device, use
<code class="function">XSetDeviceFocus .</code>
</p><div class="funcsynopsis"><a id="XSetDeviceFocus"></a><p><code class="funcdef">int <strong class="fsfunc"> XSetDeviceFocus</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, Window<var class="pdparam"> focus</var>, int<var class="pdparam"> revert_to</var>, Time<var class="pdparam"> time</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>focus</em></span>
</span></p></td><td><p>
Specifies the ID of the window to which the device's focus should be set.
This may be a window ID, or
<code class="function">PointerRoot ,</code>
<code class="function">FollowKeyboard ,</code>
or
<code class="function">None .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>revert_to</em></span>
</span></p></td><td><p>
Specifies to which window the focus of the device should revert
if the focus window becomes not viewable. One of the following
constants may be passed:
<code class="function">RevertToParent ,</code>
<code class="function">RevertToPointerRoot ,</code>
<code class="function">RevertToNone ,</code>
or
<code class="function">RevertToFollowKeyboard .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>time</em></span>
</span></p></td><td><p>
Specifies the time. You can pass either a timestamp, expressed in
milliseconds, or
<code class="function">CurrentTime .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XSetDeviceFocus"><code class="function"> XSetDeviceFocus</code></a>
changes the focus for an extension input device and the
last-focus-change-time. It has no effect if the specified
time is earlier than the last-focus-change-time or is later than the
current X server time. Otherwise, the last-focus-change-time is set to the
specified time.
This function causes the X server to generate
<code class="function">DeviceFocusIn</code>
and
<code class="function">DeviceFocusOut</code>
events.
</p><p>
The action taken by the server when this function is requested depends
on the value of the focus argument:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
If the focus argument is
<code class="function">None ,</code>
all input events from this device will be discarded until a new focus window
is set. In this case, the revert_to argument is ignored.
</p></li><li class="listitem"><p>
If the focus argument is a window ID, it becomes the focus
window of the device. If an input event from the device would normally
be reported to this window or to one of its inferiors, the event is
reported normally. Otherwise, the event is reported relative to the focus
window.
</p></li><li class="listitem"><p>
If the focus argument is
<code class="function">PointerRoot ,</code>
the focus window is dynamically taken to be the root window
of whatever screen the pointer is on at each input event.
In this case, the revert_to argument is ignored.
</p></li><li class="listitem"><p>
If the focus argument is
<code class="function">FollowKeyboard , </code>
the focus window is dynamically taken to be the same as the focus
of the X keyboard at each input event.
</p></li></ul></div><p>
The specified focus window must be viewable at the time
<a class="xref" href="#XSetDeviceFocus"><code class="function"> XSetDeviceFocus</code></a>
is called. Otherwise, it generates a
<code class="function">BadMatch</code>
error.
If the focus window later becomes not viewable,
the X server evaluates the revert_to argument
to determine the new focus window.
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
If the revert_to argument is
<code class="function">RevertToParent ,</code>
the focus reverts to the parent (or the closest viewable ancestor),
and the new revert_to value is taken to be
<code class="function">RevertToNone . </code>
</p></li><li class="listitem"><p>
If the revert_to argument is
<code class="function">RevertToPointerRoot ,</code>
<code class="function">RevertToFollowKeyboard ,</code>
or
<code class="function">RevertToNone ,</code>
the focus reverts to that value.
</p></li></ul></div><p>
When the focus reverts,
the X server generates
<code class="function">DeviceFocusIn</code>
and
<code class="function">DeviceFocusOut</code>
events, but the last-focus-change time is not affected.
</p><p>
<a class="xref" href="#XSetDeviceFocus"><code class="function"> XSetDeviceFocus</code></a>
can generate
<code class="function">BadDevice ,</code>
<code class="function">BadMatch , </code>
<code class="function">BadValue ,</code>
and
<code class="function">BadWindow</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Controlling_Device_Feedback"></a>Controlling Device Feedback</h4></div></div></div><p>
To determine the current feedback settings of an extension input device, use
<code class="function">XGetFeedbackControl .</code>
</p><div class="funcsynopsis"><a id="XGetFeedbackControl"></a><p><code class="funcdef">XFeedbackState * <strong class="fsfunc"> XGetFeedbackControl</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int<var class="pdparam"> *num_feedbacks_return</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>num_feedbacks_return</em></span>
</span></p></td><td><p>
Returns the number of feedbacks supported by the device.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetFeedbackControl"><code class="function"> XGetFeedbackControl</code></a>
returns a list of
<code class="function">FeedbackState</code>
structures that describe the feedbacks supported by the specified device.
There is an
<code class="function">XFeedbackState</code>
structure for each class of feedback. These are of
variable length, but the first three members are common to all.
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
} XFeedbackState;
</pre><p>
</p><p>
The common members are as follows:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
The class member identifies the class of feedback.
It may be compared to constants defined in the file
<code class="function">< X11/extensions/XI.h >.</code>
Currently defined feedback constants include:
<code class="function">KbdFeedbackClass , </code>
<code class="function">PtrFeedbackClass ,</code>
<code class="function">StringFeedbackClass ,</code>
<code class="function">IntegerFeedbackClass , </code>
<code class="function">LedFeedbackClass ,</code>
and
<code class="function">BellFeedbackClass .</code>
</p></li><li class="listitem"><p>
The length member specifies the length of the
<code class="function">FeedbackState</code>
structure and can be used by clients to traverse the list.
</p></li><li class="listitem"><p>
The id member uniquely identifies a feedback for a given device and class.
This allows a device to support more than one feedback of the same class.
Other feedbacks of other classes or devices may have the same ID.
</p></li></ul></div><p>
Those feedbacks equivalent to those
supported by the core keyboard are reported in class
<code class="function">KbdFeedback</code>
using the
<code class="function">XKbdFeedbackState</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int click;
int percent;
int pitch;
int duration;
int led_mask;
int global_auto_repeat;
char auto_repeats[32];
} XKbdFeedbackState;
</pre><p>
</p><p>
The additional members of the
<code class="function">XKbdFeedbackState</code>
structure report the current state of the feedback:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
The click member specifies the key-click volume and has a value in the range
0 (off) to 100 (loud).
</p></li><li class="listitem"><p>
The percent member specifies the bell volume and has a value in the range
0 (off) to 100 (loud).
</p></li><li class="listitem"><p>
The pitch member specifies the bell pitch in Hz. The range of the value is
implementation-dependent.
</p></li><li class="listitem"><p>
The duration member specifies the duration in milliseconds of the bell.
</p></li><li class="listitem"><p>
The led_mask member is a bit mask that describes the current state of up to
32 LEDs. A value of 1 in a bit indicates that the corresponding LED is on.
</p></li><li class="listitem"><p>
The global_auto_repeat member has a value of
<code class="function">AutoRepeatModeOn</code>
or
<code class="function">AutoRepeatModeOff .</code>
</p></li><li class="listitem"><p>
The auto_repeats member is a bit vector. Each bit set to 1 indicates
that auto-repeat is enabled for the corresponding key. The vector is
represented as 32 bytes. Byte N (from 0) contains the bits for keys
8N to 8N + 7, with the least significant bit in the byte representing
key 8N.
</p></li></ul></div><p>
Those feedbacks equivalent to those
supported by the core pointer are reported in class
<code class="function">PtrFeedback</code>
using the
<code class="function">XPtrFeedbackState</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int accelNum;
int accelDenom;
int threshold;
} XPtrFeedbackState;
</pre><p>
</p><p>
The additional members of the
<code class="function">XPtrFeedbackState</code>
structure report the current state of the feedback:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
The accelNum member returns the numerator for the acceleration multiplier.
</p></li><li class="listitem"><p>
The accelDenom member returns the denominator for the acceleration multiplier.
</p></li><li class="listitem"><p>
The accelDenom member returns the threshold for the acceleration.
</p></li></ul></div><p>
Integer feedbacks are those capable of displaying integer numbers
and reported via the
<code class="function">XIntegerFeedbackState</code>
structure.
The minimum and maximum values that they can display are reported.
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int resolution;
int minVal;
int maxVal;
} XIntegerFeedbackState;
</pre><p>
</p><p>
The additional members of the
<code class="function">XIntegerFeedbackState</code>
structure report the capabilities of the feedback:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
The resolution member specifies the number of digits that the feedback
can display.
</p></li><li class="listitem"><p>
The minVal member specifies the minimum value that the feedback can display.
</p></li><li class="listitem"><p>
The maxVal specifies the maximum value that the feedback can display.
</p></li></ul></div><p>
String feedbacks are those that can display character information
and are reported via the
<code class="function">XStringFeedbackState</code>
structure.
Clients set these feedbacks by passing a list of
<code class="function">KeySyms</code>
to be displayed.
The
<a class="xref" href="#XGetFeedbackControl"><code class="function"> XGetFeedbackControl</code></a>
function returns the
set of key symbols that the feedback can display, as well as the
maximum number of symbols that can be displayed.
The
<code class="function">XStringFeedbackState</code>
structure is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int max_symbols;
int num_syms_supported;
KeySym *syms_supported;
} XStringFeedbackState;
</pre><p>
</p><p>
The additional members of the
<code class="function">XStringFeedbackState</code>
structure report the capabilities of the feedback:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
The max_symbols member specifies the maximum number of symbols
that can be displayed.
</p></li><li class="listitem"><p>
The syms_supported member is a pointer to the list of supported symbols.
</p></li><li class="listitem"><p>
The num_syms_supported member specifies the length of the list of supported symbols.
</p></li></ul></div><p>
Bell feedbacks are those that can generate a sound
and are reported via the
<code class="function">XBellFeedbackState</code>
structure.
Some implementations may support a bell as part of a
<code class="function">KbdFeedback</code>
feedback. Class
<code class="function">BellFeedback</code>
is provided for implementations that do not choose to do
so and for devices that support multiple feedbacks that can produce sound.
The meaning of the members is the same as that of the corresponding fields in
the
<code class="function">XKbdFeedbackState</code>
structure.
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int percent;
int pitch;
int duration;
} XBellFeedbackState;
</pre><p>
</p><p>
Led feedbacks are those that can generate a light and are reported via the
<code class="function">XLedFeedbackState</code>
structure.
Up to 32 lights per feedback are supported.
Each bit in led_mask
corresponds to one supported light, and the corresponding bit in led_values
indicates whether that light is currently on (1) or off (0).
Some implementations may support leds as part of a
<code class="function">KbdFeedback</code>
feedback.
Class
<code class="function">LedFeedback</code>
is provided for implementations that do not choose to do
so and for devices that support multiple led feedbacks.
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
Mask led_values;
Mask led_mask;
} XLedFeedbackState;
</pre><p>
</p><p>
<a class="xref" href="#XGetFeedbackControl"><code class="function"> XGetFeedbackControl</code></a>
can generate
<code class="function">BadDevice</code>
and
<code class="function">BadMatch</code>
errors.
</p><p>
To free the information returned by the
<a class="xref" href="#XGetFeedbackControl"><code class="function"> XGetFeedbackControl</code></a>
function, use
<code class="function">XFreeFeedbackList .</code>
</p><div class="funcsynopsis"><a id="XFreeFeedbackList"></a><p><code class="funcdef">void <strong class="fsfunc"> XFreeFeedbackList</strong>(</code>XFeedbackState<var class="pdparam"> *list</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>list</em></span>
</span></p></td><td><p>
Specifies the pointer to the
<code class="function">XFeedbackState</code>
structure returned by
a previous call to
<code class="function">XGetFeedbackControl .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XFreeFeedbackList"><code class="function"> XFreeFeedbackList</code></a>
frees the list of feedback control information.
</p><p>
To change the settings of a feedback on an extension device, use
<code class="function">XChangeFeedbackControl .</code>
This function modifies the current control values of the specified feedback
using information passed in the appropriate
<code class="function">XFeedbackControl</code>
structure for the feedback.
Which values are modified depends on the valuemask passed.
</p><div class="funcsynopsis"><a id="XChangeFeedbackControl"></a><p><code class="funcdef">int <strong class="fsfunc"> XChangeFeedbackControl</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, unsignedlong<var class="pdparam"> valuemask</var>, XFeedbackControl<var class="pdparam"> *value</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>valuemask</em></span>
</span></p></td><td><p>
Specifies one value for each bit in the mask (least to most significant
bit). The values are associated with the feedbacks for the specified
device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>value</em></span>
</span></p></td><td><p>
Specifies a pointer to the
<code class="function">XFeedbackControl</code>
structure.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XChangeFeedbackControl"><code class="function"> XChangeFeedbackControl</code></a>
controls the device characteristics described by the
<code class="function">XFeedbackControl</code>
structure.
There is an
<code class="function">XFeedbackControl</code>
structure for each class of feedback.
These are of variable length, but the first
three members are common to all and are as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
} XFeedbackControl;
</pre><p>
</p><p>
Feedback class
<code class="function">KbdFeedback</code>
controls feedbacks equivalent to those provided by the core keyboard using the
<code class="function">KbdFeedbackControl</code>
structure, which is defined as follows:.
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int click;
int percent;
int pitch;
int duration;
int led_mask;
int led_value;
int key;
int auto_repeat_mode;
} XKbdFeedbackControl;
</pre><p>
</p><p>
This class controls the device characteristics described by the
<code class="function">XKbdFeedbackControl</code>
structure. These include the key_click_percent,
global_auto_repeat, and individual key auto-repeat. Valid modes
are
<code class="function">AutoRepeatModeOn ,</code>
<code class="function">AutoRepeatModeOff ,</code>
and
<code class="function">AutoRepeatModeDefault .</code>
</p><p>
Valid masks are as follows:
</p><pre class="literallayout">
#define DvKeyClickPercent (1><<0)
#define DvPercent (1><<0)
#define DvPitch (1><<0)
#define DvDuration (1><<0)
#define DvLed (1><<0)
#define DvLedMode (1><<0)
#define DvKey (1><<0)
#define DvAutoRepeatMode (1><<0)
</pre><p>
Feedback class
<code class="function">PtrFeedback</code>
controls feedbacks equivalent to those provided by the core pointer using the
<code class="function">PtrFeedbackControl</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int accelNum;
int accelDenom;
int threshold;
} XPtrFeedbackControl;
</pre><p>
</p><p>
Which values are modified depends on the valuemask passed.
</p><p>
Valid masks are as follows:
</p><pre class="literallayout">
#define DvAccelnum (1L<<0)
#define DvAccelDenom (1L<<1)
#define DvThreshold (1L<<2)
</pre><p>
The acceleration, expressed as a fraction, is a multiplier for movement.
For example,
specifying 3/1 means that the device moves three times as fast as normal.
The fraction may be rounded arbitrarily by the X server.
Acceleration takes effect only if the device moves more than threshold pixels at
once and applies only to the amount beyond the value in the threshold argument.
Setting a value to -1 restores the default.
The values of the accelNumerator and threshold fields must be nonzero for
the pointer values to be set.
Otherwise, the parameters will be unchanged.
Negative values generate a
<code class="function">BadValue</code>
error, as does a zero value
for the accelDenominator field.
</p><p>
This request fails with a
<code class="function">BadMatch</code>
error if the specified device is not currently reporting relative motion.
If a device that is capable of reporting both relative and absolute motion
has its mode changed from
<code class="function">Relative</code>
to
<code class="function">Absolute</code>
by an
<a class="xref" href="#XSetDeviceMode"><code class="function"> XSetDeviceMode</code></a>
request, valuator control values
will be ignored by the server while the device is in that mode.
</p><p>
Feedback class
<code class="function">IntegerFeedback</code>
controls integer feedbacks displayed on input devices and are
reported via the
<code class="function">IntegerFeedbackControl</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int int_to_display;
} XIntegerFeedbackControl;
</pre><p>
</p><p>
Valid masks are as follows:
</p><pre class="literallayout">
#define DvInteger (1L<<0)
</pre><p>
Feedback class
<code class="function">StringFeedback</code>
controls string feedbacks displayed on input devices
and reported via the
<code class="function">StringFeedbackControl</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int num_keysyms;
KeySym *syms_to_display;
} XStringFeedbackControl;
</pre><p>
</p><p>
Valid masks are as follows:
</p><pre class="literallayout">
#define DvString (1L<<0)
</pre><p>
Feedback class
<code class="function">BellFeedback</code>
controls a bell on an input device and is reported via the
<code class="function">BellFeedbackControl</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int percent;
int pitch;
int duration;
} XBellFeedbackControl;
</pre><p>
</p><p>
Valid masks are as follows:
</p><pre class="literallayout">
#define DvPercent (1L<<1)
#define DvPitch (1L<<2)
#define DvDuration (1L<<3)
</pre><p>
Feedback class
<code class="function">LedFeedback</code>
controls lights on an input device and are reported via the
<code class="function">LedFeedbackControl</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID class;
int length;
XID id;
int led_mask;
int led_values;
} XLedFeedbackControl;
</pre><p>
</p><p>
Valid masks are as follows:
</p><pre class="literallayout">
#define DvLed (1L<<4)
#define DvLedMode (1L<<5)
</pre><p>
<a class="xref" href="#XChangeFeedbackControl"><code class="function"> XChangeFeedbackControl</code></a>
can generate
<code class="function">BadDevice ,</code>
<code class="function">BadFeedBack ,</code>
<code class="function">BadMatch ,</code>
and
<code class="function">BadValue</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Ringing_a_Bell_on_an_Input_Device"></a>Ringing a Bell on an Input Device</h4></div></div></div><p>
To ring a bell on an extension input device, use
<code class="function">XDeviceBell .</code>
</p><div class="funcsynopsis"><a id="XDeviceBell"></a><p><code class="funcdef">int <strong class="fsfunc"> XDeviceBell</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, XIDfeedbackclass,<var class="pdparam"> feedbackid</var>, int<var class="pdparam"> percent</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>feedbackclass</em></span>
</span></p></td><td><p>
Specifies the feedbackclass. Valid values are
<code class="function">KbdFeedbackClass</code>
and
<code class="function">BellFeedbackClass .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>feedbackid</em></span>
</span></p></td><td><p>
Specifies the ID of the feedback that has the bell.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>percent</em></span>
</span></p></td><td><p>
Specifies the volume in the range -100 (quiet) to 100 percent (loud).
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XDeviceBell"><code class="function"> XDeviceBell</code></a>
is analogous to the core
<span class="olink"><code class="function">XBell</code></span>
function. It rings the specified bell on the specified input device feedback,
using the specified volume.
The specified volume is relative to the base volume for the feedback.
If the value for the percent argument is not in the range -100 to 100
inclusive, a
<code class="function">BadValue</code>
error results.
The volume at which the bell rings when the percent argument is nonnegative is:
</p><p>
</p><pre class="literallayout">
base - [(base * percent) / 100] + percent
</pre><p>
</p><p>
The volume at which the bell rings
when the percent argument is negative is:
</p><p>
</p><pre class="literallayout">
base + [(base * percent) / 100]
</pre><p>
</p><p>
To change the base volume of the bell, use
<code class="function">XChangeFeedbackControl .</code>
</p><p>
<a class="xref" href="#XDeviceBell"><code class="function"> XDeviceBell</code></a>
can generate
<code class="function">BadDevice</code>
and
<code class="function">BadValue</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Controlling_Device_Encoding"></a>Controlling Device Encoding</h4></div></div></div><p>
To get the key mapping of an extension device that supports input class
<code class="function">Keys ,</code>
use
<code class="function">XGetDeviceKeyMapping .</code>
</p><div class="funcsynopsis"><a id="XGetDeviceKeyMapping"></a><p><code class="funcdef">KeySym * <strong class="fsfunc"> XGetDeviceKeyMapping</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, KeyCode<var class="pdparam"> first_keycode_wanted</var>, int<var class="pdparam"> keycode_count</var>, int<var class="pdparam"> *keysyms_per_keycode_return</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>first_keycode_wanted</em></span>
</span></p></td><td><p>
Specifies the first keycode that is to be returned.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>keycode_count</em></span>
</span></p></td><td><p>
Specifies the number of keycodes that are to be returned.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>keysyms_per_keycode_return</em></span>
</span></p></td><td><p>
Returns the number of keysyms per keycode.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetDeviceKeyMapping"><code class="function"> XGetDeviceKeyMapping</code></a>
is analogous to the core
<span class="olink"><code class="function">XGetKeyboardMapping</code></span>
function.
It returns the symbols for the specified number of keycodes for the
specified extension device.
</p><p>
<a class="xref" href="#XGetDeviceKeyMapping"><code class="function"> XGetDeviceKeyMapping</code></a>
returns the symbols for the
specified number of keycodes for the
specified extension device, starting with the specified keycode.
The first_keycode_wanted must be greater than or equal to
min-keycode as returned
by the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
request (else a
<code class="function">BadValue</code>
error results). The following value:
</p><pre class="literallayout">
first_keycode_wanted + keycode_count - 1
</pre><p>
</p><p>
must be less than or equal to max-keycode as returned
by the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
request (else a
<code class="function">BadValue</code>
error results).
</p><p>
The number of elements in the keysyms list is as follows:
</p><pre class="literallayout">
keycode_count * keysyms_per_keycode_return
</pre><p>
And KEYSYM number N (counting from zero) for keycode K has an index
(counting from zero), in keysyms, of the following:
</p><pre class="literallayout">
(K - first_keycode_wanted) * keysyms_per_keycode_return + N
</pre><p>
</p><p>
The keysyms_per_keycode_return value is chosen arbitrarily by the server
to be large enough to report all requested symbols.
A special KEYSYM value of
<code class="function">NoSymbol</code>
is used to fill in unused elements for individual keycodes.
</p><p>
To free the data returned by this function, use
<span class="olink"><code class="function">XFree</code></span>.
</p><p>
If the specified device has not first been opened by this client via
<code class="function">XOpenDevice ,</code>
this request will fail with a
<code class="function">BadDevice</code>
error.
If that device does not support input class
<code class="function">Keys ,</code>
this request will fail with a
<code class="function">BadMatch</code>
error.
</p><p>
<a class="xref" href="#XGetDeviceKeyMapping"><code class="function"> XGetDeviceKeyMapping</code></a>
can generate
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
and
<code class="function">BadValue</code>
errors.
</p><p>
To change the keyboard mapping of an extension device that supports input class
<code class="function">Keys ,</code>
use
<code class="function">XChangeDeviceKeyMapping .</code>
</p><div class="funcsynopsis"><a id="XChangeDeviceKeyMapping"></a><p><code class="funcdef">int <strong class="fsfunc"> XChangeDeviceKeyMapping</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int<var class="pdparam"> first_keycode</var>, int<var class="pdparam"> keysyms_per_keycode</var>, KeySym<var class="pdparam"> *keysyms</var>, int<var class="pdparam"> num_codes</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>first_keycode</em></span>
</span></p></td><td><p>
Specifies the first keycode that is to be changed.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>keysyms_per_keycode</em></span>
</span></p></td><td><p>
Specifies the keysyms that are to be used.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>keysyms</em></span>
</span></p></td><td><p>
Specifies a pointer to an array of keysyms.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>num_codes</em></span>
</span></p></td><td><p>
Specifies the number of keycodes that are to be changed.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XChangeDeviceKeyMapping"><code class="function"> XChangeDeviceKeyMapping</code></a>
is analogous to the core
<span class="olink"><code class="function">XChangeKeyboardMapping</code></span>
function.
It defines the symbols for the specified number of keycodes for the
specified extension keyboard device.
</p><p>
If the specified device has not first been opened by this client via
<code class="function">XOpenDevice ,</code>
this request will fail with a
<code class="function">BadDevice</code>
error.
If the specified device does not support input class
<code class="function">Keys ,</code>
this request will fail with a
<code class="function">BadMatch</code>
error.
</p><p>
The number of elements in the keysyms list must be a multiple of
keysyms_per_keycode. Otherwise,
<a class="xref" href="#XChangeDeviceKeyMapping"><code class="function"> XChangeDeviceKeyMapping</code></a>
generates a
<code class="function">BadLength</code>
error.
The specified first_keycode must be greater than or equal to
the min_keycode value returned by the
<code class="function">ListInputDevices</code>
request, or this request will fail with a
<code class="function">BadValue</code>
error. In addition, if the following expression is not less than
the max_keycode value returned by the
<code class="function">ListInputDevices</code>
request, the request will fail with a
<code class="function">BadValue</code>
error:
</p><pre class="literallayout">
first_keycode + (num_codes / keysyms_per_keycode) - 1
</pre><p>
</p><p>
<a class="xref" href="#XChangeDeviceKeyMapping"><code class="function"> XChangeDeviceKeyMapping</code></a>
can generate
<code class="function">BadAlloc ,</code>
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
and
<code class="function">BadValue</code>
errors.
</p><p>
To obtain the keycodes that are used as modifiers on an
extension device that supports input class
<code class="function">Keys ,</code>
use
<code class="function">XGetDeviceModifierMapping .</code>
</p><div class="funcsynopsis"><a id="XGetDeviceModifierMapping"></a><p><code class="funcdef">XModifierKeymap * <strong class="fsfunc"> XGetDeviceModifierMapping</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetDeviceModifierMapping"><code class="function"> XGetDeviceModifierMapping</code></a>
is analogous to the core
<span class="olink"><code class="function">XGetModifierMapping</code></span>
function.
The
<a class="xref" href="#XGetDeviceModifierMapping"><code class="function"> XGetDeviceModifierMapping</code></a>
function returns a newly created
<code class="function">XModifierKeymap</code>
structure that contains the keys being used as
modifiers for the specified device.
The structure should be freed after use with
<code class="function">XFreeModifierMapping .</code>
If only zero values appear in the set for any modifier,
that modifier is disabled.
</p><p>
<a class="xref" href="#XGetDeviceModifierMapping"><code class="function"> XGetDeviceModifierMapping</code></a>
can generate
<code class="function">BadDevice</code>
and
<code class="function">BadMatch</code>
errors.
</p><p>
To set which keycodes are to be used as modifiers for an extension device, use
<code class="function">XSetDeviceModifierMapping .</code>
</p><div class="funcsynopsis"><a id="XSetDeviceModifierMapping"></a><p><code class="funcdef">int <strong class="fsfunc"> XSetDeviceModifierMapping</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, XModifierKeymap<var class="pdparam"> *modmap</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>modmap</em></span>
</span></p></td><td><p>
Specifies a pointer to the
<code class="function">XModifierKeymap</code>
structure.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XSetDeviceModifierMapping"><code class="function"> XSetDeviceModifierMapping</code></a>
is analogous to the core
<span class="olink"><code class="function">XSetModifierMapping</code></span>
function.
The
<a class="xref" href="#XSetDeviceModifierMapping"><code class="function"> XSetDeviceModifierMapping</code></a>
function specifies the keycodes of the keys, if any,
that are to be used as modifiers. A zero value means
that no key should be used. No two arguments can have the same nonzero
keycode value. Otherwise,
<a class="xref" href="#XSetDeviceModifierMapping"><code class="function"> XSetDeviceModifierMapping</code></a>
generates a
<code class="function">BadValue</code>
error.
There are eight modifiers, and the modifiermap member of the
<code class="function">XModifierKeymap</code>
structure contains eight sets of max_keypermod
keycodes, one for each modifier in the order
<code class="function">Shift ,</code>
<code class="function">Lock ,</code>
<code class="function">Control ,</code>
<code class="function">Mod1 ,</code>
<code class="function">Mod2 ,</code>
<code class="function">Mod3 ,</code>
<code class="function">Mod4 ,</code>
and
<code class="function">Mod5 .</code>
Only nonzero keycodes have meaning in each set, and zero keycodes
are ignored.
In addition, all of the nonzero keycodes must be in the range specified by
min_keycode and max_keycode reported by the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
function.
Otherwise,
<span class="olink"><code class="function">XSetModifierMapping</code></span>
generates a
<code class="function">BadValue</code>
error.
No keycode may appear twice in the entire map.
Otherwise, it generates a
<code class="function">BadValue</code>
error.
</p><p>
A X server can impose restrictions on how modifiers can be changed,
for example,
if certain keys do not generate up transitions in hardware or if multiple
modifier keys are not supported.
If some such restriction is violated,
the status reply is
<code class="function">MappingFailed ,</code>
and none of the modifiers are changed.
If the new keycodes specified for a modifier differ from those
currently defined and any (current or new) keys for that modifier are
in the logically down state,
the status reply is
<code class="function">MappingBusy , </code>
and none of the modifiers are changed.
<span class="olink"><code class="function">XSetModifierMapping</code></span>
generates a
<code class="function">DeviceMappingNotify</code>
event on a
<code class="function">MappingSuccess</code>
status.
</p><p>
<a class="xref" href="#XSetDeviceModifierMapping"><code class="function"> XSetDeviceModifierMapping</code></a>
can generate
<code class="function">BadAlloc ,</code>
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
and
<code class="function">BadValue</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Controlling_Button_Mapping"></a>Controlling Button Mapping</h4></div></div></div><p>
To set the mapping of the buttons on an extension device, use
<code class="function">XSetDeviceButtonMapping .</code>
</p><div class="funcsynopsis"><a id="XSetDeviceButtonMapping"></a><p><code class="funcdef">int <strong class="fsfunc"> XSetDeviceButtonMapping</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, unsignedchar<var class="pdparam"> map[]</var>, int<var class="pdparam"> nmap</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>map</em></span>
</span></p></td><td><p>
Specifies the mapping list.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>nmap</em></span>
</span></p></td><td><p>
Specifies the number of items in the mapping list.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XSetDeviceButtonMapping"><code class="function"> XSetDeviceButtonMapping</code></a>
sets the mapping of the buttons on an extension device.
If it succeeds, the X server generates a
<code class="function">DeviceMappingNotify</code>
event, and
<a class="xref" href="#XSetDeviceButtonMapping"><code class="function"> XSetDeviceButtonMapping</code></a>
returns
<code class="function">MappingSuccess .</code>
Elements of the list are indexed starting from one.
The length of the list must be the same as
<a class="xref" href="#XGetDeviceButtonMapping"><code class="function"> XGetDeviceButtonMapping</code></a>
would return, or a
<code class="function">BadValue</code>
error results.
The index is a button number, and the element of the list
defines the effective number.
A zero element disables a button, and elements are not restricted in
value by the number of physical buttons.
However, no two elements can have the same nonzero value, or a
<code class="function">BadValue</code>
error results.
If any of the buttons to be altered are logically in the down state,
<a class="xref" href="#XSetDeviceButtonMapping"><code class="function"> XSetDeviceButtonMapping</code></a>
returns
<code class="function">MappingBusy ,</code>
and the mapping is not changed.
</p><p>
<a class="xref" href="#XSetDeviceButtonMapping"><code class="function"> XSetDeviceButtonMapping</code></a>
can generate
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
and
<code class="function">BadValue</code>
errors.
</p><p>
To get the button mapping, use
<code class="function">XGetDeviceButtonMapping .</code>
</p><div class="funcsynopsis"><a id="XGetDeviceButtonMapping"></a><p><code class="funcdef">int <strong class="fsfunc"> XGetDeviceButtonMapping</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, unsignedchar<var class="pdparam"> map_return[]</var>, int<var class="pdparam"> nmap</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>map_return</em></span>
</span></p></td><td><p>
Specifies the mapping list.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>nmap</em></span>
</span></p></td><td><p>
Specifies the number of items in the mapping list.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetDeviceButtonMapping"><code class="function"> XGetDeviceButtonMapping</code></a>
returns the current mapping of the specified extension device.
Elements of the list are indexed starting from one.
<a class="xref" href="#XGetDeviceButtonMapping"><code class="function"> XGetDeviceButtonMapping</code></a>
returns the number of physical buttons actually on the pointer.
The nominal mapping for the buttons is the identity mapping: map[i]=i.
The nmap argument specifies the length of the array where the button
mapping is returned, and only the first nmap elements are returned
in map_return.
</p><p>
<a class="xref" href="#XGetDeviceButtonMapping"><code class="function"> XGetDeviceButtonMapping</code></a>
can generate
<code class="function">BadDevice</code>
and
<code class="function">BadMatch</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Obtaining_the_State_of_a_Device"></a>Obtaining the State of a Device</h4></div></div></div><p>
To obtain information that describes the state of the keys, buttons, and
valuators of an extension device, use
<code class="function">XQueryDeviceState .</code>
</p><div class="funcsynopsis"><a id="XQueryDeviceState"></a><p><code class="funcdef">XDeviceState * <strong class="fsfunc"> XQueryDeviceState</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XQueryDeviceState"><code class="function"> XQueryDeviceState</code></a>
returns a pointer to an
<code class="function">XDeviceState</code>
structure, which points to a list of
structures that describe the state of the keys, buttons, and valuators
on the device:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID device_id;
int num_classes;
XInputClass *data;
} XDeviceState;
</pre><p>
</p><p>
The structures are of variable length, but the first
two members are common to all and are as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
unsigned char class;
unsigned char length;
} XInputClass;
</pre><p>
</p><p>
The class member contains a class identifier. This identifier can be
compared with constants defined in the file
<code class="function">< X11/extensions/XI.h >.</code>
Currently defined constants are:
<code class="function">KeyClass ,</code>
<code class="function">ButtonClass ,</code>
and
<code class="function">ValuatorClass .</code>
</p><p>
The length member contains the length of the structure and can be used
by clients to traverse the list.
</p><p>
The
<code class="function">XValuatorState</code>
structure describes the current state of the valuators
on the device.
The num_valuators member contains the number of valuators
on the device.
The mode member is a mask whose bits report the data mode
and other state information for the device.
The following bits are currently defined:
</p><pre class="literallayout">
DeviceMode 1 << 0 Relative = 0, Absolute = 1
ProximityState 1 << 1 InProximity = 0, OutOfProximity = 1
</pre><p>
The valuators member contains a pointer to an array of integers that
describe the current value of the valuators.
If the mode is
<code class="function">Relative ,</code>
these values are undefined.
</p><p>
</p><pre class="literallayout">
typedef struct {
unsigned char class;
unsigned char length;
unsigned char num_valuators;
unsigned char mode;
int *valuators;
} XValuatorState;
</pre><p>
</p><p>
The
<code class="function">XKeyState</code>
structure describes the current state of the keys
on the device. Byte N (from 0) contains the
bits for key 8N to 8N + 7 with the least significant bit in the
byte representing key 8N.
</p><p>
</p><pre class="literallayout">
typedef struct {
unsigned char class;
unsigned char length;
short num_keys;
char keys[32];
} XKeyState;
</pre><p>
</p><p>
The
<code class="function">XButtonState</code>
structure describes the current state of the buttons
on the device. Byte N (from 0) contains the bits for button 8N to 8N + 7
with the least significant bit in the
byte representing button 8N.
</p><p>
</p><pre class="literallayout">
typedef struct {
unsigned char class;
unsigned char length;
short num_buttons;
char buttons[32];
} XButtonState;
</pre><p>
</p><p>
<a class="xref" href="#XQueryDeviceState"><code class="function"> XQueryDeviceState</code></a>
can generate
<code class="function">BadDevice</code>
errors.
</p><p>
To free the data returned by this function, use
<code class="function">XFreeDeviceState .</code>
</p><div class="funcsynopsis"><a id="XFreeDeviceState"></a><p><code class="funcdef">void <strong class="fsfunc"> XFreeDeviceState</strong>(</code>XDeviceState<var class="pdparam"> *state</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>state</em></span>
</span></p></td><td><p>
Specifies the pointer to the
<code class="function">XDeviceState</code>
data returned by a previous call to
<code class="function">XQueryDeviceState .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XFreeDeviceState"><code class="function"> XFreeDeviceState</code></a>
frees the device state data.
</p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Events"></a>Events</h3></div></div></div><p>
The input extension creates input events analogous to the core input events.
These extension input events are generated by manipulating one of the
extension input devices.
The remainder of this section discusses the following X Input Extension
event topics:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
Event types
</p></li><li class="listitem"><p>
Event classes
</p></li><li class="listitem"><p>
Event structures
</p></li></ul></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Event_Types"></a>Event Types</h4></div></div></div><p>
Event types are integer numbers that a client can use to determine what
kind of event it has received. The client compares the type field of
the event structure with known event types to make this determination.
</p><p>
The core input event types are constants and are defined in the header file
<code class="function">< X11/X.h >.</code>
Extension event types are not constants. Instead, they
are dynamically allocated by the extension's request to the X server
when the extension is initialized. Because of this, extension event
types must be obtained by the client from the server.
</p><p>
The client program determines the event type for an extension event by using
the information returned by the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
request.
This type can then be used for comparison with the type field
of events received by the client.
</p><p>
Extension events propagate up the window hierarchy in the same manner
as core events. If a window is not interested in an extension event,
it usually propagates to the closest ancestor that is interested,
unless the dont_propagate list prohibits it.
Grabs of extension devices may alter the set of windows that receive a particular
extension event.
</p><p>
The following table lists the event category and its associated event
type or types.
</p><div class="informaltable"><table border="1"><colgroup><col align="center" class="c1" /><col align="center" class="c2" /></colgroup><thead><tr><th align="center">Event Category</th><th align="center">Event Type</th></tr></thead><tbody><tr><td align="center">Device key</td><td align="center"><code class="function">DeviceKeyPress</code></td></tr><tr><td align="center"> </td><td align="center"><code class="function">DeviceKeyRelease</code></td></tr><tr><td align="center">Device motion</td><td align="center"><code class="function">DeviceButtonPress</code></td></tr><tr><td align="center"> </td><td align="center"><code class="function">DeviceButtonRelease</code></td></tr><tr><td align="center"> </td><td align="center"><code class="function">DeviceMotionNotify</code></td></tr><tr><td align="center">Device input focus</td><td align="center"><code class="function">DeviceFocusIn</code></td></tr><tr><td align="center"> </td><td align="center"><code class="function">DeviceFocusOut</code></td></tr><tr><td align="center">Device state notification</td><td align="center"><code class="function">DeviceStateNotify</code></td></tr><tr><td align="center">Device proximity</td><td align="center"><code class="function">ProximityIn</code></td></tr><tr><td align="center"> </td><td align="center"><code class="function">ProximityOut</code></td></tr><tr><td align="center">Device mapping</td><td align="center"><code class="function">DeviceMappingNotify</code></td></tr><tr><td align="center">Device change</td><td align="center"><code class="function">ChangeDeviceNotify</code></td></tr></tbody></table></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Event_Classes"></a>Event Classes</h4></div></div></div><p>
Event classes are integer numbers that are used in the same way as the
core event masks. They are used by a client program to indicate to the
server which events that client program wishes to receive.
</p><p>
The core input event masks are constants and are defined in the header file
<code class="function">< X11/X.h >.</code>
Extension event classes are not constants. Instead, they are dynamically
allocated by the extension's request to the X server
when the extension is initialized. Because of this, extension event
classes must be obtained by the client from the server.
</p><p>
The event class for an extension event and device is obtained from
information returned by the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
function.
This class can then be used in an
<a class="xref" href="#XSelectExtensionEvent"><code class="function"> XSelectExtensionEvent</code></a>
request to ask that events of that type from that device be sent to
the client program.
</p><p>
For
<code class="function">DeviceButtonPress</code>
events, the client may specify whether
or not an implicit passive grab should be done when the button is
pressed. If the client wants to guarantee that it will receive a
<code class="function">DeviceButtonRelease</code>
event for each
<code class="function">DeviceButtonPress</code>
event it receives, it should specify the
<code class="function">DeviceButtonPressGrab</code>
class in addition to the
<code class="function">DeviceButtonPress</code>
class.
This restricts the client in that only one client at a time
may request
<code class="function">DeviceButtonPress</code>
events from the same device and
window if any client specifies this class.
</p><p>
If any client has specified the
<code class="function">DeviceButtonPressGrab</code>
class, any requests by any other client that specify the same device
and window and specify either
<code class="function">DeviceButtonPress</code>
or
<code class="function">DeviceButtonPressGrab</code>
will cause an
<code class="function">Access</code>
error to be generated.
</p><p>
If only the
<code class="function">DeviceButtonPress</code>
class is specified, no implicit passive grab will be done when a button
is pressed on the device.
Multiple clients may use this class to specify the same device and
window combination.
</p><p>
The client may also select
<code class="function">DeviceMotion</code>
events only when a button is down.
It does this by specifying the event classes
<code class="function">DeviceButton1Motion</code>
through
<code class="function">DeviceButton5Motion . </code>
An input device will support only
as many button motion classes as it has buttons.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Event_Structures"></a>Event Structures</h4></div></div></div><p>
Each extension event type has a corresponding structure declared in
<code class="function">< X11/extensions/XInput.h >.</code>
All event structures have the following common members:
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
type
</span></p></td><td><p>
Set to the event type number that uniquely identifies it. For example,
when the X server reports a
<code class="function">DeviceKeyPress</code>
event to a client application, it sends an
<code class="function">XDeviceKeyPressEvent</code>
structure.
</p></td></tr><tr><td><p><span class="term">
serial
</span></p></td><td><p>
Set from the serial number reported in the protocol but expanded from the
16-bit least significant bits to a full 32-bit value.
</p></td></tr><tr><td><p><span class="term">
send_event
</span></p></td><td><p>
Set to
<code class="function">True</code>
if the event came from an
<span class="olink"><code class="function">XSendEvent</code></span>
request.
</p></td></tr><tr><td><p><span class="term">
display
</span></p></td><td><p>
Set to a pointer to a structure that defines the display
on which the event was read.
</p></td></tr></tbody></table></div><p>
</p><p>
Extension event structures report the current position of the X pointer.
In addition, if the device reports motion data and is reporting absolute data,
the current value of any valuators the device contains is also reported.
</p><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a id="Device_Key_Events"></a>Device Key Events</h5></div></div></div><p>
Key events from extension devices contain all the information that is
contained in a key event from the X keyboard. In addition, they contain
a device ID and report the current value of any valuators on the device,
if that device is reporting absolute data.
If data for more than six valuators is being reported, more than one
key event will be sent.
The axes_count member contains the number of axes that are being
reported. The server sends as many of these events as are
needed to report the device data. Each event contains the total number
of axes reported in the axes_count member and the first axis reported
in the current event in the first_axis member.
If the device supports input class
<code class="function">Valuators , </code>
but is not reporting absolute mode data,
the axes_count member contains zero (0).
</p><p>
The location reported in
the x, y and x_root, y_root members is the location of the core X pointer.
</p><p>
The
<code class="function">XDeviceKeyEvent</code>
structure is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
int type; /* of event */
unsigned long serial; /* # of last request processed */
Bool send_event; /* true if from SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* "event" window reported relative to */
XID deviceid;
Window root; /* root window event occurred on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* x, y coordinates in event window */
int x_root; /* coordinates relative to root */
int y_root; /* coordinates relative to root */
unsigned int state; /* key or button mask */
unsigned int keycode; /* detail */
Bool same_screen; /* same screen flag */
unsigned int device_state; /* device key or button mask */
unsigned char axes_count;
unsigned char first_axis;
int axis_data[6];
} XDeviceKeyEvent;
typedef XDeviceKeyEvent XDeviceKeyPressedEvent;
typedef XDeviceKeyEvent XDeviceKeyReleasedEvent;
</pre><p>
</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a id="Device_Button_Events"></a>Device Button Events</h5></div></div></div><p>
Button events from extension devices contain all the information that is
contained in a button event from the X pointer. In addition, they contain
a device ID and report the current value of any valuators on the device
if that device is reporting absolute data.
If data for more than six valuators is being reported, more than one
button event may be sent.
The axes_count member contains the number of axes that are being
reported. The server sends as many of these events as are
needed to report the device data. Each event contains the total number
of axes reported in the axes_count member and the first axis reported
in the current event in the first_axis member.
If the device supports input class
<code class="function">Valuators , </code>
but is not reporting absolute mode data,
the axes_count member contains zero (0).
</p><p>
The location reported in
the x, y and x_root, y_root members is the location of the core X pointer.
</p><p>
</p><pre class="literallayout">
typedef struct {
int type; /* of event */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* "event" window reported relative to */
XID deviceid;
Window root; /* root window that the event occurred on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* x, y coordinates in event window */
int x_root; /* coordinates relative to root */
int y_root; /* coordinates relative to root */
unsigned int state; /* key or button mask */
unsigned int button; /* detail */
Bool same_screen; /* same screen flag */
unsigned int device_state; /* device key or button mask */
unsigned char axes_count;
unsigned char first_axis;
int axis_data[6];
} XDeviceButtonEvent;
typedef XDeviceButtonEvent XDeviceButtonPressedEvent;
typedef XDeviceButtonEvent XDeviceButtonReleasedEvent;
</pre><p>
</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a id="Device_Motion_Events"></a>Device Motion Events</h5></div></div></div><p>
Motion events from extension devices contain all the information that is
contained in a motion event from the X pointer. In addition, they contain
a device ID and report the current value of any valuators on the device.
</p><p>
The location reported in
the x, y and x_root, y_root members is the location of the core X pointer,
and so is 2-dimensional.
</p><p>
Extension motion devices may report motion data for a variable number of
axes.
The axes_count member contains the number of axes that are being
reported. The server sends as many of these events as are
needed to report the device data. Each event contains the total number
of axes reported in the axes_count member and the first axis reported
in the current event in the first_axis member.
</p><p>
</p><pre class="literallayout">
typedef struct {
int type; /* of event */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* "event" window reported relative to */
XID deviceid;
Window root; /* root window that the event occurred on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* x, y coordinates in event window */
int x_root; /* coordinates relative to root */
int y_root; /* coordinates relative to root */
unsigned int state; /* key or button mask */
char is_hint; /* detail */
Bool same_screen; /* same screen flag */
unsigned int device_state; /* device key or button mask */
unsigned char axes_count;
unsigned char first_axis;
int axis_data[6];
} XDeviceMotionEvent;
</pre><p>
</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a id="Device_Focus_Events"></a>Device Focus Events</h5></div></div></div><p>
These events are equivalent to the core focus events.
They contain the same information, with the addition
of a device ID to identify which device has had a focus change,
and a timestamp.
</p><p>
<code class="function">DeviceFocusIn</code>
and
<code class="function">DeviceFocusOut</code>
events are generated for
focus changes of extension devices in the same manner as core focus
events are generated.
</p><p>
</p><pre class="literallayout">
typedef struct {
int type; /* of event */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* "event" window it is reported relative to */
XID deviceid;
int mode; /* NotifyNormal, NotifyGrab, NotifyUngrab */
int detail;
/*
* NotifyAncestor, NotifyVirtual, NotifyInferior,
* NotifyNonLinear,NotifyNonLinearVirtual, NotifyPointer,
* NotifyPointerRoot, NotifyDetailNone
*/
Time time;
} XDeviceFocusChangeEvent;
typedef XDeviceFocusChangeEvent XDeviceFocusInEvent;
typedef XDeviceFocusChangeEvent XDeviceFocusOutEvent;
</pre><p>
</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a id="Device_StateNotify_Event"></a>Device StateNotify Event</h5></div></div></div><p>
This event is analogous to the core keymap event but
reports the current state of the device for each
input class that it supports.
It is generated after every
<code class="function">DeviceFocusIn</code>
event and
<code class="function">EnterNotify</code>
event and is delivered to clients who have selected
<code class="function">XDeviceStateNotify</code>
events.
</p><p>
If the device supports input class
<code class="function">Valuators ,</code>
the mode member in the
<code class="function">XValuatorStatus</code>
structure is a bitmask that reports the device mode,
proximity state, and other state information.
The following bits are currently defined:
</p><pre class="literallayout">
0x01 Relative = 0, Absolute = 1
0x02 InProximity = 0, OutOfProximity = 1
</pre><p>
</p><p>
If the device supports more valuators than can be reported in a single
<code class="function">XEvent ,</code>
multiple
<code class="function">XDeviceStateNotify</code>
events will be generated.
</p><p>
</p><pre class="literallayout">
typedef struct {
unsigned char class;
unsigned char length;
} XInputClass;
typedef struct {
int type;
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
XID deviceid;
Time time;
int num_classes;
char data[64];
} XDeviceStateNotifyEvent;
typedef struct {
unsigned char class;
unsigned char length;
unsigned char num_valuators;
unsigned char mode;
int valuators[6];
} XValuatorStatus;
typedef struct {
unsigned char class;
unsigned char length;
short num_keys;
char keys[32];
} XKeyStatus;
typedef struct {
unsigned char class;
unsigned char length;
short num_buttons;
char buttons[32];
} XButtonStatus;
</pre><p>
</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a id="Device_Mapping_Event"></a>Device Mapping Event</h5></div></div></div><p>
This event is equivalent to the core
<code class="function">MappingNotify</code>
event.
It notifies client programs when the mapping of keys,
modifiers, or buttons on an extension device has changed.
</p><p>
</p><pre class="literallayout">
typedef struct {
int type;
unsigned long serial;
Bool send_event;
Display *display;
Window window;
XID deviceid;
Time time;
int request;
int first_keycode;
int count;
} XDeviceMappingEvent;
</pre><p>
</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a id="ChangeDeviceNotify_Event"></a>ChangeDeviceNotify Event</h5></div></div></div><p>
This event has no equivalent in the core protocol. It notifies client
programs when one of the core devices has been changed.
</p><p>
</p><pre class="literallayout">
typedef struct {
int type;
unsigned long serial;
Bool send_event;
Display *display;
Window window;
XID deviceid;
Time time;
int request;
} XChangeDeviceNotifyEvent;
</pre><p>
</p></div><div class="sect4"><div class="titlepage"><div><div><h5 class="title"><a id="Proximity_Events"></a>Proximity Events</h5></div></div></div><p>
These events have no equivalent in the core protocol. Some input
devices such as graphics tablets or touchscreens may send these
events to indicate that a stylus has moved into or out of contact
with a positional sensing surface.
</p><p>
The event contains the current value of any valuators on the device
if that device is reporting absolute data.
If data for more than six valuators is being reported, more than one
proximity event may be sent.
The axes_count member contains the number of axes that are being
reported. The server sends as many of these events as are
needed to report the device data. Each event contains the total number
of axes reported in the axes_count member and the first axis reported
in the current event in the first_axis member.
If the device supports input class
<code class="function">Valuators , </code>
but is not reporting absolute mode data,
the axes_count member contains zero (0).
</p><p>
</p><pre class="literallayout">
typedef struct {
int type; /* ProximityIn or ProximityOut */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
XID deviceid;
Window root;
Window subwindow;
Time time;
int x, y;
int x_root, y_root;
unsigned int state;
Bool same_screen;
unsigned int device_state; /* device key or button mask */
unsigned char axes_count;
unsigned char first_axis;
int axis_data[6];
} XProximityNotifyEvent;
typedef XProximityNotifyEvent XProximityInEvent;
typedef XProximityNotifyEvent XProximityOutEvent;
</pre><p>
</p></div></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Event_Handling_Functions"></a>Event Handling Functions</h3></div></div></div><p>
This section discusses the X Input Extension
event handling functions that allow you to:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
Determine the extension version
</p></li><li class="listitem"><p>
List the available devices
</p></li><li class="listitem"><p>
Enable and disable extension devices
</p></li><li class="listitem"><p>
Change the mode of a device
</p></li><li class="listitem"><p>
Initialize valuators on an input device
</p></li><li class="listitem"><p>
Get input device controls
</p></li><li class="listitem"><p>
Change input device controls
</p></li><li class="listitem"><p>
Select extension device events
</p></li><li class="listitem"><p>
Determine selected device events
</p></li><li class="listitem"><p>
Control event propogation
</p></li><li class="listitem"><p>
Send an event
</p></li><li class="listitem"><p>
Get motion history
</p></li></ul></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Determining_the_Extension_Version"></a>Determining the Extension Version</h4></div></div></div><p>
</p><div class="funcsynopsis"><a id="XGetExtensionVersion"></a><p><code class="funcdef">XExtensionVersion * <strong class="fsfunc"> XGetExtensionVersion</strong>(</code>Display<var class="pdparam"> *display</var>, char<var class="pdparam"> *name</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>name</em></span>
</span></p></td><td><p>
Specifies the name of the desired extension.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetExtensionVersion"><code class="function"> XGetExtensionVersion</code></a>
allows a client to determine whether a server supports
the desired version of the input extension.
</p><p>
The
<code class="function">XExtensionVersion</code>
structure returns information about the version of the extension
supported by the server and is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
Bool present;
short major_version;
short minor_version;
} XExtensionVersion;
</pre><p>
</p><p>
The major and minor versions can be compared with constants defined in
the header file
<code class="function">< X11/extensions/XI.h >.</code>
Each version is a superset of the previous versions.
</p><p>
You should use
<span class="olink"><code class="function">XFree</code></span>.
to free the data returned by this function.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Listing_Available_Devices"></a>Listing Available Devices</h4></div></div></div><p>
A client program that wishes to access a specific device
must first determine whether that device is connected to the X server. This
is done through the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
function, which will return a list of all devices that can be opened
by the X server. The client program can use one
of the names defined in the
<code class="function">< X11/extensions/XI.h ></code>
header file in an
<span class="olink"><code class="function">XInternAtom</code></span>
request to determine the device type of the desired device. This type
can then be compared with the device types returned by the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
request.
</p><p>
</p><div class="funcsynopsis"><a id="XListInputDevices"></a><p><code class="funcdef">XDeviceInfo * <strong class="fsfunc"> XListInputDevices</strong>(</code>Display<var class="pdparam"> *display</var>, int<var class="pdparam"> *ndevices</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>ndevices</em></span>
</span></p></td><td><p>
Specifies the address of a variable into which the server
can return the number of input devices available to the X server.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
allows a client to determine which devices
are available for X input and information about those devices.
An array of
<code class="function">XDeviceInfo</code>
structures is returned, with one element in the array for each device.
The number of devices is returned in the ndevices argument.
</p><p>
The X pointer device and X keyboard device are reported, as well as
all available extension input devices. The use member of the
<code class="function">XDeviceInfo</code>
structure specifies the current use of the device.
If the value of this member is
<code class="function">IsXPointer ,</code>
the device is the X pointer device. If the value is
<code class="function">IsXKeyboard ,</code>
the device is the X keyboard device. If the value is
<code class="function">IsXExtensionDevice ,</code>
the device is available for use as an extension input device.
</p><p>
Each
<code class="function">XDeviceInfo</code>
entry contains a pointer to a list of structures
that describe the characteristics of each class
of input supported by that device. The num_classes member
contains the number of entries in that list.
</p><p>
If the device supports input class
<code class="function">Valuators ,</code>
one of the structures pointed to by the
<code class="function">XDeviceInfo</code>
structure will be an
<code class="function">XValuatorInfo</code>
structure. The axes member of that structure
contains the address of an array of
<code class="function">XAxisInfo</code>
structures.
There is one element in this array for each axis of motion
reported by the device. The number of elements in this
array is contained in the num_axes element of the
<code class="function">XValuatorInfo</code>
structure.
The size of the motion buffer for the device is
reported in the motion_buffer member of the
<code class="function">XValuatorInfo</code>
structure.
</p><p>
The
<code class="function">XDeviceInfo</code>
structure is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct _XDeviceInfo {
XID id;
Atom type;
char *name;
int num_classes;
int use;
XAnyClassPtr inputclassinfo;
} XDeviceInfo;
</pre><p>
</p><p>
The structures pointed to by the
<code class="function">XDeviceInfo</code>
structure are defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct _XKeyInfo {
XID class;
int length;
unsigned short min_keycode;
unsigned short max_keycode;
unsigned short num_keys;
} XKeyInfo;
typedef struct _XButtonInfo {
XID class;
int length;
short num_buttons;
} XButtonInfo;
typedef struct _XValuatorInfo {
XID class;
int length;
unsigned char num_axes;
unsigned char mode;
unsigned long motion_buffer;
XAxisInfoPtr axes;
} XValuatorInfo;
</pre><p>
</p><p>
The
<code class="function">XAxisInfo</code>
structure pointed to by the
<code class="function">XValuatorInfo</code>
structure is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct _XAxisInfo {
int resolution;
int min_value;
int max_value;
} XAxisInfo;
</pre><p>
</p><p>
The following atom names are defined in the
<code class="function">< X11/extensions/XI.h ></code>
header file.
</p><pre class="literallayout">
MOUSE QUADRATURE
TABLET SPACEBALL
KEYBOARD DATAGLOVE
TOUCHSCREEN EYETRACKER
TOUCHPAD CURSORKEYS
BUTTONBOX FOOTMOUSE
BARCODE ID_MODULE
KNOB_BOX ONE_KNOB
TRACKBALL NINE_KNOB\s+1
</pre><p>
</p><p>
These names can be used in an
<span class="olink"><code class="function">XInternAtom</code></span>
request to return an atom that can be used for comparison
with the type member of the
<code class="function">XDeviceInfo</code>
structure.
</p><p>
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
returns NULL if there are no input devices to list.
</p><p>
To free the data returned by
<code class="function">XListInputDevices ,</code>
use
<code class="function">XFreeDeviceList .</code>
</p><p>
</p><div class="funcsynopsis"><a id="XFreeDeviceList"></a><p><code class="funcdef">void <strong class="fsfunc"> XFreeDeviceList</strong>(</code>XDeviceInfo<var class="pdparam"> *list</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>list</em></span>
</span></p></td><td><p>
Specifies the pointer to the
<code class="function">XDeviceInfo</code>
array returned by a previous call to
<code class="function">XListInputDevices .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XFreeDeviceList"><code class="function"> XFreeDeviceList</code></a>
frees the list of input device information.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Enabling_and_Disabling_Extension_Devices"></a>Enabling and Disabling Extension Devices</h4></div></div></div><p>
Each client program that wishes to access an extension device must request
that the server open that device by calling the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
function.
</p><div class="funcsynopsis"><a id="XOpenDevice"></a><p><code class="funcdef">XDevice * <strong class="fsfunc"> XOpenDevice</strong>(</code>Display<var class="pdparam"> *display</var>, XID<var class="pdparam"> device_id</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device_id</em></span>
</span></p></td><td><p>
Specifies the ID that uniquely identifies the device to be opened.
This ID is obtained from the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
request.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
opens the device for the requesting client and, on success, returns an
<code class="function">XDevice</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID device_id;
int num_classes;
XInputClassInfo *classes;
} XDevice;
</pre><p>
</p><p>
The
<code class="function">XDevice</code>
structure contains a pointer to an array of
<code class="function">XInputClassInfo</code>
structures. Each element in that array
contains information about events of a particular input class supported
by the input device.
</p><p>
The
<code class="function">XInputClassInfo</code>
structure is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
unsigned char input_class;
unsigned char event_type_base;
} XInputClassInfo;
</pre><p>
</p><p>
A client program can determine the event
type and event class for a given event by using macros defined by the
input extension. The name of the macro corresponds to the desired event,
and the macro is passed the structure that describes the device from which
input is desired, for example:
</p><p>
</p><pre class="literallayout">
DeviceKeyPress(XDevice *device, event_type, event_class)
</pre><p>
</p><p>
The macro will fill in the values of the event class to be used in an
<a class="xref" href="#XSelectExtensionEvent"><code class="function"> XSelectExtensionEvent</code></a>
request to select the event and the event type to be used in comparing
with the event types of events received via
<span class="olink"><code class="function">XNextEvent</code></span>.
</p><p>
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
can generate
<code class="function">BadDevice</code>
errors.
</p><p>
Before terminating, the client program should request that the server close
the device by calling the
<a class="xref" href="#XCloseDevice"><code class="function"> XCloseDevice</code></a>
function.
</p><div class="funcsynopsis"><a id="XCloseDevice"></a><p><code class="funcdef">int <strong class="fsfunc"> XCloseDevice</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the device to be closed.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XCloseDevice"><code class="function"> XCloseDevice</code></a>
closes the device for the requesting client and frees the associated
<code class="function">XDevice</code>
structure.
</p><p>
A client may open the same extension device more than once. Requests
after the first successful one return an additional
<code class="function">XDevice</code>
structure
with the same information as the first, but otherwise have no effect.
A single
<a class="xref" href="#XCloseDevice"><code class="function"> XCloseDevice</code></a>
request will terminate that client's access to the device.
</p><p>
Closing a device releases any active or passive grabs the requesting client
has established. If the device is frozen only by an active grab of the
requesting client, any queued events are released.
</p><p>
If a client program terminates without closing a device, the server will
automatically close that device on behalf of the client. This does not
affect any other clients that may be accessing that device.
</p><p>
<a class="xref" href="#XCloseDevice"><code class="function"> XCloseDevice</code></a>
can generate
<code class="function">BadDevice</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Changing_the_Mode_of_a_Device"></a>Changing the Mode of a Device</h4></div></div></div><p>
Some devices are capable of reporting either relative or absolute motion
data.
To change the mode of a device from relative to absolute, use
<code class="function">XSetDeviceMode .</code>
</p><div class="funcsynopsis"><a id="XSetDeviceMode"></a><p><code class="funcdef">int <strong class="fsfunc"> XSetDeviceMode</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int<var class="pdparam"> mode</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the device whose mode should be changed.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>mode</em></span>
</span></p></td><td><p>
Specifies the mode. You can pass
<code class="function">Absolute</code>
or
<code class="function">Relative .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XSetDeviceMode"><code class="function"> XSetDeviceMode</code></a>
allows a client to request the server to change the mode of a
device that is capable of reporting either absolute positional data or relative
motion data. If the device is invalid or if the client has not previously
requested that the server open the device via an
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
request, this request will fail with a
<code class="function">BadDevice</code>
error.
If the device does not support input class
<code class="function">Valuators</code>
or if it is not capable of reporting the specified mode,
the request will fail with a
<code class="function">BadMatch</code>
error.
</p><p>
This request will fail and return
<code class="function">DeviceBusy</code>
if another client has already opened the device and requested a different mode.
</p><p>
<a class="xref" href="#XSetDeviceMode"><code class="function"> XSetDeviceMode</code></a>
can generate
<code class="function">BadDevice ,</code>
<code class="function">BadMatch ,</code>
<code class="function">BadMode ,</code>
and
<code class="function">DeviceBusy</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Initializing_Valuators_on_an_Input_Device"></a>Initializing Valuators on an Input Device</h4></div></div></div><p>
Some devices that report absolute positional data can be initialized to a
starting value. Devices that are capable of reporting relative motion or
absolute positional data may require that their valuators be initialized
to a starting value after the mode of the device is changed to
<code class="function">Absolute .</code>
</p><p>
To initialize the valuators on such a device, use
<code class="function">XSetDeviceValuators .</code>
</p><div class="funcsynopsis"><a id="XSetDeviceValuators"></a><p><code class="funcdef">Status <strong class="fsfunc"> XSetDeviceValuators</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int*valuators,first_valuator,<var class="pdparam"> num_valuators</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the device whose valuators should be initialized.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>valuators</em></span>
</span></p></td><td><p>
Specifies the values to which each valuator should be set.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>first_valuator</em></span>
</span></p></td><td><p>
Specifies the first valuator to be set.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>num_valuators</em></span>
</span></p></td><td><p>
Specifies the number of valuators to be set.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XSetDeviceValuators"><code class="function"> XSetDeviceValuators</code></a>
initializes the specified valuators on the specified extension
input device. Valuators are numbered beginning with zero. Only the valuators
in the range specified by first_valuator and num_valuators are set.
A
<code class="function">BadValue</code>
error results if the number of valuators supported by the device
is less than the following expression:
</p><pre class="literallayout">
first_valuator + num_valuators
</pre><p>
</p><p>
If the request succeeds,
<code class="function">Success</code>
is returned. If the specified device is grabbed by some other client,
the request will fail and a status of
<code class="function">AlreadyGrabbed</code>
will be returned.
</p><p>
<a class="xref" href="#XSetDeviceValuators"><code class="function"> XSetDeviceValuators</code></a>
can generate
<code class="function">BadDevice ,</code>
<code class="function">BadLength ,</code>
<code class="function">BadMatch ,</code>
and
<code class="function">BadValue</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Getting_Input_Device_Controls"></a>Getting Input Device Controls</h4></div></div></div><p>
Some input devices support various configuration controls
that can be queried or changed by clients. The set of supported
controls will vary from one input device to another. Requests
to manipulate these controls will fail if either the target
X server or the target input device does not support the
requested device control.
</p><p>
Each device control has a unique identifier. Information
passed with each device control varies in length and is mapped
by data structures unique to that device control.
</p><p>
To query a device control, use
<code class="function">XGetDeviceControl .</code>
</p><div class="funcsynopsis"><a id="XGetDeviceControl"></a><p><code class="funcdef">XDeviceControl * <strong class="fsfunc"> XGetDeviceControl</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int<var class="pdparam"> control</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the device whose configuration control status is to be returned.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>control</em></span>
</span></p></td><td><p>
Identifies the specific device control to be queried.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetDeviceControl"><code class="function"> XGetDeviceControl</code></a>
returns the current state of the specified device control.
If the target X server does not support that device control, a
<code class="function">BadValue</code>
error is returned.
If the specified device does not support that device control, a
<code class="function">BadMatch</code>
error
is returned.
</p><p>
If the request is successful, a pointer to a generic
<code class="function">XDeviceState</code>
structure is returned. The information returned varies according
to the specified control and is mapped by a structure appropriate
for that control.
The first two members are common to all device controls
and are defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID control;
int length;
} XDeviceState;
\fP
</pre><p>
</p><p>
The control may be compared to constants defined in the file
<code class="function">< X11/extensions/XI.h >.</code>
Currently defined device controls include DEVICE_RESOLUTION.
</p><p>
The information returned for the DEVICE_RESOLUTION control is
defined in the
<code class="function">XDeviceResolutionState</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID control;
int length;
int num_valuators;
int *resolutions;
int *min_resolutions;
int *max_resolutions;
} XDeviceResolutionState;
</pre><p>
</p><p>
This device control returns a list of valuators and the range of
valid resolutions allowed for each. Valuators are numbered
beginning with zero (0). Resolutions for all valuators on the device are
returned. For each valuator i on the device, resolutions[i] returns
the current setting of the resolution, min_resolutions[i] returns
the minimum valid setting, and max_resolutions[i] returns the
maximum valid setting.
</p><p>
When this control is specified,
<a class="xref" href="#XGetDeviceControl"><code class="function"> XGetDeviceControl</code></a>
fails with a
<code class="function">BadMatch</code>
error if the specified device has no valuators.
</p><p>
<a class="xref" href="#XGetDeviceControl"><code class="function"> XGetDeviceControl</code></a>
can generate
<code class="function">BadMatch</code>
and
<code class="function">BadValue</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Changing_Input_Device_Controls"></a>Changing Input Device Controls</h4></div></div></div><p>
Some input devices support various configuration controls
that can be changed by clients. Typically, this would be
done to initialize the device to a known state or configuration.
The set of supported controls will vary from one input device
to another. Requests to manipulate these controls will fail if
either the target X server or the target input device does not
support the requested device control. Setting the device control
will also fail if the target input device is grabbed by another
client or is open by another client and has been set to a conflicting
state.
</p><p>
Each device control has a unique identifier. Information
passed with each device control varies in length and is mapped
by data structures unique to that device control.
</p><p>
To change a device control, use
<code class="function">XChangeDeviceControl .</code>
</p><div class="funcsynopsis"><a id="XChangeDeviceControl"></a><p><code class="funcdef">Status <strong class="fsfunc"> XChangeDeviceControl</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, int<var class="pdparam"> control</var>, XDeviceControl<var class="pdparam"> *value</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the device whose configuration control status is to be modified.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>control</em></span>
</span></p></td><td><p>
Identifies the specific device control to be changed.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>value</em></span>
</span></p></td><td><p>
Specifies a pointer to an
<code class="function">XDeviceControl</code>
structure that describes which control is to be changed
and how it is to be changed.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XChangeDeviceControl"><code class="function"> XChangeDeviceControl</code></a>
changes the current state of the specified device control.
If the target X server does not support that device control, a
<code class="function">BadValue</code>
error is returned.
If the specified device does not support that device control, a
<code class="function">BadMatch</code>
error is returned.
If another client has the target device grabbed, a status of
<code class="function">AlreadyGrabbed</code>
is returned.
If another client has the device open and has set it to a
conflicting state, a status of
<code class="function">DeviceBusy</code>
is returned.
If the request fails for any reason, the device control will not
be changed.
</p><p>
If the request is successful, the device control will be changed
and a status of
<code class="function">Success</code>
is returned.
The information passed varies according to the specified control
and is mapped by a structure appropriate for that control.
The first two members are common to all device controls:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID control;
int length;
} XDeviceControl;
</pre><p>
</p><p>
The control may be set using constants defined in the
<code class="function">< X11/extensions/XI.h ></code>
header file.
Currently defined device controls include DEVICE_RESOLUTION.
</p><p>
The information that can be changed by the DEVICE_RESOLUTION
control is defined in the
<code class="function">XDeviceResolutionControl</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
XID control;
int length;
int first_valuator;
int num_valuators;
int *resolutions;
} XDeviceResolutionControl;
</pre><p>
</p><p>
This device control changes the resolution of the specified
valuators on the specified extension input device. Valuators
are numbered beginning with zero. Only the valuators in the range
specified by first_valuator and num_valuators are set. A value
of -1 in the resolutions list indicates that the resolution for
this valuator is not to be changed. The num_valuators member
specifies the number of valuators in the resolutions list.
</p><p>
When this control is specified,
<a class="xref" href="#XChangeDeviceControl"><code class="function"> XChangeDeviceControl</code></a>
fails with a
<code class="function">BadMatch</code>
error if the specified device has no valuators.
If a resolution is specified that is not within the range of valid values
(as returned by
<code class="function">XGetDeviceControl ),</code>
<a class="xref" href="#XChangeDeviceControl"><code class="function"> XChangeDeviceControl</code></a>
fails with a
<code class="function">BadValue</code>
error.
A
<code class="function">BadValue</code>
error results if the number of valuators supported by the device
is less than the following expression:
</p><p>
</p><pre class="literallayout">
first_valuator + num_valuators,
</pre><p>
</p><p>
<a class="xref" href="#XChangeDeviceControl"><code class="function"> XChangeDeviceControl</code></a>
can generate
<code class="function">BadMatch</code>
and
<code class="function">BadValue</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Selecting_Extension_Device_Events"></a>Selecting Extension Device Events</h4></div></div></div><p>
To select device input events, use
<code class="function">XSelectExtensionEvent .</code>
The parameters passed are a pointer to
a list of classes that define the desired event types and devices, a count
of the number of elements in the list, and the ID of the window from which
events are desired.
</p><div class="funcsynopsis"><a id="XSelectExtensionEvent"></a><p><code class="funcdef">int <strong class="fsfunc"> XSelectExtensionEvent</strong>(</code>Display<var class="pdparam"> *display</var>, Window<var class="pdparam"> window</var>, XEventClass<var class="pdparam"> *event_list</var>, int<var class="pdparam"> event_count</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>window</em></span>
</span></p></td><td><p>
Specifies the ID of the window from which the client wishes to receive events.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_list</em></span>
</span></p></td><td><p>
Specifies a pointer to an array of event classes
that specify which events are desired.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_count</em></span>
</span></p></td><td><p>
Specifies the number of elements in the event_list.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XSelectExtensionEvent"><code class="function"> XSelectExtensionEvent</code></a>
requests the server to send events that match the events and
devices described by the event list and that come from the requested
window.
The elements of the
<code class="function">XEventClass</code>
array are the event_class values
obtained by invoking a macro with the pointer to an
<code class="function">XDevice</code>
structure returned by the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
request.
For example, the
<code class="function">DeviceKeyPress</code>
macro would return the
<code class="function">XEventClass</code>
for
<code class="function">DeviceKeyPress</code>
events from the specified device if it were invoked in the following form:
</p><pre class="literallayout">
DeviceKeyPress (XDevice *device, event_type, event_class)
</pre><p>
</p><p>
Macros are defined for the following event classes:
</p><pre class="literallayout">
<code class="function">DeviceKeyPress</code>
<code class="function">DeviceKeyRelease</code>
<code class="function">DeviceButtonPress</code>
<code class="function">DeviceButtonRelease</code>
<code class="function">DeviceMotionNotify</code>
<code class="function">DeviceFocusIn</code>
<code class="function">DeviceFocusOut</code>
<code class="function">ProximityIn</code>
<code class="function">ProximityOut</code>
<code class="function">DeviceStateNotify</code>
<code class="function">DeviceMappingNotify</code>
<code class="function">ChangeDeviceNotify</code>
<code class="function">DevicePointerMotionHint</code>
<code class="function">DeviceButton1Motion </code>
<code class="function">DeviceButton2Motion</code>
<code class="function">DeviceButton3Motion, </code>
<code class="function">DeviceButton4Motion</code>
<code class="function">DeviceButton5Motion</code>
<code class="function">DeviceButtonMotion,</code>
<code class="function">DeviceOwnerGrabButton</code>
<code class="function">DeviceButtonPressGrab</code>
</pre><p>
</p><p>
To get the next available event from within a client program, use the core
<span class="olink"><code class="function">XNextEvent</code></span>
function. This returns the next event whether it
came from a core device or an extension device.
</p><p>
Succeeding
<a class="xref" href="#XSelectExtensionEvent"><code class="function"> XSelectExtensionEvent</code></a>
requests using event classes
for the same device as was specified on a previous request will replace
the previous set of selected events from that device with the new set.
</p><p>
<a class="xref" href="#XSelectExtensionEvent"><code class="function"> XSelectExtensionEvent</code></a>
can generate
<code class="function">BadAccess , </code>
<code class="function">BadClass ,</code>
<code class="function">BadLength ,</code>
and
<code class="function">BadWindow</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Determining_Selected_Device_Events"></a>Determining Selected Device Events</h4></div></div></div><p>
To determine which extension events are currently selected from a given
window, use
<code class="function">XGetSelectedExtensionEvents .</code>
</p><div class="funcsynopsis"><a id="XGetSelectedExtensionEvents"></a><p><code class="funcdef">int <strong class="fsfunc"> XGetSelectedExtensionEvents</strong>(</code>Display<var class="pdparam"> *display</var>, Window<var class="pdparam"> window</var>, int<var class="pdparam"> *this_client_count</var>, XEventClass<var class="pdparam"> **this_client</var>, int<var class="pdparam"> *all_clients_count</var>, XEventClass<var class="pdparam"> **all_clients</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>window</em></span>
</span></p></td><td><p>
Specifies the ID of the window from which the client wishes to receive events.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>this_client_count</em></span>
</span></p></td><td><p>
Returns the number of elements in the this_client list.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>this_client</em></span>
</span></p></td><td><p>
Returns a list of
<code class="function">XEventClasses</code>
that specify which events are
selected by this client.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>all_clients_count</em></span>
</span></p></td><td><p>
Returns the number of elements in the all_clients list.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>all_clients</em></span>
</span></p></td><td><p>
Returns a list of
<code class="function">XEventClasses</code>
that specify which events are
selected by all clients.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetSelectedExtensionEvents"><code class="function"> XGetSelectedExtensionEvents</code></a>
returns pointers to two event class arrays.
One lists the extension events selected by this client from
the specified window. The other lists the extension events selected by
all clients from the specified window. This information is analogous
to that returned in your_event_mask and all_event_masks of the
<code class="function">XWindowAttributes</code>
structure when an
<span class="olink"><code class="function">XGetWindowAttributes</code></span>
request is made.
To free the two arrays returned by this function, use
<span class="olink"><code class="function">XFree</code></span>.
</p><p>
<a class="xref" href="#XGetSelectedExtensionEvents"><code class="function"> XGetSelectedExtensionEvents</code></a>
can generate
<code class="function">BadWindow</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Controlling_Event_Propagation"></a>Controlling Event Propagation</h4></div></div></div><p>
Extension events propagate up the window hierarchy in the same manner
as core events. If a window is not interested in an extension event,
it usually propagates to the closest ancestor that is interested,
unless the dont_propagate list prohibits it.
Grabs of extension devices may alter the set of windows that receive a
particular extension event.
</p><p>
Client programs may control event propagation through the use
of the following two functions:
<a class="xref" href="#XChangeDeviceDontPropagateList"><code class="function"> XChangeDeviceDontPropagateList</code></a>
and
<code class="function">XGetDeviceDontPropagateList . </code>
</p><p>
</p><div class="funcsynopsis"><a id="XChangeDeviceDontPropagateList"></a><p><code class="funcdef">int <strong class="fsfunc"> XChangeDeviceDontPropagateList</strong>(</code>Display<var class="pdparam"> *display</var>, Window<var class="pdparam"> window</var>, int<var class="pdparam"> event_count</var>, XEventClass<var class="pdparam"> *events</var>, int<var class="pdparam"> mode</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>window</em></span>
</span></p></td><td><p>
Specifies the desired window.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_count</em></span>
</span></p></td><td><p>
Specifies the number of elements in the events list.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>events</em></span>
</span></p></td><td><p>
Specifies a pointer to the list of XEventClasses.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>mode</em></span>
</span></p></td><td><p>
Specifies the mode. You can pass
<code class="function">AddToList</code>
or
<code class="function">DeleteFromList .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XChangeDeviceDontPropagateList"><code class="function"> XChangeDeviceDontPropagateList</code></a>
adds an event to or deletes an event from the do_not_propagate list
of extension events for the specified window.
There is one list per window, and the list remains for the life of the window.
The list is not altered if a client that changed the list terminates.
</p><p>
Suppression of event propagation is not allowed for all events. If a
specified
<code class="function">XEventClass</code>
is invalid because suppression of that event is not allowed, a
<code class="function">BadClass</code>
error results.
</p><p>
<a class="xref" href="#XChangeDeviceDontPropagateList"><code class="function"> XChangeDeviceDontPropagateList</code></a>
can generate
<code class="function">BadClass ,</code>
<code class="function">BadMode ,</code>
and
<code class="function">BadWindow</code>
errors.
</p><p>
</p><div class="funcsynopsis"><a id="XGetDeviceDontPropagateList"></a><p><code class="funcdef">XEventClass * <strong class="fsfunc"> XGetDeviceDontPropagateList</strong>(</code>Display<var class="pdparam"> *display</var>, Window<var class="pdparam"> window</var>, int<var class="pdparam"> *event_count</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>window</em></span>
</span></p></td><td><p>
Specifies the desired window.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_count</em></span>
</span></p></td><td><p>
Returns the number of elements in the array returned by this function.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetDeviceDontPropagateList"><code class="function"> XGetDeviceDontPropagateList</code></a>
allows a client to determine the do_not_propagate list of extension events
for the specified window.
It returns an array of
<code class="function">XEventClass ,</code>
each
<code class="function">XEventClass</code>
representing a device/event type pair.
To free the data returned by this function, use
<span class="olink"><code class="function">XFree</code></span>.
</p><p>
<a class="xref" href="#XGetDeviceDontPropagateList"><code class="function"> XGetDeviceDontPropagateList</code></a>
can generate
<code class="function">BadWindow</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Sending_an_Event"></a>Sending an Event</h4></div></div></div><p>
To send an extension event to another client, use
<code class="function">XSendExtensionEvent .</code>
</p><div class="funcsynopsis"><a id="XSendExtensionEvent"></a><p><code class="funcdef">int <strong class="fsfunc"> XSendExtensionEvent</strong>(</code>Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, Window<var class="pdparam"> window</var>, Bool<var class="pdparam"> propagate</var>, int<var class="pdparam"> event_count</var>, XEventClass<var class="pdparam"> *event_list</var>, XEvent<var class="pdparam"> *event</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the device whose ID is recorded in the event.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>window</em></span>
</span></p></td><td><p>
Specifies the destination window ID. You can pass a window ID,
<code class="function">PointerWindow</code>
or
<code class="function">InputFocus .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>propagate</em></span>
</span></p></td><td><p>
Specifies a boolean value that is either
<code class="function">True</code>
or
<code class="function">False .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_count</em></span>
</span></p></td><td><p>
Specifies the number of elements in the event_list array.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event_list</em></span>
</span></p></td><td><p>
Specifies a pointer to an array of
<code class="function">XEventClass .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>event</em></span>
</span></p></td><td><p>
Specifies a pointer to the event that is to be sent.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XSendExtensionEvent"><code class="function"> XSendExtensionEvent</code></a>
identifies the destination window, determines which clients should receive
the specified event, and ignores any active grabs.
It requires a list of
<code class="function">XEventClass</code>
to be specified.
These are obtained by opening an input device with the
<a class="xref" href="#XOpenDevice"><code class="function"> XOpenDevice</code></a>
request.
</p><p>
<a class="xref" href="#XSendExtensionEvent"><code class="function"> XSendExtensionEvent</code></a>
uses the window argument to identify the destination window as follows:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
If you pass
<code class="function">PointerWindow ,</code>
the destination window is the window that contains the pointer.
</p></li><li class="listitem"><p>
If you pass
<code class="function">InputFocus</code>
and if the focus window contains the pointer,
the destination window is the window that contains the pointer.
If the focus window does not contain the pointer,
the destination window is the focus window.
</p></li></ul></div><p>
To determine which clients should receive the specified events,
<a class="xref" href="#XSendExtensionEvent"><code class="function"> XSendExtensionEvent</code></a>
uses the propagate argument as follows:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
If propagate is
<code class="function">False ,</code>
the event is sent to every client selecting
from the destination window
any of the events specified in the event_list array.
</p></li><li class="listitem"><p>
If propagate is
<code class="function">True </code>
and no clients have selected from the destination window
any of the events specified in the event_list array, the destination is
replaced with the closest ancestor of destination for which some client
has selected one of the specified events and for which no intervening
window has that event in its do_not_propagate mask.
If no such window exists,
or if the window is an ancestor of the focus window, and
<code class="function">InputFocus</code>
was originally specified as the destination,
the event is not sent to any clients. Otherwise, the event is reported to every
client selecting on the final destination any of the events specified
in event_list.
</p></li></ul></div><p>
The event in the
<code class="function">XEvent</code>
structure must be one of the events defined
by the input extension, so that the X server can correctly byte swap the
contents as necessary. The contents of the event are otherwise unaltered
and unchecked by the X server except to force send_event to
<code class="function">True</code>
in the forwarded event and to set the sequence number in the event correctly.
</p><p>
<a class="xref" href="#XSendExtensionEvent"><code class="function"> XSendExtensionEvent</code></a>
returns zero if the conversion-to-wire protocol failed;
otherwise, it returns nonzero.
</p><p>
<a class="xref" href="#XSendExtensionEvent"><code class="function"> XSendExtensionEvent</code></a>
can generate
<code class="function">BadClass ,</code>
<code class="function">BadDevice ,</code>
<code class="function">BadValue ,</code>
and
<code class="function">BadWindow</code>
errors.
</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="Getting_Motion_History"></a>Getting Motion History</h4></div></div></div><p>
</p><div class="funcsynopsis"><a id="XGetDeviceMotionEvents"></a><p><code class="funcdef">XDeviceTimeCoord * <strong class="fsfunc"> XGetDeviceMotionEvents</strong>(</code><var class="pdparam"> axis_count_return)</var>, Display<var class="pdparam"> *display</var>, XDevice<var class="pdparam"> *device</var>, Timestart,<var class="pdparam"> stop</var>, int<var class="pdparam"> *nevents_return</var>, int<var class="pdparam"> *mode_return</var>, int<var class="pdparam"> *axis_count_return</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>display</em></span>
</span></p></td><td><p>
Specifies the connection to the X server.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>device</em></span>
</span></p></td><td><p>
Specifies the desired device.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>start</em></span>
</span></p></td><td><p>
Specifies the start time.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>stop</em></span>
</span></p></td><td><p>
Specifies the stop time.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>nevents_return</em></span>
</span></p></td><td><p>
Returns the number of positions in the motion buffer returned
for this request.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>mode_return</em></span>
</span></p></td><td><p>
Returns the mode of the nevents information.
The mode will be one of the following:
<code class="function">Absolute</code>
or
<code class="function">Relative .</code>
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>axis_count_return</em></span>
</span></p></td><td><p>
Returns the number of axes reported in each of the positions returned.
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XGetDeviceMotionEvents"><code class="function"> XGetDeviceMotionEvents</code></a>
returns all positions in the device's motion history buffer
that fall between the specified start and stop times inclusive.
If the start time is in the future or is later than the stop time,
no positions are returned.
</p><p>
The return type for this function is an
<code class="function">XDeviceTimeCoord</code>
structure, which is defined as follows:
</p><p>
</p><pre class="literallayout">
typedef struct {
Time time;
unsigned int *data;
} XDeviceTimeCoord;
</pre><p>
</p><p>
The data member is a pointer to an array of data items.
Each item is of type int, and there is one data item
per axis of motion reported by the device.
The number of axes reported by the device is returned in the axis_count variable.
</p><p>
The value of the data items depends on the mode of the device.
The mode is returned in the mode variable. If the
mode is
<code class="function">Absolute ,</code>
the data items are the raw values generated by the device.
These may be scaled by the client program using the
maximum values that the device can generate for each axis of motion
that it reports. The maximum value for each axis is reported in
the max_val member of the
<code class="function">XAxisInfo</code>
structure, which is part of the information returned by the
<a class="xref" href="#XListInputDevices"><code class="function"> XListInputDevices</code></a>
request.
</p><p>
If the mode is
<code class="function">Relative ,</code>
the data items are the relative values generated by the device.
The client program must choose an initial
position for the device and maintain a current position by
accumulating these relative values.
</p><p>
Consecutive calls to
<a class="xref" href="#XGetDeviceMotionEvents"><code class="function"> XGetDeviceMotionEvents</code></a>
can return data of different modes, that is, if
some client program has changed the mode of the device via an
<a class="xref" href="#XSetDeviceMode"><code class="function"> XSetDeviceMode</code></a>
request.
</p><p>
<a class="xref" href="#XGetDeviceMotionEvents"><code class="function"> XGetDeviceMotionEvents</code></a>
can generate
<code class="function">BadDevice</code>
and
<code class="function">BadMatch</code>
errors.
</p><p>
To free the data returned by
<code class="function">XGetDeviceMotionEvents ,</code>
use
<code class="function">XFreeDeviceMotionEvents .</code>
</p><p>
</p><div class="funcsynopsis"><a id="XFreeDeviceMotionEvents"></a><p><code class="funcdef">void <strong class="fsfunc"> XFreeDeviceMotionEvents</strong>(</code>XDeviceTimeCoord<var class="pdparam"> *events</var><code>)</code>;</p></div><p>
</p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /><col /></colgroup><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>events</em></span>
</span></p></td><td><p>
Specifies the pointer to the
<code class="function">XDeviceTimeCoord</code>
array returned by a previous call to
<code class="function">XGetDeviceMotionEvents .</code>
</p></td></tr></tbody></table></div><p>
</p><p>
<a class="xref" href="#XFreeDeviceMotionEvents"><code class="function"> XFreeDeviceMotionEvents</code></a>
frees the specified array of motion information.
<code class="function">Appendix A</code>
</p><p>
The following information is contained in the <code class="function"><X11/extensions/XInput.h></code>
and <code class="function"><X11/extensions/XI.h></code> header files:
</p><pre class="literallayout">
/* Definitions used by the library and client */
#ifndef _XINPUT_H_
#define _XINPUT_H_
#ifndef _XLIB_H_
#include <X11/Xlib.h>
#endif
#ifndef _XI_H_
#include "XI.h"
#endif
#define _deviceKeyPress 0
#define _deviceKeyRelease 1
#define _deviceButtonPress 0
#define _deviceButtonRelease 1
#define _deviceMotionNotify 0
#define _deviceFocusIn 0
#define _deviceFocusOut 1
#define _proximityIn 0
#define _proximityOut 1
#define _deviceStateNotify 0
#define _deviceMappingNotify 1
#define _changeDeviceNotify 2
#define FindTypeAndClass(d, type, class, classid, offset) \
{ int i; XInputClassInfo *ip; \
type = 0; class = 0; \
for (i=0, ip= ((XDevice *) d)->classes; \
i< ((XDevice *) d)->num_classes; \
i++, ip++) \
if (ip->input_class == classid) \
{type = ip->event_type_base + offset; \
class = ((XDevice *) d)->device_id << 8 | type;}}
#define DeviceKeyPress(d, type, class) \
FindTypeAndClass(d, type, class, KeyClass, _deviceKeyPress)
#define DeviceKeyRelease(d, type, class) \
FindTypeAndClass(d, type, class, KeyClass, _deviceKeyRelease)
#define DeviceButtonPress(d, type, class) \
FindTypeAndClass(d, type, class, ButtonClass, _deviceButtonPress)
#define DeviceButtonRelease(d, type, class) \
FindTypeAndClass(d, type, class, ButtonClass, _deviceButtonRelease)
#define DeviceMotionNotify(d, type, class) \
FindTypeAndClass(d, type, class, ValuatorClass, _deviceMotionNotify)
#define DeviceFocusIn(d, type, class) \
FindTypeAndClass(d, type, class, FocusClass, _deviceFocusIn)
#define DeviceFocusOut(d, type, class) \
FindTypeAndClass(d, type, class, FocusClass, _deviceFocusOut)
#define ProximityIn(d, type, class) \
FindTypeAndClass(d, type, class, ProximityClass, _proximityIn)
#define ProximityOut(d, type, class) \
FindTypeAndClass(d, type, class, ProximityClass, _proximityOut)
#define DeviceStateNotify(d, type, class) \
FindTypeAndClass(d, type, class, OtherClass, _deviceStateNotify)
#define DeviceMappingNotify(d, type, class) \
FindTypeAndClass(d, type, class, OtherClass, _deviceMappingNotify)
#define ChangeDeviceNotify(d, type, class) \
FindTypeAndClass(d, type, class, OtherClass, _changeDeviceNotify)
#define DevicePointerMotionHint(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _devicePointerMotionHint;}
#define DeviceButton1Motion(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _deviceButton1Motion;}
#define DeviceButton2Motion(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _deviceButton2Motion;}
#define DeviceButton3Motion(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _deviceButton3Motion;}
#define DeviceButton4Motion(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _deviceButton4Motion;}
#define DeviceButton5Motion(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _deviceButton5Motion;}
#define DeviceButtonMotion(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _deviceButtonMotion;}
#define DeviceOwnerGrabButton(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _deviceOwnerGrabButton;}
#define DeviceButtonPressGrab(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _deviceButtonGrab;}
#define NoExtensionEvent(d, type, class) \
{ class = ((XDevice *) d)->device_id << 8 | _noExtensionEvent;}
#define BadDevice(dpy, error) _xibaddevice(dpy, &error)
#define BadClass(dpy, error) _xibadclass(dpy, &error)
#define BadEvent(dpy, error) _xibadevent(dpy, &error)
#define BadMode(dpy, error) _xibadmode(dpy, &error)
#define DeviceBusy(dpy, error) _xidevicebusy(dpy, &error)
/***************************************************************
*
* DeviceKey events. These events are sent by input devices that
* support input class Keys.
* The location of the X pointer is reported in the coordinate
* fields of the x,y and x_root,y_root fields.
*
*/
typedef struct
{
int type; /* of event */
unsigned long serial; /* # of last request processed */
Bool send_event; /* true if from SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* "event" window reported relative to */
XID deviceid;
Window root; /* root window event occured on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* x, y coordinates in event window */
int x_root; /* coordinates relative to root */
int y_root; /* coordinates relative to root */
unsigned int state; /* key or button mask */
unsigned int keycode; /* detail */
Bool same_screen; /* same screen flag */
unsigned int device_state; /* device key or button mask */
unsigned char axes_count;
unsigned char first_axis;
int axis_data[6];
} XDeviceKeyEvent;
typedef XDeviceKeyEvent XDeviceKeyPressedEvent;
typedef XDeviceKeyEvent XDeviceKeyReleasedEvent;
/*******************************************************************
*
* DeviceButton events. These events are sent by extension devices
* that support input class Buttons.
*
*/
typedef struct {
int type; /* of event */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* "event" window reported relative to */
XID deviceid;
Window root; /* root window that the event occured on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* x, y coordinates in event window */
int x_root; /* coordinates relative to root */
int y_root; /* coordinates relative to root */
unsigned int state; /* key or button mask */
unsigned int button; /* detail */
Bool same_screen; /* same screen flag */
unsigned int device_state; /* device key or button mask */
unsigned char axes_count;
unsigned char first_axis;
int axis_data[6];
} XDeviceButtonEvent;
typedef XDeviceButtonEvent XDeviceButtonPressedEvent;
typedef XDeviceButtonEvent XDeviceButtonReleasedEvent;
/*******************************************************************
*
* DeviceMotionNotify event. These events are sent by extension devices
* that support input class Valuators.
*
*/
typedef struct
{
int type; /* of event */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* "event" window reported relative to */
XID deviceid;
Window root; /* root window that the event occured on */
Window subwindow; /* child window */
Time time; /* milliseconds */
int x, y; /* x, y coordinates in event window */
int x_root; /* coordinates relative to root */
int y_root; /* coordinates relative to root */
unsigned int state; /* key or button mask */
char is_hint; /* detail */
Bool same_screen; /* same screen flag */
unsigned int device_state; /* device key or button mask */
unsigned char axes_count;
unsigned char first_axis;
int axis_data[6];
} XDeviceMotionEvent;
/*******************************************************************
*
* DeviceFocusChange events. These events are sent when the focus
* of an extension device that can be focused is changed.
*
*/
typedef struct
{
int type; /* of event */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* "event" window reported relative to */
XID deviceid;
int mode; /* NotifyNormal, NotifyGrab, NotifyUngrab */
int detail;
/*
* NotifyAncestor, NotifyVirtual, NotifyInferior,
* NotifyNonLinear,NotifyNonLinearVirtual, NotifyPointer,
* NotifyPointerRoot, NotifyDetailNone
*/
Time time;
} XDeviceFocusChangeEvent;
typedef XDeviceFocusChangeEvent XDeviceFocusInEvent;
typedef XDeviceFocusChangeEvent XDeviceFocusOutEvent;
/*******************************************************************
*
* ProximityNotify events. These events are sent by those absolute
* positioning devices that are capable of generating proximity information.
*
*/
typedef struct
{
int type; /* ProximityIn or ProximityOut */
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
XID deviceid;
Window root;
Window subwindow;
Time time;
int x, y;
int x_root, y_root;
unsigned int state;
Bool same_screen;
unsigned int device_state; /* device key or button mask */
unsigned char axes_count;
unsigned char first_axis;
int axis_data[6];
} XProximityNotifyEvent;
typedef XProximityNotifyEvent XProximityInEvent;
typedef XProximityNotifyEvent XProximityOutEvent;
/*******************************************************************
*
* DeviceStateNotify events are generated on EnterWindow and FocusIn
* for those clients who have selected DeviceState.
*
*/
typedef struct
{
unsigned char class;
unsigned char length;
} XInputClass;
typedef struct {
int type;
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window;
XID deviceid;
Time time;
int num_classes;
char data[64];
} XDeviceStateNotifyEvent;
typedef struct {
unsigned char class;
unsigned char length;
unsigned char num_valuators;
unsigned char mode;
int valuators[6];
} XValuatorStatus;
typedef struct {
unsigned char class;
unsigned char length;
short num_keys;
char keys[32];
} XKeyStatus;
typedef struct {
unsigned char class;
unsigned char length;
short num_buttons;
char buttons[32];
} XButtonStatus;
/*******************************************************************
*
* DeviceMappingNotify event. This event is sent when the key mapping,
* modifier mapping, or button mapping of an extension device is changed.
*
*/
typedef struct {
int type;
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* unused */
XID deviceid;
Time time;
int request; /* one of MappingModifier, MappingKeyboard,
MappingPointer */
int first_keycode;/* first keycode */
int count; /* defines range of change w. first_keycode*/
} XDeviceMappingEvent;
/*******************************************************************
*
* ChangeDeviceNotify event. This event is sent when an
* XChangeKeyboard or XChangePointer request is made.
*
*/
typedef struct {
int type;
unsigned long serial; /* # of last request processed by server */
Bool send_event; /* true if this came from a SendEvent request */
Display *display; /* Display the event was read from */
Window window; /* unused */
XID deviceid;
Time time;
int request; /* NewPointer or NewKeyboard */
} XChangeDeviceNotifyEvent;
/*******************************************************************
*
* Control structures for input devices that support input class
* Feedback. These are used by the XGetFeedbackControl and
* XChangeFeedbackControl functions.
*
*/
typedef struct {
XID class;
int length;
XID id;
} XFeedbackState;
typedef struct {
XID class;
int length;
XID id;
int click;
int percent;
int pitch;
int duration;
int led_mask;
int global_auto_repeat;
char auto_repeats[32];
} XKbdFeedbackState;
typedef struct {
XID class;
int length;
XID id;
int accelNum;
int accelDenom;
int threshold;
} XPtrFeedbackState;
typedef struct {
XID class;
int length;
XID id;
int resolution;
int minVal;
int maxVal;
} XIntegerFeedbackState;
typedef struct {
XID class;
int length;
XID id;
int max_symbols;
int num_syms_supported;
KeySym *syms_supported;
} XStringFeedbackState;
typedef struct {
XID class;
int length;
XID id;
int percent;
int pitch;
int duration;
} XBellFeedbackState;
typedef struct {
XID class;
int length;
XID id;
int led_values;
int led_mask;
} XLedFeedbackState;
typedef struct {
XID class;
int length;
XID id;
} XFeedbackControl;
typedef struct {
XID class;
int length;
XID id;
int accelNum;
int accelDenom;
int threshold;
} XPtrFeedbackControl;
typedef struct {
XID class;
int length;
XID id;
int click;
int percent;
int pitch;
int duration;
int led_mask;
int led_value;
int key;
int auto_repeat_mode;
} XKbdFeedbackControl;
typedef struct {
XID class;
int length;
XID id;
int num_keysyms;
KeySym *syms_to_display;
} XStringFeedbackControl;
typedef struct {
XID class;
int length;
XID id;
int int_to_display;
} XIntegerFeedbackControl;
typedef struct {
XID class;
int length;
XID id;
int percent;
int pitch;
int duration;
} XBellFeedbackControl;
typedef struct {
XID class;
int length;
XID id;
int led_mask;
int led_values;
} XLedFeedbackControl;
/*******************************************************************
*
* Device control structures.
*
*/
typedef struct {
XID control;
int length;
} XDeviceControl;
typedef struct {
XID control;
int length;
int first_valuator;
int num_valuators;
int *resolutions;
} XDeviceResolutionControl;
typedef struct {
XID control;
int length;
int num_valuators;
int *resolutions;
int *min_resolutions;
int *max_resolutions;
} XDeviceResolutionState;
/*******************************************************************
*
* An array of XDeviceList structures is returned by the
* XListInputDevices function. Each entry contains information
* about one input device. Among that information is an array of
* pointers to structures that describe the characteristics of
* the input device.
*
*/
typedef struct _XAnyClassinfo *XAnyClassPtr;
typedef struct _XAnyClassinfo {
XID class;
int length;
} XAnyClassInfo;
typedef struct _XDeviceInfo *XDeviceInfoPtr;
typedef struct _XDeviceInfo
{
XID id;
Atom type;
char *name;
int num_classes;
int use;
XAnyClassPtr inputclassinfo;
} XDeviceInfo;
typedef struct _XKeyInfo *XKeyInfoPtr;
typedef struct _XKeyInfo
{
XID class;
int length;
unsigned short min_keycode;
unsigned short max_keycode;
unsigned short num_keys;
} XKeyInfo;
typedef struct _XButtonInfo *XButtonInfoPtr;
typedef struct _XButtonInfo {
XID class;
int length;
short num_buttons;
} XButtonInfo;
typedef struct _XAxisInfo *XAxisInfoPtr;
typedef struct _XAxisInfo {
int resolution;
int min_value;
int max_value;
} XAxisInfo;
typedef struct _XValuatorInfo *XValuatorInfoPtr;
typedef struct _XValuatorInfo
{
XID class;
int length;
unsigned char num_axes;
unsigned char mode;
unsigned long motion_buffer;
XAxisInfoPtr axes;
} XValuatorInfo;
/*******************************************************************
*
* An XDevice structure is returned by the XOpenDevice function.
* It contains an array of pointers to XInputClassInfo structures.
* Each contains information about a class of input supported by the
* device, including a pointer to an array of data for each type of event
* the device reports.
*
*/
typedef struct {
unsigned char input_class;
unsigned char event_type_base;
} XInputClassInfo;
typedef struct {
XID device_id;
int num_classes;
XInputClassInfo *classes;
} XDevice;
/*******************************************************************
*
* The following structure is used to return information for the
* XGetSelectedExtensionEvents function.
*
*/
typedef struct {
XEventClass event_type;
XID device;
} XEventList;
/*******************************************************************
*
* The following structure is used to return motion history data from
* an input device that supports the input class Valuators.
* This information is returned by the XGetDeviceMotionEvents function.
*
*/
typedef struct {
Time time;
int *data;
} XDeviceTimeCoord;
/*******************************************************************
*
* Device state structure.
* This is returned by the XQueryDeviceState request.
*
*/
typedef struct {
XID device_id;
int num_classes;
XInputClass *data;
} XDeviceState;
/*******************************************************************
*
* Note that the mode field is a bitfield that reports the Proximity
* status of the device as well as the mode. The mode field should
* be OR'd with the mask DeviceMode and compared with the values
* Absolute and Relative to determine the mode, and should be OR'd
* with the mask ProximityState and compared with the values InProximity
* and OutOfProximity to determine the proximity state.
*
*/
typedef struct {
unsigned char class;
unsigned char length;
unsigned char num_valuators;
unsigned char mode;
int *valuators;
} XValuatorState;
typedef struct {
unsigned char class;
unsigned char length;
short num_keys;
char keys[32];
} XKeyState;
typedef struct {
unsigned char class;
unsigned char length;
short num_buttons;
char buttons[32];
} XButtonState;
/*******************************************************************
*
* Function definitions.
*
*/
_XFUNCPROTOBEGIN
extern int XChangeKeyboardDevice(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */
#endif
);
extern int XChangePointerDevice(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
int /* xaxis */,
int /* yaxis */
#endif
);
extern int XGrabDevice(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
Window /* grab_window */,
Bool /* ownerEvents */,
int /* event count */,
XEventClass* /* event_list */,
int /* this_device_mode */,
int /* other_devices_mode */,
Time /* time */
#endif
);
extern int XUngrabDevice(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
Time /* time */
#endif
);
extern int XGrabDeviceKey(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
unsigned int /* key */,
unsigned int /* modifiers */,
XDevice* /* modifier_device */,
Window /* grab_window */,
Bool /* owner_events */,
unsigned int /* event_count */,
XEventClass* /* event_list */,
int /* this_device_mode */,
int /* other_devices_mode */
#endif
);
extern int XUngrabDeviceKey(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
unsigned int /* key */,
unsigned int /* modifiers */,
XDevice* /* modifier_dev */,
Window /* grab_window */
#endif
);
extern int XGrabDeviceButton(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
unsigned int /* button */,
unsigned int /* modifiers */,
XDevice* /* modifier_device */,
Window /* grab_window */,
Bool /* owner_events */,
unsigned int /* event_count */,
XEventClass* /* event_list */,
int /* this_device_mode */,
int /* other_devices_mode */
#endif
);
extern int XUngrabDeviceButton(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
unsigned int /* button */,
unsigned int /* modifiers */,
XDevice* /* modifier_dev */,
Window /* grab_window */
#endif
);
extern int XAllowDeviceEvents(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
int /* event_mode */,
Time /* time */
#endif
);
extern int XGetDeviceFocus(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
Window* /* focus */,
int* /* revert_to */,
Time* /* time */
#endif
);
extern int XSetDeviceFocus(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
Window /* focus */,
int /* revert_to */,
Time /* time */
#endif
);
extern XFeedbackState *XGetFeedbackControl(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
int* /* num_feedbacks */
#endif
);
extern int XFreeFeedbackList(
#if NeedFunctionPrototypes
XFeedbackState* /* list */
#endif
);
extern int XChangeFeedbackControl(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
unsigned long /* mask */,
XFeedbackControl* /* f */
#endif
);
extern int XDeviceBell(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
XID /* feedbackclass */,
XID /* feedbackid */,
int /* percent */
#endif
);
extern KeySym *XGetDeviceKeyMapping(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
#if NeedWidePrototypes
unsigned int /* first */,
#else
KeyCode /* first */,
#endif
int /* keycount */,
int* /* syms_per_code */
#endif
);
extern int XChangeDeviceKeyMapping(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
int /* first */,
int /* syms_per_code */,
KeySym* /* keysyms */,
int /* count */
#endif
);
extern XModifierKeymap *XGetDeviceModifierMapping(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */
#endif
);
extern int XSetDeviceModifierMapping(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
XModifierKeymap* /* modmap */
#endif
);
extern int XSetDeviceButtonMapping(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
unsigned char* /* map[] */,
int /* nmap */
#endif
);
extern int XGetDeviceButtonMapping(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
unsigned char* /* map[] */,
unsigned int /* nmap */
#endif
);
extern XDeviceState *XQueryDeviceState(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */
#endif
);
extern int XFreeDeviceState(
#if NeedFunctionPrototypes
XDeviceState* /* list */
#endif
);
extern XExtensionVersion *XGetExtensionVersion(
#if NeedFunctionPrototypes
Display* /* display */,
_Xconst char* /* name */
#endif
);
extern XDeviceInfo *XListInputDevices(
#if NeedFunctionPrototypes
Display* /* display */,
int* /* ndevices */
#endif
);
extern int XFreeDeviceList(
#if NeedFunctionPrototypes
XDeviceInfo* /* list */
#endif
);
extern XDevice *XOpenDevice(
#if NeedFunctionPrototypes
Display* /* display */,
XID /* id */
#endif
);
extern int XCloseDevice(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */
#endif
);
extern int XSetDeviceMode(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
int /* mode */
#endif
);
extern int XSetDeviceValuators(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
int* /* valuators */,
int /* first_valuator */,
int /* num_valuators */
#endif
);
extern XDeviceControl *XGetDeviceControl(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
int /* control */
#endif
);
extern int XChangeDeviceControl(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
int /* control */,
XDeviceControl* /* d */
#endif
);
extern int XSelectExtensionEvent(
#if NeedFunctionPrototypes
Display* /* display */,
Window /* w */,
XEventClass* /* event_list */,
int /* count */
#endif
);
extern int XGetSelectedExtensionEvents(
#if NeedFunctionPrototypes
Display* /* display */,
Window /* w */,
int* /* this_client_count */,
XEventClass** /* this_client_list */,
int* /* all_clients_count */,
XEventClass** /* all_clients_list */
#endif
);
extern int XChangeDeviceDontPropagateList(
#if NeedFunctionPrototypes
Display* /* display */,
Window /* window */,
int /* count */,
XEventClass* /* events */,
int /* mode */
#endif
);
extern XEventClass *XGetDeviceDontPropagateList(
#if NeedFunctionPrototypes
Display* /* display */,
Window /* window */,
int* /* count */
#endif
);
extern Status XSendExtensionEvent(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
Window /* dest */,
Bool /* prop */,
int /* count */,
XEventClass* /* list */,
XEvent* /* event */
#endif
);
extern XDeviceTimeCoord *XGetDeviceMotionEvents(
#if NeedFunctionPrototypes
Display* /* display */,
XDevice* /* device */,
Time /* start */,
Time /* stop */,
int* /* nEvents */,
int* /* mode */,
int* /* axis_count */
#endif
);
extern int XFreeDeviceMotionEvents(
#if NeedFunctionPrototypes
XDeviceTimeCoord* /* events */
#endif
);
extern int XFreeDeviceControl(
#if NeedFunctionPrototypes
XDeviceControl* /* control */
#endif
);
_XFUNCPROTOEND
#endif /* _XINPUT_H_ */
/* Definitions used by the server, library and client */
#ifndef _XI_H_
#define _XI_H_
#define sz_xGetExtensionVersionReq 8
#define sz_xGetExtensionVersionReply 32
#define sz_xListInputDevicesReq 4
#define sz_xListInputDevicesReply 32
#define sz_xOpenDeviceReq 8
#define sz_xOpenDeviceReply 32
#define sz_xCloseDeviceReq 8
#define sz_xSetDeviceModeReq 8
#define sz_xSetDeviceModeReply 32
#define sz_xSelectExtensionEventReq 12
#define sz_xGetSelectedExtensionEventsReq 8
#define sz_xGetSelectedExtensionEventsReply 32
#define sz_xChangeDeviceDontPropagateListReq 12
#define sz_xGetDeviceDontPropagateListReq 8
#define sz_xGetDeviceDontPropagateListReply 32
#define sz_xGetDeviceMotionEventsReq 16
#define sz_xGetDeviceMotionEventsReply 32
#define sz_xChangeKeyboardDeviceReq 8
#define sz_xChangeKeyboardDeviceReply 32
#define sz_xChangePointerDeviceReq 8
#define sz_xChangePointerDeviceReply 32
#define sz_xGrabDeviceReq 20
#define sz_xGrabDeviceReply 32
#define sz_xUngrabDeviceReq 12
#define sz_xGrabDeviceKeyReq 20
#define sz_xGrabDeviceKeyReply 32
#define sz_xUngrabDeviceKeyReq 16
#define sz_xGrabDeviceButtonReq 20
#define sz_xGrabDeviceButtonReply 32
#define sz_xUngrabDeviceButtonReq 16
#define sz_xAllowDeviceEventsReq 12
#define sz_xGetDeviceFocusReq 8
#define sz_xGetDeviceFocusReply 32
#define sz_xSetDeviceFocusReq 16
#define sz_xGetFeedbackControlReq 8
#define sz_xGetFeedbackControlReply 32
#define sz_xChangeFeedbackControlReq 12
#define sz_xGetDeviceKeyMappingReq 8
#define sz_xGetDeviceKeyMappingReply 32
#define sz_xChangeDeviceKeyMappingReq 8
#define sz_xGetDeviceModifierMappingReq 8
#define sz_xSetDeviceModifierMappingReq 8
#define sz_xSetDeviceModifierMappingReply 32
#define sz_xGetDeviceButtonMappingReq 8
#define sz_xGetDeviceButtonMappingReply 32
#define sz_xSetDeviceButtonMappingReq 8
#define sz_xSetDeviceButtonMappingReply 32
#define sz_xQueryDeviceStateReq 8
#define sz_xQueryDeviceStateReply 32
#define sz_xSendExtensionEventReq 16
#define sz_xDeviceBellReq 8
#define sz_xSetDeviceValuatorsReq 8
#define sz_xSetDeviceValuatorsReply 32
#define sz_xGetDeviceControlReq 8
#define sz_xGetDeviceControlReply 32
#define sz_xChangeDeviceControlReq 8
#define sz_xChangeDeviceControlReply 32
#define INAME "XInputExtension"
#define XI_KEYBOARD "KEYBOARD"
#define XI_MOUSE "MOUSE"
#define XI_TABLET "TABLET"
#define XI_TOUCHSCREEN "TOUCHSCREEN"
#define XI_TOUCHPAD "TOUCHPAD"
#define XI_BARCODE "BARCODE"
#define XI_BUTTONBOX "BUTTONBOX"
#define XI_KNOB_BOX "KNOB_BOX"
#define XI_ONE_KNOB "ONE_KNOB"
#define XI_NINE_KNOB "NINE_KNOB"
#define XI_TRACKBALL "TRACKBALL"
#define XI_QUADRATURE "QUADRATURE"
#define XI_ID_MODULE "ID_MODULE"
#define XI_SPACEBALL "SPACEBALL"
#define XI_DATAGLOVE "DATAGLOVE"
#define XI_EYETRACKER "EYETRACKER"
#define XI_CURSORKEYS "CURSORKEYS"
#define XI_FOOTMOUSE "FOOTMOUSE"
#define Dont_Check 0
#define XInput_Initial_Release 1
#define XInput_Add_XDeviceBell 2
#define XInput_Add_XSetDeviceValuators 3
#define XInput_Add_XChangeDeviceControl 4
#define XI_Absent 0
#define XI_Present 1
#define XI_Initial_Release_Major 1
#define XI_Initial_Release_Minor 0
#define XI_Add_XDeviceBell_Major 1
#define XI_Add_XDeviceBell_Minor 1
#define XI_Add_XSetDeviceValuators_Major 1
#define XI_Add_XSetDeviceValuators_Minor 2
#define XI_Add_XChangeDeviceControl_Major 1
#define XI_Add_XChangeDeviceControl_Minor 3
#define DEVICE_RESOLUTION 1
#define NoSuchExtension 1
#define COUNT 0
#define CREATE 1
#define NewPointer 0
#define NewKeyboard 1
#define XPOINTER 0
#define XKEYBOARD 1
#define UseXKeyboard 0xFF
#define IsXPointer 0
#define IsXKeyboard 1
#define IsXExtensionDevice 2
#define AsyncThisDevice 0
#define SyncThisDevice 1
#define ReplayThisDevice 2
#define AsyncOtherDevices 3
#define AsyncAll 4
#define SyncAll 5
#define FollowKeyboard 3
#define RevertToFollowKeyboard 3
#define DvAccelNum (1L << 0)
#define DvAccelDenom (1L << 1)
#define DvThreshold (1L << 2)
#define DvKeyClickPercent (1L<<0)
#define DvPercent (1L<<1)
#define DvPitch (1L<<2)
#define DvDuration (1L<<3)
#define DvLed (1L<<4)
#define DvLedMode (1L<<5)
#define DvKey (1L<<6)
#define DvAutoRepeatMode (1L<<7)
#define DvString (1L << 0)
#define DvInteger (1L << 0)
#define DeviceMode (1L << 0)
#define Relative 0
#define Absolute 1
#define ProximityState (1L << 1)
#define InProximity (0L << 1)
#define OutOfProximity (1L << 1)
#define AddToList 0
#define DeleteFromList 1
#define KeyClass 0
#define ButtonClass 1
#define ValuatorClass 2
#define FeedbackClass 3
#define ProximityClass 4
#define FocusClass 5
#define OtherClass 6
#define KbdFeedbackClass 0
#define PtrFeedbackClass 1
#define StringFeedbackClass 2
#define IntegerFeedbackClass 3
#define LedFeedbackClass 4
#define BellFeedbackClass 5
#define _devicePointerMotionHint 0
#define _deviceButton1Motion 1
#define _deviceButton2Motion 2
#define _deviceButton3Motion 3
#define _deviceButton4Motion 4
#define _deviceButton5Motion 5
#define _deviceButtonMotion 6
#define _deviceButtonGrab 7
#define _deviceOwnerGrabButton 8
#define _noExtensionEvent 9
#define XI_BadDevice 0
#define XI_BadEvent 1
#define XI_BadMode 2
#define XI_DeviceBusy 3
#define XI_BadClass 4
typedef unsigned long XEventClass;
/*******************************************************************
*
* Extension version structure.
*
*/
typedef struct {
int present;
short major_version;
short minor_version;
} XExtensionVersion;
#endif /* _XI_H_ */
</pre><p>
</p></div></div></div></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="Input_Extension_Protocol_Encoding"></a>Appendix A. Input Extension Protocol Encoding</h1></div></div></div><p>
<code class="function">Syntactic Conventions</code>
</p><p>
All numbers are in decimal,
unless prefixed with #x, in which case they are in hexadecimal (base 16).
</p><p>
The general syntax used to describe requests, replies, errors, events, and
compound types is:
</p><p>
</p><pre class="literallayout">
<code class="function">NameofThing</code>
encode-form
...
encode-form
</pre><p>
Each encode-form describes a single component.
</p><p>
For components described in the protocol as:
</p><p>
</p><pre class="literallayout">
name: TYPE
</pre><p>
the encode-form is:
</p><p>
</p><pre class="literallayout">
N TYPE name
</pre><p>
N is the number of bytes occupied in the data stream,
and TYPE is the interpretation of those bytes.
For example,
</p><p>
</p><pre class="literallayout">
depth: CARD8
</pre><p>
becomes:
</p><p>
</p><pre class="literallayout">
1 CARD8 depth
</pre><p>
For components with a static numeric value the encode-form is:
</p><p>
</p><pre class="literallayout">
N value name
</pre><p>
The value is always interpreted as an N-byte unsigned integer.
For example,
the first two bytes of a Window error are always zero (indicating an
error in general) and three (indicating the Window error in particular):
</p><p>
</p><pre class="literallayout">
1 0 Error
1 3 code
</pre><p>
For components described in the protocol as:
</p><p>
</p><pre class="literallayout">
name: <code class="function">{Name1, ..., NameI}</code>
</pre><p>
</p><p>
the encode-form is:
</p><p>
</p><pre class="literallayout">
N name
value1 Name1
...
valueI NameI
</pre><p>
The value is always interpreted as an N-byte unsigned integer.
Note that the size of N is sometimes larger than that strictly required
to encode the values.
For example:
</p><p>
</p><pre class="literallayout">
class: <code class="function">{InputOutput, InputOnly, CopyFromParent}</code>
</pre><p>
</p><p>
becomes:
</p><p>
</p><pre class="literallayout">
2 class
0 CopyFromParent
1 InputOutput
2 InputOnly
</pre><p>
For components described in the protocol as:
</p><p>
</p><pre class="literallayout">
NAME: TYPE or <code class="function">Alternative1 ... or AlternativeI</code>
</pre><p>
</p><p>
the encode-form is:
</p><p>
</p><pre class="literallayout">
N TYPE NAME
value1 Alternative1
...
valueI AlternativeI
</pre><p>
The alternative values are guaranteed not to conflict with the encoding
of TYPE.
For example:
</p><p>
</p><pre class="literallayout">
destination: WINDOW or <code class="function">PointerWindow</code> or <code class="function">InputFocus</code>
</pre><p>
</p><p>
becomes:
</p><p>
</p><pre class="literallayout">
4 WINDOW destination
0 PointerWindow
1 InputFocus
</pre><p>
For components described in the protocol as:
</p><p>
</p><pre class="literallayout">
value-mask: BITMASK
</pre><p>
the encode-form is:
</p><p>
</p><pre class="literallayout">
N BITMASK value-mask
mask1 mask-name1
...
maskI mask-nameI
</pre><p>
The individual bits in the mask are specified and named,
and N is 2 or 4.
The most-significant bit in a BITMASK is reserved for use in defining
chained (multiword) bitmasks, as extensions augment existing core requests.
The precise interpretation of this bit is not yet defined here,
although a probable mechanism is that a 1-bit indicates that another N bytes
of bitmask follows, with bits within the overall mask still interpreted
from least-significant to most-significant with an N-byte unit, with N-byte units
interpreted in stream order, and with the overall mask being byte-swapped
in individual N-byte units.
</p><p>
For LISTofVALUE encodings, the request is followed by a section of the form:
</p><p>
</p><pre class="literallayout">
VALUEs
encode-form
...
encode-form
</pre><p>
listing an encode-form for each VALUE.
The NAME in each encode-form keys to the corresponding BITMASK bit.
The encoding of a VALUE always occupies four bytes,
but the number of bytes specified in the encoding-form indicates how
many of the least-significant bytes are actually used;
the remaining bytes are unused and their values do not matter.
</p><p>
In various cases, the number of bytes occupied by a component will be specified
by a lowercase single-letter variable name instead of a specific numeric
value, and often some other component will have its value specified as a
simple numeric expression involving these variables.
Components specified with such expressions are always interpreted
as unsigned integers.
The scope of such variables is always just the enclosing request, reply,
error, event, or compound type structure.
For example:
</p><p>
</p><pre class="literallayout">
2 3+n request length
4n LISTofPOINT points
</pre><p>
For unused bytes (the values of the bytes are undefined and do not matter),
the encode-form is:
</p><p>
</p><pre class="literallayout">
N unused
</pre><p>
If the number of unused bytes is variable, the encode-form typically is:
</p><p>
</p><pre class="literallayout">
p unused, p=pad(E)
</pre><p>
where E is some expression,
and pad(E) is the number of bytes needed to round E up to a multiple of four.
</p><p>
</p><pre class="literallayout">
pad(E) = (4 - (E mod 4)) mod 4
</pre><p>
<code class="function">Common Types</code>
</p><p>
LISTofFOO
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
In this document the LISTof notation strictly means some number of repetitions
of the FOO encoding;
the actual length of the list is encoded elsewhere.
</p></li></ul></div><p>
SETofFOO
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
A set is always represented by a bitmask, with a 1-bit indicating presence in
the set.
</p></li></ul></div><p>
BITMASK: CARD32
</p><p>
WINDOW: CARD32
</p><p>
BYTE: 8-bit value
</p><p>
INT8: 8-bit signed integer
</p><p>
INT16: 16-bit signed integer
</p><p>
INT32: 32-bit signed integer
</p><p>
CARD8: 8-bit unsigned integer
</p><p>
CARD16: 16-bit unsigned integer
</p><p>
CARD32: 32-bit unsigned integer
</p><p>
TIMESTAMP: CARD32
</p><p>
EVENTCLASS: CARD32
</p><p>
</p><pre class="literallayout">
INPUTCLASS
0 KeyClass
1 ButtonClass
2 ValuatorClass
3 FeedbackClass
4 ProximityClass
5 FocusClass
6 OtherClass
</pre><p>
</p><p>
</p><pre class="literallayout">
INPUTCLASS
0 KbdFeedbackClass
1 PtrFeedbackClass
2 StringFeedbackClass
3 IntegerFeedbackClass
4 LedFeedbackClass
5 BellFeedbackClass
</pre><p>
</p><p>
</p><pre class="literallayout">
INPUTINFO
0 KEYINFO
1 BUTTONINFO
2 VALUATORINFO
</pre><p>
</p><p>
</p><pre class="literallayout">
DEVICEMODE
0 Relative
1 Absolute
</pre><p>
</p><p>
</p><pre class="literallayout">
PROXIMITYSTATE
0 InProximity
1 OutOfProximity
</pre><p>
</p><p>
</p><pre class="literallayout">
BOOL
0 False
1 True
</pre><p>
</p><p>
KEYSYM: CARD32
</p><p>
KEYCODE: CARD8
</p><p>
BUTTON: CARD8
</p><p>
</p><pre class="literallayout">
SETofKEYBUTMASK
#x0001 Shift
#x0002 Lock
#x0004 Control
#x0008 Mod1
#x0010 Mod2
#x0020 Mod3
#x0040 Mod4
#x0080 Mod5
#x0100 Button1
#x0200 Button2
#x0400 Button3
#x0800 Button4
#x1000 Button5
#xe000 unused but must be zero
</pre><p>
</p><p>
</p><pre class="literallayout">
SETofKEYMASK
encodings are the same as for SETofKEYBUTMASK, except with
#xff00 unused but must be zero
</pre><p>
</p><p>
STRING8: LISTofCARD8
</p><p>
</p><pre class="literallayout">
STR
1 n length of name in bytes
n STRING8 name
</pre><p>
<code class="function">Errors</code>
</p><p>
</p><pre class="literallayout">
Request
1 0 Error
1 1 code
2 CARD16 sequence number
4 unused
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Value
1 0 Error
1 2 code
2 CARD16 sequence number
4 <32-bits> bad value
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Window
1 0 Error
1 3 code
2 CARD16 sequence number
4 CARD32 bad resource id
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Match
1 0 Error
1 8 code
2 CARD16 sequence number
4 unused
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Access
1 0 Error
1 10 code
2 CARD16 sequence number
4 unused
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Alloc
1 0 Error
1 11 code
2 CARD16 sequence number
4 unused
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Name
1 0 Error
1 15 code
2 CARD16 sequence number
4 unused
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Device
1 0 Error
1 CARD8 code
2 CARD16 sequence number
4 unused
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Event
1 0 Error
1 CARD8 code
2 CARD16 sequence number
4 unused
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Mode
1 0 Error
1 CARD8 code
2 CARD16 sequence number
4 unused
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
Class
1 0 Error
1 CARD8 code
2 CARD16 sequence number
4 unused
2 CARD16 minor opcode
1 CARD8 major opcode
21 unused
</pre><p>
Keyboards
</p><p>
KEYCODE values are always greater than 7 (and less than 256).
</p><p>
KEYSYM values with the bit #x10000000 set are reserved as vendor-specific.
</p><p>
The names and encodings of the standard KEYSYM values are contained in
appendix F.
</p><p>
Pointers
</p><p>
BUTTON values are numbered starting with one.
</p><p>
Requests
</p><p>
</p><pre class="literallayout">
GetExtensionVersion
1 CARD8 input extension opcode
1 1 GetExtensionVersion opcode
2 2+(n+p)/4 request length
2 n length of name
2 unused
n STRING8 name
p unused, p=pad(n)
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 1 GetExtensionVersion opcode
2 CARD16 sequence number
4 0 reply length
2 CARD16 major version
2 CARD16 minor version
1 BOOL present
19 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
ListInputDevices
1 CARD8 input extension opcode
1 2 ListInputDevices opcode
2 1 request length
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 2 ListInputDevices opcode
2 CARD16 sequence number
4 (n+p)/4 reply length
1 CARD8 number of input devices
23 unused
n LISTofDEVICEINFO info for each input device
p unused, p=pad(n)
</pre><p>
</p><p>
</p><pre class="literallayout">
DEVICEINFO
4 CARD32 device type
1 CARD8 device id
1 CARD8 number of input classes this device reports
1 CARD8 device use
0 IsXPointer
1 IsXKeyboard
2 IsXExtensionDevice
1 unused
n LISTofINPUTINFO input info for each input class
m STR name
p unused, p=pad(m)
</pre><p>
</p><p>
</p><pre class="literallayout">
INPUTINFO KEYINFO or BUTTONINFO or VALUATORINFO
</pre><p>
</p><p>
</p><pre class="literallayout">
KEYINFO
1 0 class id
1 8 length
1 KEYCODE minimum keycode
1 KEYCODE maximum keycode
2 CARD16 number of keys
2 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
BUTTONINFO
1 1 class id
1 4 length
2 CARD16 number of buttons
</pre><p>
</p><p>
</p><pre class="literallayout">
VALUATORINFO
1 2 class id
1 8+12n length
1 n number of axes
1 SETofDEVICEMODE mode
4 CARD32 size of motion buffer
12n LISTofAXISINFO valuator limits
</pre><p>
</p><p>
</p><pre class="literallayout">
AXISINFO
4 CARD32 resolution
4 CARD32 minimum value
4 CARD32 maximum value
</pre><p>
</p><p>
</p><pre class="literallayout">
OpenDevice
1 CARD8 input extension opcode
1 3 OpenDevice opcode
2 2 request length
1 CARD8 device id
3 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 3 OpenDevice opcode
2 CARD16 sequence number
4 (n+p)/4 reply length
1 CARD8 number of input classes
23 unused
n LISTofINPUTCLASSINFO input class information
p unused, p=pad(n)
</pre><p>
</p><p>
</p><pre class="literallayout">
INPUTCLASSINFO
1 CARD8 input class id
0 KEY
1 BUTTON
2 VALUATOR
3 FEEDBACK
4 PROXIMITY
5 FOCUS
6 OTHER
1 CARD8 event type base code for this class
</pre><p>
</p><p>
</p><pre class="literallayout">
CloseDevice
1 CARD8 input extension opcode
1 4 CloseDevice opcode
2 2 request length
1 CARD8 device id
3 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
SetDeviceMode
1 CARD8 input extension opcode
1 5 SetDeviceMode opcode
2 2 request length
1 CARD8 device id
1 CARD8 mode
2 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 5 SetDeviceMode opcode
2 CARD16 sequence number
4 0 reply length
1 CARD8 status
0 Success
1 AlreadyGrabbed
3 + first_error DeviceBusy
23 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
SelectExtensionEvent
1 CARD8 input extension opcode
1 6 SelectExtensionEvent opcode
2 3+n request length
4 Window event window
2 CARD16 count
2 unused
4n LISTofEVENTCLASS desired events
</pre><p>
</p><p>
</p><pre class="literallayout">
GetSelectedExtensionEvents
1 CARD8 input extension opcode
1 7 GetSelectedExtensionEvents opcode
2 2 request length
4 Window event window
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 7 GetSelecteExtensionEvents opcode
2 CARD16 sequence number
4 n + m reply length
2 n this client count
2 m all clients count
20 unused
4n LISTofEVENTCLASS this client list
4m LISTofEVENTCLASS all clients list
</pre><p>
</p><p>
</p><pre class="literallayout">
ChangeDeviceDontPropagateList
1 CARD8 input extension opcode
1 8 ChangeDeviceDontPropagateList opcode
2 3+n request length
4 Window event window
2 n count of events
1 mode
0 AddToList
1 DeleteFromList
1 unused
4n LISTofEVENTCLASS desired events
</pre><p>
</p><p>
</p><pre class="literallayout">
GetDeviceDontPropagateList
1 CARD8 input extension opcode
1 9 GetDeviceDontPropagateList opcode
2 2 request length
4 Window event window
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 9 GetDeviceDontPropagateList opcode
2 CARD16 sequence number
4 n reply length
2 n count of events
22 unused
4n LISTofEVENTCLASS don't propagate list
</pre><p>
</p><p>
</p><pre class="literallayout">
GetDeviceMotionEvents
1 CARD8 input extension opcode
1 10 GetDeviceMotionEvents opcode
2 4 request length
4 TIMESTAMP start
0 CurrentTime
4 TIMESTAMP stop
0 CurrentTime
1 CARD8 device id
3 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 10 GetDeviceMotionEvents opcode
2 CARD16 sequence number
4 (m+1)n reply length
4 n number of DEVICETIMECOORDs in events
1 m number of valuators per event
1 CARD8 mode of the device
0 Absolute
1 Relative
18 unused
(4m+4)n LISTofDEVICETIMECOORD events
</pre><p>
</p><p>
</p><pre class="literallayout">
DEVICETIMECOORD
4 TIMESTAMP time
4m LISTofINT32 valuators
</pre><p>
</p><p>
</p><pre class="literallayout">
ChangeKeyboardDevice
1 CARD8 input extension opcode
1 11 ChangeKeyboardDevice opcode
2 2 request length
1 CARD8 device id
3 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 11 ChangeKeyboardDevice opcode
2 CARD16 sequence number
4 0 reply length
1 status
0 Success
1 AlreadyGrabbed
2 DeviceFrozen
23 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
ChangePointerDevice
1 CARD8 input extension opcode
1 12 ChangePointerDevice opcode
2 2 request length
1 CARD8 x-axis
1 CARD8 y-axis
1 CARD8 device id
1 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 12 ChangePointerDevice opcode
2 CARD16 sequence number
4 0 reply length
1 status
0 Success
1 AlreadyGrabbed
2 DeviceFrozen
23 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
GrabDevice
1 CARD8 input extension opcode
1 13 GrabDevice opcode
2 5+n request length
4 WINDOW grab-window
4 TIMESTAMP time
0 CurrentTime
2 n count of events
1 this-device-mode
0 Synchronous
1 Asynchronous
1 other-devices-mode
0 Synchronous
1 Asynchronous
1 BOOL owner-events
1 CARD8 device id
2 unused
4n LISTofEVENTCLASS event list
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 13 GrabDevice opcode
2 CARD16 sequence number
4 0 reply length
1 status
0 Success
1 AlreadyGrabbed
2 InvalidTime
3 NotViewable
4 Frozen
23 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
UngrabDevice
1 CARD8 input extension opcode
1 14 UngrabDevice opcode
2 3 request length
4 TIMESTAMP time
0 CurrentTime
1 CARD8 device id
3 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
GrabDeviceKey
1 CARD8 input extension opcode
1 15 GrabDeviceKey opcode
2 5+n request length
4 WINDOW grab-window
2 n count of events
2 SETofKEYMASK modifiers
#x8000 AnyModifier
1 CARD8 modifier device
#x0FF UseXKeyboard
1 CARD8 grabbed device
1 KEYCODE key
0 AnyKey
1 this-device-mode
0 Synchronous
1 Asynchronous
1 other-devices-mode
0 Synchronous
1 Asynchronous
1 BOOL owner-events
2 unused
4n LISTofEVENTCLASS event list
</pre><p>
</p><p>
</p><pre class="literallayout">
UngrabDeviceKey
1 CARD8 input extension opcode
1 16 UngrabDeviceKey opcode
2 4 request length
4 WINDOW grab-window
2 SETofKEYMASK modifiers
#x8000 AnyModifier
1 CARD8 modifier device
#x0FF UseXKeyboard
1 KEYCODE key
0 AnyKey
1 CARD8 grabbed device
3 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
GrabDeviceButton
1 CARD8 input extension opcode
1 17 GrabDeviceButton opcode
2 5+n request length
4 WINDOW grab-window
1 CARD8 grabbed device
1 CARD8 modifier device
#x0FF UseXKeyboard
2 n count of desired events
2 SETofKEYMASK modifiers
1 this-device-mode
0 Synchronous
1 Asynchronous
1 other-device-mode
0 Synchronous
1 Asynchronous
1 BUTTON button
0 AnyButton
1 BOOL owner-events
#x8000 AnyModifier
2 unused
4n LISTofEVENTCLASS event list
</pre><p>
</p><p>
</p><pre class="literallayout">
UngrabDeviceButton
1 CARD8 input extension opcode
1 18 UngrabDeviceButton opcode
2 4 request length
4 WINDOW grab-window
2 SETofKEYMASK modifiers
#x8000 AnyModifier
1 CARD8 modifier device
#x0FF UseXKeyboard
1 BUTTON button
0 AnyButton
1 CARD8 grabbed device
3 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
AllowDeviceEvents
1 CARD8 input extension opcode
1 19 AllowDeviceEvents opcode
2 3 request length
4 TIMESTAMP time
0 CurrentTime
1 mode
0 AsyncThisDevice
1 SyncThisDevice
2 ReplayThisDevice
3 AsyncOtherDevices
4 AsyncAll
5 SyncAll
1 CARD8 device id
2 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
GetDeviceFocus
1 CARD8 input extension opcode
1 20 GetDeviceFocus opcode
2 2 request length
1 CARD8 device
3 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 20 GetDeviceFocus opcode
2 CARD16 sequence number
4 0 reply length
4 WINDOW focus
0 None
1 PointerRoot
3 FollowKeyboard
4 TIMESTAMP focus time
1 revert-to
0 None
1 PointerRoot
2 Parent
3 FollowKeyboard
15 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
SetDeviceFocus
1 CARD8 input extension opcode
1 21 SetDeviceFocus opcode
2 4 request length
4 WINDOW focus
0 None
1 PointerRoot
3 FollowKeyboard
4 TIMESTAMP time
0 CurrentTime
1 revert-to
0 None
1 PointerRoot
2 Parent
3 FollowKeyboard
1 CARD8 device
2 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
GetFeedbackControl
1 CARD8 input extension opcode
1 22 GetFeedbackControl opcode
2 2 request length
1 CARD8 device id
3 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 22 GetFeedbackControl opcode
2 CARD16 sequence number
4 m/4 reply length
2 n number of feedbacks supported
22 unused
m LISTofFEEDBACKSTATE feedbacks
</pre><p>
</p><p>
</p><pre class="literallayout">
FEEDBACKSTATE KBDFEEDBACKSTATE, PTRFEEDBACKSTATE, INTEGERFEEDBACKSTATE,
STRINGFEEDBACKSTATE, BELLFEEDBACKSTATE, or LEDFEEDBACKSTATE
</pre><p>
</p><p>
</p><pre class="literallayout">
KBDFEEDBACKSTATE
1 0 feedback class id
1 CARD8 id of this feedback
2 20 length
2 CARD16 pitch
2 CARD16 duration
4 CARD32 led_mask
4 CARD32 led_values
1 global_auto_repeat
0 Off
1 On
1 CARD8 click
1 CARD8 percent
1 unused
32 LISTofCARD8 auto_repeats
</pre><p>
</p><p>
</p><pre class="literallayout">
PTRFEEDBACKSTATE
1 0 feedback class id
1 CARD8 id of this feedback
2 12 length
2 unused
2 CARD16 acceleration-numerator
2 CARD16 acceleration-denominator
2 CARD16 threshold
</pre><p>
</p><p>
</p><pre class="literallayout">
INTEGERFEEDBACKSTATE
1 0 feedback class id
1 CARD8 id of this feedback
2 16 length
4 CARD32 resolution
4 INT32 minimum value
4 INT32 maximum value
</pre><p>
</p><p>
</p><pre class="literallayout">
STRINGFEEDBACKSTATE
1 1 feedback class id
1 CARD8 id of this feedback
2 4n+8 length
2 CARD16 max_symbols
2 n number of keysyms supported
4n LISTofKEYSYM key symbols supported
</pre><p>
</p><p>
</p><pre class="literallayout">
BELLFEEDBACKSTATE
1 1 feedback class id
1 CARD8 id of this feedback
2 12 length
1 CARD8 percent
3 unused
2 CARD16 pitch
2 CARD16 duration
</pre><p>
</p><p>
</p><pre class="literallayout">
LEDFEEDBACKSTATE
1 1 feedback class id
1 CARD8 id of this feedback
2 12 length
4 CARD32 led_mask
4 BITMASK led_values
#x0001 On
#x0002 Off
</pre><p>
</p><p>
</p><pre class="literallayout">
ChangeFeedbackControl
1 CARD8 input extension opcode
1 23 ChangeFeedbackControl opcode
2 3+n/4 request length
4 BITMASK value-mask (has n bits set to 1)
#x0001 keyclick-percent
#x0002 bell-percent
#x0004 bell-pitch
#x0008 bell-duration
#x0010 led
#x0020 led-mode
#x0040 key
#x0080 auto-repeat-mode
#x0001 string
#x0001 integer
#x0001 acceleration-numerator
#x0002 acceleration-denominator
#x0004 acceleration-threshold
1 CARD8 device id
1 CARD8 feedback class id
2 unused
n FEEDBACKCLASS
</pre><p>
</p><p>
</p><pre class="literallayout">
FEEDBACKCLASS KBDFEEDBACKCTL, PTRFEEDBACKCTL, INTEGERFEEDBACKCTL,
STRINGFEEDBACKCTL, BELLFEEDBACKCTL, or LEDFEEDBACKCTL
</pre><p>
</p><p>
</p><pre class="literallayout">
KBDFEEDBACKCTL
1 0 feedback class id
1 CARD8 id of this feedback
2 20 length
1 KEYCODE key
1 auto-repeat-mode
0 Off
1 On
2 Default
1 INT8 key-click-percent
1 INT8 bell-percent
2 INT16 bell-pitch
2 INT16 bell-duration
4 CARD32 led_mask
4 CARD32 led_values
</pre><p>
</p><p>
</p><pre class="literallayout">
PTRFEEDBACKCTL
1 1 feedback class id
1 CARD8 id of this feedback
2 12 length
2 unused
2 INT16 numerator
2 INT16 denominator
2 INT16 threshold
</pre><p>
</p><p>
</p><pre class="literallayout">
STRINGCTL
1 2 feedback class id
1 CARD8 id of this feedback
2 4n+8 length
2 unused
2 n number of keysyms to display
4n LISTofKEYSYM list of key symbols to display
</pre><p>
</p><p>
</p><pre class="literallayout">
INTEGERCTL
1 3 feedback class id
1 CARD8 id of this feedback
2 8 length
4 INT32 integer to display
</pre><p>
</p><p>
</p><pre class="literallayout">
LEDCTL
1 4 feedback class id
1 CARD8 id of this feedback
2 12 length
4 CARD32 led_mask
4 BITMASK led_values
#x0001 On
#x0002 Off
</pre><p>
</p><p>
</p><pre class="literallayout">
BELLCTL
1 5 feedback class id
1 CARD8 id of this feedback
2 8 length
1 INT8 percent
3 unused
2 INT16 pitch
2 INT16 duration
</pre><p>
</p><p>
</p><pre class="literallayout">
GetDeviceKeyMapping
1 CARD8 input extension opcode
1 24 GetDeviceKeyMapping opcode
2 2 request length
1 CARD8 device
1 KEYCODE first-keycode
1 CARD8 count
1 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 24 GetDeviceKeyMapping opcode
2 CARD16 sequence number
4 nm reply length (m = count field from the request)
1 n keysyms-per-keycode
23 unused
4nm LISTofKEYSYM keysyms
</pre><p>
</p><p>
</p><pre class="literallayout">
ChangeDeviceKeyMapping
1 CARD8 input extension opcode
1 25 ChangeDeviceKeyMapping opcode
2 2+nm request length
1 CARD8 device
1 KEYCODE first-keycode
1 m keysyms-per-keycode
1 n keycode-count
4nm LISTofKEYSYM keysyms
</pre><p>
</p><p>
</p><pre class="literallayout">
GetDeviceModifierMapping
1 CARD8 input extension opcode
1 26 GetDeviceModifierMapping opcode
2 2 request length
1 CARD8 device
3 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 26 GetDeviceModifierMapping opcode
2 CARD16 sequence number
4 2n reply length
1 n keycodes-per-modifier
23 unused
8n LISTofKEYCODE keycodes
</pre><p>
</p><p>
</p><pre class="literallayout">
SetDeviceModifierMapping
1 CARD8 input extension opcode
1 27 SetDeviceModifier opcode
2 2+2n request length
1 CARD8 device
1 n keycodes-per-modifier
2 unused
8n LISTofKEYCODE keycodes
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 27 SetDeviceModifierMapping opcode
2 CARD16 sequence number
4 0 reply length
1 status
0 Success
1 Busy
2 Failed
23 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
GetDeviceButtonMapping
1 CARD8 input extension opcode
1 28 GetDeviceButtonMapping opcode
2 2 request length
1 CARD8 device
3 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 28 GetDeviceButtonMapping opcode
2 CARD16 sequence number
4 (n+p)/4 reply length
1 n number of elements in map list
23 unused
n LISTofCARD8 map
p unused, p=pad(n)
</pre><p>
</p><p>
</p><pre class="literallayout">
SetDeviceButtonMapping
1 CARD8 input extension opcode
1 29 SetDeviceButtonMapping opcode
2 2+(n+p)/4 request length
1 CARD8 device
1 n length of map
2 unused
n LISTofCARD8 map
p unused, p=pad(n)
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 29 SetDeviceButtonMapping opcode
2 CARD16 sequence number
4 0 reply length
1 status
0 Success
1 Busy
23 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
QueryDeviceState
1 CARD8 input extension opcode
1 30 QueryDeviceState opcode
2 2 request length
1 CARD8 device
3 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 30 QueryDeviceState opcode
2 CARD16 sequence number
4 m/4 reply length
1 n number of input classes
23 unused
m LISTofINPUTSTATE
</pre><p>
</p><pre class="literallayout">
INPUTSTATE KEYSTATE or BUTTONSTATE or VALUATORSTATE
</pre><p>
</p><p>
</p><pre class="literallayout">
KEYSTATE
1 CARD8 key input class id
1 36 length
1 CARD8 num_keys
1 unused
32 LISTofCARD8 status of keys
</pre><p>
</p><pre class="literallayout">
BUTTONSTATE
1 CARD8 button input class id
1 36 length
1 CARD8 num_buttons
1 unused
32 LISTofCARD8 status of buttons
</pre><p>
</p><pre class="literallayout">
VALUATORSTATE
1 CARD8 valuator input class id
1 4n + 4 length
1 n number of valuators
1 mode
#x01 DeviceMode (0 = Relative, 1 = Absolute)
#x02 ProximityState (0 = InProximity, 1 = OutOfProximity)
4n LISTofCARD32 status of valuators
</pre><p>
</p><p>
</p><pre class="literallayout">
SendExtensionEvent
1 CARD8 input extension opcode
1 31 SendExtensionEvent opcode
2 4 + 8n + m request length
4 WINDOW destination
1 CARD8 device
1 BOOL propagate
2 CARD16 eventclass count
1 CARD8 num_events
3 unused
32n LISTofEVENTS events to send
4m LISTofEVENTCLASS desired events
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceBell
1 CARD8 input extension opcode
1 32 DeviceBell opcode
2 2 request length
1 CARD8 device id
1 CARD8 feedback id
1 CARD8 feedback class
1 INT8 percent
</pre><p>
</p><p>
</p><pre class="literallayout">
SetDeviceValuators
1 CARD8 input extension opcode
1 33 SetDeviceValuators opcode
2 2 + n request length
1 CARD8 device id
1 CARD8 first valuator
1 n number of valuators
1 unused
4n LISTofINT32 valuator values to set
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 33 SetDeviceValuators opcode
2 CARD16 sequence number
4 0 reply length
1 CARD8 status
0 Success
1 AlreadyGrabbed
23 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
GetDeviceControl
1 CARD8 input extension opcode
1 34 GetDeviceControl opcode
2 2 request length
2 CARD16 device control type
1 CARD8 device id
1 unused
</pre><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 34 GetDeviceControl opcode
2 CARD16 sequence number
4 n/4 reply length
1 CARD8 status
0 Success
1 AlreadyGrabbed
3 + first_error DeviceBusy
23 unused
n DEVICESTATE
</pre><p>
</p><pre class="literallayout">
DEVICESTATE DEVICERESOLUTIONSTATE
</pre><p>
</p><p>
</p><pre class="literallayout">
DEVICERESOLUTIONSTATE
2 0 control type
2 8 + 12n length
4 n num_valuators
4n LISTOfCARD32 resolution values
4n LISTOfCARD32 resolution min_values
4n LISTOfCARD32 resolution max_values
</pre><p>
</p><p>
</p><p>
</p><pre class="literallayout">
ChangeDeviceControl
1 CARD8 input extension opcode
1 35 ChangeDeviceControl opcode
2 2+n/4 request length
2 CARD16 control type
1 CARD8 device id
1 unused
n DEVICECONTROL
</pre><p>
</p><pre class="literallayout">
DEVICECONTROL DEVICERESOLUTIONCTL
</pre><p>
</p><p>
</p><pre class="literallayout">
DEVICERESOLUTIONCTL
2 1 control type
2 8 + 4n length
1 CARD8 first_valuator
1 n num_valuators
2 unused
4n LISTOfCARD32 resolution values
</pre><p>
</p><p>
</p><pre class="literallayout">
=>
1 1 Reply
1 35 ChangeDeviceControl opcode
2 CARD16 sequence number
4 0 reply length
1 CARD8 status
0 Success
1 AlreadyGrabbed
3 + first_error DeviceBusy
23 unused
</pre><p>
Events
</p><p>
DeviceKeyPress, DeviceKeyRelease, DeviceButtonPress, DeviceButtonRelease,
ProximityIn, ProximityOut, and DeviceStateNotify events may be followed by
zero or more DeviceValuator events. DeviceMotionNotify events will be
followed by one or more DeviceValuator events.
</p><p>
</p><pre class="literallayout">
DeviceValuator
1 CARD8 code
1 CARD8 device id
2 CARD16 sequence number
2 SETofKEYBUTMASK state
1 n number of valuators this device reports
1 m number of first valuator in this event
24 LISTofINT32 valuators
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceKeyPress
1 CARD8 code
1 KEYCODE detail
2 CARD16 sequence number
4 TIMESTAMP time
4 WINDOW root
4 WINDOW event
4 WINDOW child
0 None
2 INT16 root-x
2 INT16 root-y
2 INT16 event-x
2 INT16 event-y
2 SETofKEYBUTMASK state
1 BOOL same-screen
1 CARD8 device id
#x80 MORE_EVENTS follow
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceKeyRelease
1 CARD8 code
1 KEYCODE detail
2 CARD16 sequence number
4 TIMESTAMP time
4 WINDOW root
4 WINDOW event
4 WINDOW child
0 None
2 INT16 root-x
2 INT16 root-y
2 INT16 event-x
2 INT16 event-y
2 SETofKEYBUTMASK state
1 BOOL same-screen
1 CARD8 device id
#x80 MORE_EVENTS follow
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceButtonPress
1 CARD8 code
1 BUTTON detail
2 CARD16 sequence number
4 TIMESTAMP time
4 WINDOW root
4 WINDOW event
4 WINDOW child
0 None
2 INT16 root-x
2 INT16 root-y
2 INT16 event-x
2 INT16 event-y
2 SETofKEYBUTMASK state
1 BOOL same-screen
1 CARD8 device id
#x80 MORE_EVENTS follow
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceButtonRelease
1 CARD8 code
1 BUTTON detail
2 CARD16 sequence number
4 TIMESTAMP time
4 WINDOW root
4 WINDOW event
4 WINDOW child
0 None
2 INT16 root-x
2 INT16 root-y
2 INT16 event-x
2 INT16 event-y
2 SETofKEYBUTMASK state
1 BOOL same-screen
1 CARD8 device id
#x80 MORE_EVENTS follow
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceMotionNotify
1 CARD8 code
1 detail
0 Normal
1 Hint
2 CARD16 sequence number
4 TIMESTAMP time
4 WINDOW root
4 WINDOW event
4 WINDOW child
0 None
2 INT16 root-x
2 INT16 root-y
2 INT16 event-x
2 INT16 event-y
2 SETofKEYBUTMASK state
1 BOOL same-screen
1 CARD8 device id
#x80 MORE_EVENTS follow
</pre><p>
</p><pre class="literallayout">
DeviceFocusIn
1 CARD8 code
1 detail
0 Ancestor
1 Virtual
2 Inferior
3 Nonlinear
4 NonlinearVirtual
5 Pointer
6 PointerRoot
7 None
2 CARD16 sequence number
4 TIMESTAMP time
4 WINDOW event
1 mode
0 Normal
1 Grab
2 Ungrab
3 WhileGrabbed
1 CARD8 device id
18 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceFocusOut
1 CARD8 code
1 detail
0 Ancestor
1 Virtual
2 Inferior
3 Nonlinear
4 NonlinearVirtual
5 Pointer
6 PointerRoot
7 None
2 CARD16 sequence number
4 TIMESTAMP time
4 WINDOW event
1 mode
0 Normal
1 Grab
2 Ungrab
3 WhileGrabbed
1 CARD8 device id
18 unused
</pre><p>
</p><p>
</p><pre class="literallayout">
ProximityIn
1 CARD8 code
1 unused
2 CARD16 sequence number
4 TIMESTAMP time
4 WINDOW root
4 WINDOW event
4 WINDOW child
0 None
2 INT16 root-x
2 INT16 root-y
2 INT16 event-x
2 INT16 event-y
2 SETofKEYBUTMASK state
1 BOOL same-screen
1 CARD8 device id
#x80 MORE_EVENTS follow
</pre><p>
</p><p>
</p><pre class="literallayout">
ProximityOut
1 CARD8 code
1 unused
2 CARD16 sequence number
4 TIMESTAMP time
4 WINDOW root
4 WINDOW event
4 WINDOW child
0 None
2 INT16 root-x
2 INT16 root-y
2 INT16 event-x
2 INT16 event-y
2 SETofKEYBUTMASK state
1 BOOL same-screen
1 CARD8 device id
#x80 MORE_EVENTS follow
</pre><p>
</p><p>
DeviceStateNotify events may be immediately followed by zero or one
DeviceKeyStateNotify and/ or zero or more DeviceValuator events.
</p><p>
</p><pre class="literallayout">
DeviceStateNotify
1 CARD8 code
1 CARD8 device id
#x80 MORE_EVENTS follow
2 CARD16 sequence number
4 TIMESTAMP time
1 CARD8 num_keys
1 CARD8 num_buttons
1 CARD8 num_valuators
1 CARD8 valuator mode and input classes reported
#x01 reporting keys
#x02 reporting buttons
#x04 reporting valuators
#x40 device mode (0 = Relative, 1 = Absolute)
#x80 proximity state (0 = InProximity, 1 = OutOfProximity)
4 LISTofCARD8 first 32 keys (if reported)
4 LISTofCARD8 first 32 buttons (if reported)
12 LISTofCARD32 first 3 valuators (if reported)
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceKeyStateNotify
1 CARD8 code
1 CARD8 device id
#x80 MORE_EVENTS follow
2 CARD16 sequence number
28 LISTofCARD8 state of keys 33-255
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceButtonStateNotify
1 CARD8 code
1 CARD8 device id
#x80 MORE_EVENTS follow
2 CARD16 sequence number
28 LISTofCARD8 state of buttons 33-255
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceValuator
1 CARD8 code
1 CARD8 device id
2 CARD16 sequence number
2 SETofKEYBUTMASK state
1 n number of valuators this device reports
1 n number of first valuator in this event
24 LISTofINT32 valuators
</pre><p>
</p><p>
</p><pre class="literallayout">
DeviceMappingNotify
1 CARD8 code
1 CARD8 device id
2 CARD16 sequence number
1 request
0 MappingModifier
1 MappingKeyboard
2 MappingPointer
1 KEYCODE first-keycode
1 CARD8 count
1 unused
4 TIMESTAMP time
20 unused
</pre><p>
</p><pre class="literallayout">
ChangeDeviceNotify
1 CARD8 code
1 CARD8 id of device specified on change request
2 CARD16 sequence number
4 TIMESTAMP time
1 request
0 NewPointer
1 NewKeyboard
23 unused
</pre></div></div></body></html>
|