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
use crate::{
event::{switch::Switch, tablet_pad::TabletPadModeGroup},
ffi, AsRaw, FromRaw, Libinput, Seat,
};
use bitflags::bitflags;
use std::ffi::{CStr, CString};
#[cfg(feature = "udev")]
use udev::{
ffi::{udev as udev_context, udev_device, udev_device_get_udev},
Device as UdevDevice, FromRawWithContext as UdevFromRawWithContext,
};
/// Capabilities on a device.
///
/// A device may have one or more capabilities at a time, capabilities
/// remain static for the lifetime of the device.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum DeviceCapability {
/// Keyboard capability
Keyboard,
/// Pointer capability
Pointer,
/// Touch capability
Touch,
/// TabletTool capability
TabletTool,
/// TabletPad capability
TabletPad,
/// Gesture capability
Gesture,
/// Switch capability
Switch,
}
/// Pointer Acceleration Profile
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum AccelProfile {
/// A flat acceleration profile.
///
/// Pointer motion is accelerated by a constant (device-specific)
/// factor, depending on the current speed.
Flat,
/// An adaptive acceleration profile.
///
/// Pointer acceleration depends on the input speed. This is the
/// default profile for most devices.
Adaptive,
}
/// The click method defines when to generate software-emulated
/// buttons, usually on a device that does not have a specific
/// physical button available.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum ClickMethod {
/// Use software-button areas (see [Clickfinger behavior](https://wayland.freedesktop.org/libinput/doc/latest/clickpad_softbuttons.html#clickfinger))
/// to generate button events.
ButtonAreas,
/// The number of fingers decides which button press to generate.
Clickfinger,
}
/// The scroll method of a device selects when to generate scroll axis
/// events instead of pointer motion events.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum ScrollMethod {
/// Never send scroll events instead of pointer motion events.
///
/// This has no effect on events generated by scroll wheels.
NoScroll,
/// Send scroll events when two fingers are logically down on the
/// device.
TwoFinger,
/// Send scroll events when a finger moves along the bottom or
/// right edge of a device.
Edge,
/// Send scroll events when a button is down and the device moves
/// along a scroll-capable axis.
OnButtonDown,
}
/// Errors returned when applying configuration settings.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum DeviceConfigError {
/// Configuration not available on this device.
Unsupported,
/// Invalid parameter range.
Invalid,
}
bitflags! {
/// The send-event mode of a device defines when a device may generate
/// events and pass those events to the caller.
pub struct SendEventsMode: u32 {
/// Send events from this device normally.
///
/// This is a placeholder mode only, any device detected by
/// libinput can be enabled. Do not test for this value as bitmask.
const ENABLED = ffi::libinput_config_send_events_mode_LIBINPUT_CONFIG_SEND_EVENTS_ENABLED;
/// Do not send events through this device.
///
/// Depending on the device, this may close all file descriptors
/// on the device or it may leave the file descriptors open and
/// route events through a different device.
///
/// If this mode is set, other disable modes may be ignored.
/// For example, if both `Disabled` and `DisabledOnExternalMouse`
/// are set, the device remains disabled when all external pointer
/// devices are unplugged.
const DISABLED = ffi::libinput_config_send_events_mode_LIBINPUT_CONFIG_SEND_EVENTS_DISABLED;
/// If an external pointer device is plugged in, do not send
/// events from this device.
///
/// This option may be available on built-in touchpads.
const DISABLED_ON_EXTERNAL_MOUSE = ffi::libinput_config_send_events_mode_LIBINPUT_CONFIG_SEND_EVENTS_DISABLED_ON_EXTERNAL_MOUSE;
}
}
/// Map 1/2/3 finger tips to buttons
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum TapButtonMap {
/// 1/2/3 finger tap maps to left/right/middle
LeftRightMiddle,
/// 1/2/3 finger tap maps to left/middle/right
LeftMiddleRight,
}
/// Whenever scroll button lock is enabled or not
#[cfg(feature = "libinput_1_15")]
#[allow(missing_docs)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum ScrollButtonLockState {
Disabled,
Enabled,
}
/// Result returned when applying configuration settings.
pub type DeviceConfigResult = Result<(), DeviceConfigError>;
bitflags! {
/// Mask reflecting LEDs on a device.
pub struct Led: u32 {
/// Num Lock Led
const NUMLOCK = ffi::libinput_led_LIBINPUT_LED_NUM_LOCK;
/// Caps Lock Led
const CAPSLOCK = ffi::libinput_led_LIBINPUT_LED_CAPS_LOCK;
/// Scroll Lock Led
const SCROLLLOCK = ffi::libinput_led_LIBINPUT_LED_SCROLL_LOCK;
}
}
ffi_ref_struct!(
/// Device group
///
/// Some physical devices like graphics tablets are represented by
/// multiple kernel devices and thus by multiple `Device`s.
///
/// libinput assigns these devices to the same `DeviceGroup` allowing
/// the caller to identify such devices and adjust configuration
/// settings accordingly. For example, setting a tablet to left-handed
/// often means turning it upside down. A touch device on the same
/// tablet would need to be turned upside down too to work correctly.
///
/// All devices are part of a device group though for most devices the
/// group will be a singleton. A device is assigned to a device group
/// on `DeviceAddedEvent` and removed from that group on
/// `DeviceRemovedEvent`. It is up to the caller to track how many
/// devices are in each device group.
///
/// Device groups do not get re-used once the last device in the group
/// was removed, i.e. unplugging and re-plugging a physical device
/// with grouped devices will return a different device group after
/// every unplug.
///
/// Device groups are assigned based on the LIBINPUT_DEVICE_GROUP udev
/// property, see [Static device configuration](https://wayland.freedesktop.org/libinput/doc/latest/udev_config.html) via udev.
struct DeviceGroup, ffi::libinput_device_group, ffi::libinput_device_group_ref, ffi::libinput_device_group_unref);
ffi_ref_struct!(
/// Representation of a single input device as seen by the kernel.
///
/// A single physical device might consist out of multiple input
/// devices like a keyboard-touchpad combination. See `DeviceGroup`
/// if you want to track such combined physical devices.
struct Device, ffi::libinput_device, ffi::libinput_device_ref, ffi::libinput_device_unref);
impl Device {
/// Get the libinput context from the device.
pub fn context(&self) -> Libinput {
self.context.clone()
}
/// Get the device group this device is assigned to.
///
/// Some physical devices like graphics tablets are represented by
/// multiple kernel devices and thus by multiple `Device`s.
///
/// libinput assigns these devices to the same `DeviceGroup`
/// allowing the caller to identify such devices and adjust
/// configuration settings accordingly. For example, setting a
/// tablet to left-handed often means turning it upside down. A
/// touch device on the same tablet would need to be turned upside
/// down too to work correctly.
///
/// All devices are part of a device group though for most devices
/// the group will be a singleton. A device is assigned to a
/// device group on `DeviceAddedEvent` and removed from that group
/// on `DeviceRemovedEvent`. It is up to the caller to track how
/// many devices are in each device group.
///
/// Device groups do not get re-used once the last device in the
/// group was removed, i.e. unplugging and re-plugging a physical
/// device with grouped devices will return a different device
/// group after every unplug.
///
/// Device groups are assigned based on the `LIBINPUT_DEVICE_GROUP`
/// udev property, see [Static device configuration](https://wayland.freedesktop.org/libinput/doc/latest/udev_config.html) via udev.
pub fn device_group(&self) -> DeviceGroup {
unsafe {
DeviceGroup::from_raw(
ffi::libinput_device_get_device_group(self.as_raw_mut()),
&self.context,
)
}
}
/// Get the system name of the device.
///
/// To get the descriptive device name, use `name`.
pub fn sysname(&self) -> &str {
unsafe {
CStr::from_ptr(ffi::libinput_device_get_sysname(self.as_raw_mut()))
.to_str()
.expect("Device sysname is no valid utf8")
}
}
/// The descriptive device name as advertised by the kernel and/or
/// the hardware itself.
///
/// To get the sysname for this device, use `sysname`.
pub fn name(&self) -> &str {
unsafe {
CStr::from_ptr(ffi::libinput_device_get_name(self.as_raw_mut()))
.to_str()
.expect("Device name is no valid utf8")
}
}
/// A device may be mapped to a single output, or all available
/// outputs.
///
/// If a device is mapped to a single output only, a relative
/// device may not move beyond the boundaries of this output. An
/// absolute device has its input coordinates mapped to the
/// extents of this output.
pub fn output_name(&self) -> Option<&str> {
unsafe {
let ptr = ffi::libinput_device_get_output_name(self.as_raw_mut());
if !ptr.is_null() {
Some(
CStr::from_ptr(ptr)
.to_str()
.expect("Device output_name is no valid utf8"),
)
} else {
None
}
}
}
ffi_func!(
/// Get the product ID for this device.
pub fn id_product, ffi::libinput_device_get_id_product, u32);
ffi_func!(
/// Get the vendor ID for this device.
pub fn id_vendor, ffi::libinput_device_get_id_vendor, u32);
/// Get the seat associated with this input device, see
/// [Seats](https://wayland.freedesktop.org/libinput/doc/latest/seats.html)
/// for details.
///
/// A seat can be uniquely identified by the physical and logical
/// seat name. There will ever be only one seat instance with a
/// given physical and logical seat name pair at any given time,
/// but if no external reference is kept, it may be destroyed if
/// no device belonging to it is left.
pub fn seat(&self) -> Seat {
unsafe {
Seat::from_raw(
ffi::libinput_device_get_seat(self.as_raw_mut()),
&self.context,
)
}
}
/// Change the logical seat associated with this device by removing the device and adding it to the new seat.
///
/// This command is identical to physically unplugging the device,
/// then re-plugging it as a member of the new seat. libinput will
/// generate a `DeviceRemovedEvent` event and this `Device` is
/// considered removed from the context; it will not generate
/// further events and will be freed when it goes out of scope.
/// A `DeviceAddedEvent` event is generated with a new `Device`
/// handle. It is the caller's responsibility to update references
/// to the new device accordingly.
///
/// If the logical seat name already exists in the device's
/// physical seat, the device is added to this seat. Otherwise, a
/// new seat is created.
///
/// ## Note
/// This change applies to this device until removal or `suspend`,
/// whichever happens earlier.
pub fn set_seat_logical_name(&mut self, name: &str) -> Result<(), ()> {
let name = CString::new(name).expect("New logical_seat name contained a null-byte");
unsafe {
if ffi::libinput_device_set_seat_logical_name(self.as_raw_mut(), name.as_ptr()) == 0 {
Ok(())
} else {
Err(())
}
}
}
/// Return a udev handle to the device that is this libinput
/// device, if any.
///
/// Some devices may not have a udev device, or the udev device
/// may be unobtainable. This function returns `None` if no udev
/// device was available.
///
/// Calling this function multiple times for the same device may
/// not return the same udev handle each time.
///
/// # Safety
///
/// The result of this function is not definied if the passed udev `Context`
/// is not the same as the one the libinput `Context` was created from.
#[cfg(feature = "udev")]
pub unsafe fn udev_device(&self) -> Option<UdevDevice> {
let dev: *mut udev_device = ffi::libinput_device_get_udev_device(self.ffi) as *mut _;
let ctx: *mut udev_context = udev_device_get_udev(dev);
if dev.is_null() {
None
} else {
Some(UdevDevice::from_raw_with_context(ctx, dev))
}
}
/// Update the LEDs on the device, if any.
///
/// If the device does not have LEDs, or does not have one or more
/// of the LEDs given in the mask, this function does nothing.
///
/// ## Arguments
///
/// leds: Leds to turn on
///
/// Missing `Led`s will be turned off.
/// The slice is interpreted as a bitmap.
pub fn led_update(&mut self, leds: Led) {
unsafe { ffi::libinput_device_led_update(self.as_raw_mut(), leds.bits()) }
}
/// Check if the given device has the specified capability.
pub fn has_capability(&self, cap: DeviceCapability) -> bool {
unsafe {
ffi::libinput_device_has_capability(
self.as_raw_mut(),
match cap {
DeviceCapability::Keyboard => {
ffi::libinput_device_capability_LIBINPUT_DEVICE_CAP_KEYBOARD
}
DeviceCapability::Pointer => {
ffi::libinput_device_capability_LIBINPUT_DEVICE_CAP_POINTER
}
DeviceCapability::Touch => {
ffi::libinput_device_capability_LIBINPUT_DEVICE_CAP_TOUCH
}
DeviceCapability::TabletTool => {
ffi::libinput_device_capability_LIBINPUT_DEVICE_CAP_TABLET_TOOL
}
DeviceCapability::TabletPad => {
ffi::libinput_device_capability_LIBINPUT_DEVICE_CAP_TABLET_PAD
}
DeviceCapability::Gesture => {
ffi::libinput_device_capability_LIBINPUT_DEVICE_CAP_GESTURE
}
DeviceCapability::Switch => {
ffi::libinput_device_capability_LIBINPUT_DEVICE_CAP_SWITCH
}
},
) != 0
}
}
/// Get the physical size of a device in mm, where meaningful.
///
/// This function only succeeds on devices with the required data,
/// i.e. tablets, touchpads and touchscreens.
pub fn size(&self) -> Option<(f64, f64)> {
let mut width = 0.0;
let mut height = 0.0;
match unsafe {
ffi::libinput_device_get_size(
self.as_raw_mut(),
&mut width as *mut _,
&mut height as *mut _,
)
} {
0 => Some((width, height)),
_ => None,
}
}
/// Check if a `DeviceCapability::Pointer` device has a button
/// with the given code (see linux/input.h).
pub fn pointer_has_button(&self, button: u32) -> Result<bool, ()> {
match unsafe { ffi::libinput_device_pointer_has_button(self.as_raw_mut(), button) } {
1 => Ok(true),
0 => Ok(false),
-1 => Err(()),
_ => unreachable!(),
}
}
/// Check if a `DeviceCapability::Keyboard` device has a key with
/// the given code (see linux/input.h).
pub fn keyboard_has_key(&self, key: u32) -> Result<bool, ()> {
match unsafe { ffi::libinput_device_keyboard_has_key(self.as_raw_mut(), key) } {
1 => Ok(true),
0 => Ok(false),
-1 => Err(()),
_ => unreachable!(),
}
}
/// Check if a `DeviceCapability::Switch` device has a switch of the
/// given type.
pub fn switch_has_switch(&self, switch: Switch) -> Result<bool, ()> {
match unsafe { ffi::libinput_device_switch_has_switch(self.as_raw_mut(), switch as u32) } {
1 => Ok(true),
0 => Ok(false),
-1 => Err(()),
_ => unreachable!(),
}
}
ffi_func!(
/// Return the number of buttons on a device with the
/// `DeviceCapability::TabletPad` capability.
///
/// Buttons on a pad device are numbered sequentially, see Tablet
/// pad button numbers for details.
pub fn tablet_pad_number_of_buttons, ffi::libinput_device_tablet_pad_get_num_buttons, i32);
ffi_func!(
/// Return the number of rings a device with the
/// `DeviceCapability::TabletPad` capability provides.
pub fn tablet_pad_number_of_rings, ffi::libinput_device_tablet_pad_get_num_rings, i32);
ffi_func!(
/// Return the number of strips a device with the
/// `DeviceCapability::TabletPad` capability provides.
pub fn tablet_pad_number_of_strips, ffi::libinput_device_tablet_pad_get_num_strips, i32);
ffi_func!(
/// Most devices only provide a single mode group, however devices
/// such as the Wacom Cintiq 22HD provide two mode groups.
///
/// If multiple mode groups are available, a caller should use
/// `TabletPadModeGroup::has_button`,
/// `TabletPadModeGroup::has_ring` and
/// `TabletPadModeGroup::has_strip()` to associate each button,
/// ring and strip with the correct mode group.
pub fn tablet_pad_number_of_mode_groups, ffi::libinput_device_tablet_pad_get_num_mode_groups, i32);
/// Return the current mode this mode group is in.
///
/// Note that the returned mode is the mode valid as of completing
/// the last `dispatch`. The returned mode may thus be
/// different than the mode returned by
/// `TabletPadEventTrait::mode`.
///
/// For example, if the mode was toggled three times between the
/// call to `dispatch`, this function returns the third mode but
/// the events in the event queue will return the modes 1, 2 and
/// 3, respectively.
pub fn tablet_pad_mode_group(&self, index: u32) -> Option<TabletPadModeGroup> {
let ptr =
unsafe { ffi::libinput_device_tablet_pad_get_mode_group(self.as_raw_mut(), index) };
if ptr.is_null() {
None
} else {
Some(unsafe { TabletPadModeGroup::from_raw(ptr, &self.context) })
}
}
/// Check if a `DeviceCapability::TabletPad`-device has a key with the given code (see linux/input-event-codes.h).
///
/// ## Returns
/// - `Some(true)` if it has the requested key
/// - `Some(false)` if it has not
/// - `None` on error (no TabletPad device)
#[cfg(feature = "libinput_1_15")]
pub fn tablet_pad_has_key(&self, code: u32) -> Option<bool> {
match unsafe { ffi::libinput_device_tablet_pad_has_key(self.as_raw_mut(), code) } {
-1 => None,
0 => Some(false),
1 => Some(true),
_ => panic!(
"libinput returned invalid return code for libinput_device_tablet_pad_has_key"
),
}
}
/// Check how many touches a `DeviceCapability::Touch`-exposing Device supports simultaneously.
///
/// ## Returns
/// - `Some(n)` amount of touches
/// - `Some(0)` if unknown
/// - `None` on error (no touch device)
#[cfg(feature = "libinput_1_11")]
pub fn touch_count(&mut self) -> Option<u32> {
match unsafe { ffi::libinput_device_touch_get_touch_count(self.as_raw_mut()) } {
-1 => None,
n => Some(n as u32),
}
}
/// Return the default pointer acceleration profile for this
/// pointer device.
pub fn config_accel_default_profile(&self) -> Option<AccelProfile> {
match unsafe { ffi::libinput_device_config_accel_get_default_profile(self.as_raw_mut()) } {
ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_NONE => None,
ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_FLAT => {
Some(AccelProfile::Flat)
}
ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_ADAPTIVE => {
Some(AccelProfile::Adaptive)
}
_x => {
#[cfg(feature = "log")]
log::warn!(
"Unknown AccelProfile ({}). Unsupported libinput version?",
_x
);
None
}
}
}
/// Get the current pointer acceleration profile for this pointer
/// device.
pub fn config_accel_profile(&self) -> Option<AccelProfile> {
match unsafe { ffi::libinput_device_config_accel_get_profile(self.as_raw_mut()) } {
ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_NONE => None,
ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_FLAT => {
Some(AccelProfile::Flat)
}
ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_ADAPTIVE => {
Some(AccelProfile::Adaptive)
}
_x => {
#[cfg(feature = "log")]
log::warn!(
"Unknown AccelProfile ({}). Unsupported libinput version?",
_x
);
None
}
}
}
/// Returns a bitmask of the configurable acceleration modes
/// available on this device.
pub fn config_accel_profiles(&self) -> Vec<AccelProfile> {
let mut profiles = Vec::new();
let bitmask = unsafe { ffi::libinput_device_config_accel_get_profiles(self.as_raw_mut()) };
if bitmask & ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_FLAT as u32
!= 0
{
profiles.push(AccelProfile::Flat);
}
if bitmask
& ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_ADAPTIVE as u32
!= 0
{
profiles.push(AccelProfile::Adaptive);
}
profiles
}
/// Set the pointer acceleration profile of this pointer device to
/// the given mode.
pub fn config_accel_set_profile(&mut self, profile: AccelProfile) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_accel_set_profile(
self.as_raw_mut(),
match profile {
AccelProfile::Flat => {
ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_FLAT
}
AccelProfile::Adaptive => {
ffi::libinput_config_accel_profile_LIBINPUT_CONFIG_ACCEL_PROFILE_ADAPTIVE
}
},
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
ffi_func!(
/// Return the default speed setting for this device, normalized
/// to a range of [-1, 1].
pub fn config_accel_default_speed, ffi::libinput_device_config_accel_get_default_speed, f64);
ffi_func!(
/// Get the current pointer acceleration setting for this pointer
/// device.
///
/// The returned value is normalized to a range of [-1, 1]. See
/// `config_accel_set_speed` for details.
pub fn config_accel_speed, ffi::libinput_device_config_accel_get_speed, f64);
/// Set the pointer acceleration speed of this pointer device
/// within a range of [-1, 1], where 0 is the default acceleration
/// for this device, -1 is the slowest acceleration and 1 is the
/// maximum acceleration available on this device.
///
/// The actual pointer acceleration mechanism is
/// implementation-dependent, as is the number of steps available
/// within the range. libinput picks the semantically closest
/// acceleration step if the requested value does not match a
/// discrete setting.
pub fn config_accel_set_speed(&mut self, speed: f64) -> DeviceConfigResult {
match unsafe { ffi::libinput_device_config_accel_set_speed(self.as_raw_mut(), speed) } {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
ffi_func!(
/// Check if a device uses libinput-internal pointer-acceleration.
pub fn config_accel_is_available, ffi::libinput_device_config_accel_is_available, bool);
/// Return the default calibration matrix for this device.
///
/// On most devices, this is the identity matrix. If the udev
/// property `LIBINPUT_CALIBRATION_MATRIX` is set on the respective u
/// dev device, that property's value becomes the default matrix,
/// see [Static device configuration via udev](https://wayland.freedesktop.org/libinput/doc/latest/udev_config.html).
pub fn config_calibration_default_matrix(&self) -> Option<[f32; 6]> {
let mut matrix = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0];
if unsafe {
ffi::libinput_device_config_calibration_get_default_matrix(
self.as_raw_mut(),
matrix.as_mut_ptr(),
) != 0
} {
Some(matrix)
} else {
None
}
}
/// Return the current calibration matrix for this device.
pub fn config_calibration_matrix(&self) -> Option<[f32; 6]> {
let mut matrix = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0];
if unsafe {
ffi::libinput_device_config_calibration_get_matrix(
self.as_raw_mut(),
matrix.as_mut_ptr(),
) != 0
} {
Some(matrix)
} else {
None
}
}
ffi_func!(
/// Check if the device can be calibrated via a calibration matrix.
pub fn config_calibration_has_matrix, ffi::libinput_device_config_calibration_has_matrix, bool);
/// Apply the 3x3 transformation matrix to absolute device
/// coordinates.
///
/// This matrix has no effect on relative events.
///
/// Given a 6-element array [a, b, c, d, e, f], the matrix is
/// applied as
/// ```text
/// [ a b c ] [ x ]
/// [ d e f ] * [ y ]
/// [ 0 0 1 ] [ 1 ]
/// # *
/// ```
/// The translation component (c, f) is expected to be normalized
/// to the device coordinate range. For example, the matrix
/// ```text
/// [ 1 0 1 ]
/// [ 0 1 -1 ]
/// [ 0 0 1 ]
/// ```
/// moves all coordinates by 1 device-width to the right and 1
/// device-height up.
///
/// The rotation matrix for rotation around the origin is defined
/// as
/// ```text
/// [ cos(a) -sin(a) 0 ]
/// [ sin(a) cos(a) 0 ]
/// [ 0 0 1 ]
/// ```
/// Note that any rotation requires an additional translation
/// component to translate the rotated coordinates back into the
/// original device space. The rotation matrixes for 90, 180 and
/// 270 degrees clockwise are:
/// ```text
/// 90 deg cw: 180 deg cw: 270 deg cw:
/// [ 0 -1 1] [ -1 0 1] [ 0 1 0 ]
/// [ 1 0 0] [ 0 -1 1] [ -1 0 1 ]
/// [ 0 0 1] [ 0 0 1] [ 0 0 1 ]
/// ```
pub fn config_calibration_set_matrix(&mut self, matrix: [f32; 6]) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_calibration_set_matrix(self.as_raw_mut(), matrix.as_ptr())
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Get the default button click method for this device.
///
/// The button click method defines when to generate
/// software-emulated buttons, usually on a device that does not
/// have a specific physical button available.
pub fn config_click_default_method(&self) -> Option<ClickMethod> {
match unsafe { ffi::libinput_device_config_click_get_default_method(self.as_raw_mut()) } {
ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_NONE => None,
ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_BUTTON_AREAS => {
Some(ClickMethod::ButtonAreas)
}
ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_CLICKFINGER => {
Some(ClickMethod::Clickfinger)
}
_x => {
#[cfg(feature = "log")]
log::warn!(
"Unknown ClickMethod ({}). Unsupported libinput version?",
_x
);
None
}
}
}
/// Get the button click method for this device.
///
/// The button click method defines when to generate
/// software-emulated buttons, usually on a device that does not
/// have a specific physical button available.
pub fn config_click_method(&self) -> Option<ClickMethod> {
match unsafe { ffi::libinput_device_config_click_get_method(self.as_raw_mut()) } {
ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_NONE => None,
ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_BUTTON_AREAS => {
Some(ClickMethod::ButtonAreas)
}
ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_CLICKFINGER => {
Some(ClickMethod::Clickfinger)
}
_x => {
#[cfg(feature = "log")]
log::warn!(
"Unknown ClickMethod ({}). Unsupported libinput version?",
_x
);
None
}
}
}
/// Check which button click methods a device supports.
///
/// The button click method defines when to generate
/// software-emulated buttons, usually on a device that does not
/// have a specific physical button available.
pub fn config_click_methods(&self) -> Vec<ClickMethod> {
let mut methods = Vec::new();
let bitmask = unsafe { ffi::libinput_device_config_click_get_methods(self.as_raw_mut()) };
if bitmask
& ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_CLICKFINGER as u32
== bitmask
{
methods.push(ClickMethod::Clickfinger);
}
if bitmask
& ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_BUTTON_AREAS as u32
== bitmask
{
methods.push(ClickMethod::ButtonAreas);
}
methods
}
/// Set the button click method for this device.
///
/// The button click method defines when to generate
/// software-emulated buttons, usually on a device that does not
/// have a specific physical button available.
///
/// ## Note
///
/// The selected click method may not take effect immediately. The
/// device may require changing to a neutral state first before
/// activating the new method.
pub fn config_click_set_method(&mut self, method: ClickMethod) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_click_set_method(
self.as_raw_mut(),
match method {
ClickMethod::ButtonAreas => {
ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_BUTTON_AREAS
}
ClickMethod::Clickfinger => {
ffi::libinput_config_click_method_LIBINPUT_CONFIG_CLICK_METHOD_CLICKFINGER
}
},
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Check if the disable-while typing feature is enabled on this
/// device by default.
///
/// If the device does not support disable-while-typing, this
/// function returns `false`.
pub fn config_dwt_default_enabled(&self) -> bool {
match unsafe { ffi::libinput_device_config_dwt_get_default_enabled(self.as_raw_mut()) } {
ffi::libinput_config_dwt_state_LIBINPUT_CONFIG_DWT_ENABLED => true,
ffi::libinput_config_dwt_state_LIBINPUT_CONFIG_DWT_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_dwt_state'"),
}
}
/// Check if the disable-while typing feature is currently enabled
/// on this device.
///
/// If the device does not support disable-while-typing, this
/// function returns `false`.
pub fn config_dwt_enabled(&self) -> bool {
match unsafe { ffi::libinput_device_config_dwt_get_enabled(self.as_raw_mut()) } {
ffi::libinput_config_dwt_state_LIBINPUT_CONFIG_DWT_ENABLED => true,
ffi::libinput_config_dwt_state_LIBINPUT_CONFIG_DWT_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_dwt_state'"),
}
}
ffi_func!(
/// Check if this device supports configurable
/// disable-while-typing feature.
///
/// This feature is usually available on built-in touchpads and
/// disables the touchpad while typing. See [Disable-while-typing](https://wayland.freedesktop.org/libinput/doc/latest/palm_detection.html#disable-while-typing)
/// for details.
pub fn config_dwt_is_available, ffi::libinput_device_config_dwt_is_available, bool);
/// Enable or disable the disable-while-typing feature.
///
/// When enabled, the device will be disabled while typing and
/// for a short period after. See Disable-while-typing for
/// details.
///
/// ## Note
///
/// Enabling or disabling disable-while-typing may not take
/// effect immediately.
pub fn config_dwt_set_enabled(&self, enabled: bool) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_dwt_set_enabled(
self.as_raw_mut(),
if enabled {
ffi::libinput_config_dwt_state_LIBINPUT_CONFIG_DWT_ENABLED
} else {
ffi::libinput_config_dwt_state_LIBINPUT_CONFIG_DWT_DISABLED
},
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
ffi_func!(
/// Get the current left-handed configuration of the device.
pub fn config_left_handed, ffi::libinput_device_config_left_handed_get, bool);
ffi_func!(
/// Get the default left-handed configuration of the device.
pub fn config_left_handed_default, ffi::libinput_device_config_left_handed_get_default, bool);
ffi_func!(
/// Check if a device has a configuration that supports
/// left-handed usage.
pub fn config_left_handed_is_available, ffi::libinput_device_config_left_handed_is_available, bool);
/// Set the left-handed configuration of the device.
///
/// The exact behavior is device-dependent. On a mouse and most
/// pointing devices, left and right buttons are swapped but the
/// middle button is unmodified. On a touchpad, physical buttons
/// (if present) are swapped. On a clickpad, the top and bottom
/// software-emulated buttons are swapped where present, the main
/// area of the touchpad remains a left button. Tapping and
/// clickfinger behavior is not affected by this setting.
///
/// Changing the left-handed configuration of a device may not
/// take effect until all buttons have been logically released.
pub fn config_left_handed_set(&self, enabled: bool) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_left_handed_set(self.as_raw_mut(), enabled as i32)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Check if configurable middle button emulation is enabled by
/// default on this device.
///
/// See [Middle button emulation](https://wayland.freedesktop.org/libinput/doc/latest/middle_button_emulation.html) for details.
///
/// If the device does not have configurable middle button
/// emulation, this function returns `false`.
///
/// ## Note
///
/// Some devices provide middle mouse button emulation but do not
/// allow enabling/disabling that emulation. These devices always
/// return `false`.
pub fn config_middle_emulation_default_enabled(&self) -> bool {
match unsafe {
ffi::libinput_device_config_middle_emulation_get_default_enabled(self.as_raw_mut())
} {
ffi::libinput_config_middle_emulation_state_LIBINPUT_CONFIG_MIDDLE_EMULATION_ENABLED => true,
ffi::libinput_config_middle_emulation_state_LIBINPUT_CONFIG_MIDDLE_EMULATION_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_middle_emulation_state'"),
}
}
/// Check if configurable middle button emulation is enabled on
/// this device.
///
/// See [Middle button emulation](https://wayland.freedesktop.org/libinput/doc/latest/middle_button_emulation.html)
/// for details.
///
/// If the device does not have configurable middle button
/// emulation, this function returns `false`.
///
/// ## Note
///
/// Some devices provide middle mouse button emulation but do not
/// allow enabling/disabling that emulation. These devices always
/// return `false`.
pub fn config_middle_emulation_enabled(&self) -> bool {
match unsafe { ffi::libinput_device_config_middle_emulation_get_enabled(self.as_raw_mut()) } {
ffi::libinput_config_middle_emulation_state_LIBINPUT_CONFIG_MIDDLE_EMULATION_ENABLED => true,
ffi::libinput_config_middle_emulation_state_LIBINPUT_CONFIG_MIDDLE_EMULATION_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_middle_emulation_state'"),
}
}
ffi_func!(
/// Check if middle mouse button emulation configuration is
/// available on this device.
///
/// See [Middle button emulation](https://wayland.freedesktop.org/libinput/doc/latest/middle_button_emulation.html)
/// for details.
///
/// ## Note
///
/// Some devices provide middle mouse button emulation but do not
/// allow enabling/disabling that emulation. These devices return
/// `false` in `config_middle_emulation_is_available`.
pub fn config_middle_emulation_is_available, ffi::libinput_device_config_middle_emulation_is_available, bool);
/// Enable or disable middle button emulation on this device.
///
/// When enabled, a simultaneous press of the left and right
/// button generates a middle mouse button event. Releasing the
/// buttons generates a middle mouse button release, the left and
/// right button events are discarded otherwise.
///
/// See [Middle button emulation](https://wayland.freedesktop.org/libinput/doc/latest/middle_button_emulation.html)
/// for details.
pub fn config_middle_emulation_set_enabled(&self, enabled: bool) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_middle_emulation_set_enabled(
self.as_raw_mut(),
if enabled {
ffi::libinput_config_middle_emulation_state_LIBINPUT_CONFIG_MIDDLE_EMULATION_ENABLED
} else {
ffi::libinput_config_middle_emulation_state_LIBINPUT_CONFIG_MIDDLE_EMULATION_DISABLED
},
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
ffi_func!(
/// Get the current rotation of a device in degrees clockwise off
/// the logical neutral position.
///
/// If this device does not support rotation, the return value is
/// always 0.
pub fn config_rotation_angle, ffi::libinput_device_config_rotation_get_angle, u32);
ffi_func!(
/// Get the default rotation of a device in degrees clockwise off
/// the logical neutral position.
///
/// If this device does not support rotation, the return value is
/// always 0.
pub fn config_rotation_default_angle, ffi::libinput_device_config_rotation_get_default_angle, u32);
ffi_func!(
/// Check whether a device can have a custom rotation applied.
pub fn config_rotation_is_available, ffi::libinput_device_config_rotation_is_available, bool);
/// Set the rotation of a device in degrees clockwise off the
/// logical neutral position.
///
/// Any subsequent motion events are adjusted according to the
/// given angle.
///
/// The angle has to be in the range of [0, 360] degrees,
/// otherwise this function returns `DeviceConfigError::Invalid`.
/// If the angle is a multiple of 360 or negative, the caller
/// must ensure the correct ranging before calling this function.
///
/// libinput guarantees that this function accepts multiples of
/// 90 degrees. If a value is within the [0, 360] range but not a
/// multiple of 90 degrees, this function may return
/// `DeviceConfigError::Invalid` if the underlying device or
/// implementation does not support finer-grained rotation angles.
///
/// The rotation angle is applied to all motion events emitted by
/// the device. Thus, rotating the device also changes the angle
/// required or presented by scrolling, gestures, etc.
///
/// Setting a rotation of 0 degrees on a device that does not
/// support rotation always succeeds.
pub fn config_rotation_set_angle(&self, angle: u32) -> DeviceConfigResult {
match unsafe { ffi::libinput_device_config_rotation_set_angle(self.as_raw_mut(), angle) } {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
ffi_func!(
/// Get the button for the `ScrollMethod::OnButtonDown` method
/// for this device.
///
/// If `ScrollMethod::OnButtonDown` scroll method is not
/// supported, or no button is set, this function returns 0.
///
/// ## Note
///
/// The return value is independent of the currently selected
/// scroll-method. For button scrolling to activate, a device
/// must have the `ScrollMethod::OnButtonDown` method enabled,
/// and a non-zero button set as scroll button.
pub fn config_scroll_button, ffi::libinput_device_config_scroll_get_button, u32);
ffi_func!(
/// Get the default button for the `ScrollMethod::OnButtonDown`
/// method for this device.
///
/// If `ScrollMethod::OnButtonDown` scroll method is not
/// supported, or no default button is set,
/// this function returns 0.
pub fn config_scroll_default_button, ffi::libinput_device_config_scroll_get_default_button, u32);
/// Get the default scroll method for this device.
///
/// The method defines when to generate scroll axis events
/// instead of pointer motion events.
///
/// A return value of `None` means the scroll method is not known
pub fn config_scroll_default_method(&self) -> Option<ScrollMethod> {
match unsafe { ffi::libinput_device_config_scroll_get_default_method(self.as_raw_mut()) } {
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_NO_SCROLL => {
Some(ScrollMethod::NoScroll)
}
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_2FG => {
Some(ScrollMethod::TwoFinger)
}
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_EDGE => {
Some(ScrollMethod::Edge)
}
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_ON_BUTTON_DOWN => {
Some(ScrollMethod::OnButtonDown)
}
_x => {
#[cfg(feature = "log")]
log::warn!(
"Unknown ScrollMethod ({}). Unsupported libinput version?",
_x
);
None
}
}
}
/// Get the scroll method for this device.
///
/// The method defines when to generate scroll axis events
/// instead of pointer motion events.
///
/// A return value of `None` means the scroll method is not known
pub fn config_scroll_method(&self) -> Option<ScrollMethod> {
match unsafe { ffi::libinput_device_config_scroll_get_method(self.as_raw_mut()) } {
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_NO_SCROLL => {
Some(ScrollMethod::NoScroll)
}
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_2FG => {
Some(ScrollMethod::TwoFinger)
}
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_EDGE => {
Some(ScrollMethod::Edge)
}
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_ON_BUTTON_DOWN => {
Some(ScrollMethod::OnButtonDown)
}
_ => panic!("libinput returned invalid 'libinput_config_scroll_method'"),
}
}
/// Check which scroll methods a device supports.
///
/// The method defines when to generate scroll axis events
/// instead of pointer motion events.
pub fn config_scroll_methods(&self) -> Vec<ScrollMethod> {
let mut methods = Vec::new();
let bitmask = unsafe { ffi::libinput_device_config_scroll_get_methods(self.as_raw_mut()) };
if bitmask & ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_NO_SCROLL as u32
== bitmask
{
methods.push(ScrollMethod::NoScroll);
}
if bitmask & ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_2FG as u32 == bitmask
{
methods.push(ScrollMethod::TwoFinger);
}
if bitmask & ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_EDGE as u32
== bitmask
{
methods.push(ScrollMethod::Edge);
}
if bitmask & ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_ON_BUTTON_DOWN as u32
== bitmask
{
methods.push(ScrollMethod::OnButtonDown);
}
methods
}
/// Set the scroll method for this device.
///
/// The method defines when to generate scroll axis events
/// instead of pointer motion events.
///
/// ## Note
///
/// Setting `ScrollMethod::OnButtonDown` enables the scroll
/// method, but scrolling is only activated when the configured
/// button is held down. If no button is set, i.e.
/// `config_scroll_button` returns 0, scrolling cannot activate.
pub fn config_scroll_set_method(&mut self, method: ScrollMethod) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_scroll_set_method(
self.as_raw_mut(),
match method {
ScrollMethod::NoScroll => {
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_NO_SCROLL
}
ScrollMethod::TwoFinger => {
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_2FG
}
ScrollMethod::Edge => {
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_EDGE
}
ScrollMethod::OnButtonDown => {
ffi::libinput_config_scroll_method_LIBINPUT_CONFIG_SCROLL_ON_BUTTON_DOWN
}
},
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
ffi_func!(
/// Get the default mode for scrolling on this device.
pub fn config_scroll_default_natural_scroll_enabled, ffi::libinput_device_config_scroll_get_default_natural_scroll_enabled, bool);
ffi_func!(
/// Get the current mode for scrolling on this device.
pub fn config_scroll_natural_scroll_enabled, ffi::libinput_device_config_scroll_get_natural_scroll_enabled, bool);
ffi_func!(
/// Return non-zero if the device supports "natural scrolling".
///
/// In traditional scroll mode, the movement of fingers on a
/// touchpad when scrolling matches the movement of the scroll
/// bars. When the fingers move down, the scroll bar moves down,
/// a line of text on the screen moves towards the upper end of
/// the screen. This also matches scroll wheels on mice (wheel
/// down, content moves up).
///
/// Natural scrolling is the term coined by Apple for inverted
/// scrolling. In this mode, the effect of scrolling movement of
/// fingers on a touchpad resemble physical manipulation of
/// paper. When the fingers move down, a line of text on the
/// screen moves down (scrollbars move up). This is the opposite
/// of scroll wheels on mice.
///
/// A device supporting natural scrolling can be switched between
/// traditional scroll mode and natural scroll mode.
pub fn config_scroll_has_natural_scroll, ffi::libinput_device_config_scroll_has_natural_scroll, bool);
/// Enable or disable natural scrolling on the device.
pub fn config_scroll_set_natural_scroll_enabled(
&mut self,
enabled: bool,
) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_scroll_set_natural_scroll_enabled(
self.as_raw_mut(),
enabled as i32,
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Set the button for the `ScrollMethod::OnButtonDown` method
/// for this device.
///
/// When the current scroll method is set to
/// `ScrollMethod::OnButtonDown`, no button press/release events
/// will be send for the configured button.
///
/// When the configured button is pressed, any motion events
/// along a scroll-capable axis are turned into scroll axis
/// events.
///
/// ## Note
///
/// Setting the button does not change the scroll method. To
/// change the scroll method call `config_scroll_set_method`.
/// If the button is 0, button scrolling is effectively disabled.
pub fn config_scroll_set_button(&mut self, button: u32) -> DeviceConfigResult {
match unsafe { ffi::libinput_device_config_scroll_set_button(self.as_raw_mut(), button) } {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Get the current scroll button lock state
///
/// If `ScrollMethod::OnButtonDown` is not supported, or no button is set,
/// this functions returns `Disabled`.
///
/// ## Note
///
/// The return value is independent of the currently selected scroll-method.
/// For the scroll button lock to activate, a device must have the
/// `ScrollMethod::OnButtonDown` enabled, and a non-zero button set as scroll button.
#[cfg(feature = "libinput_1_15")]
pub fn config_scroll_button_lock(&self) -> ScrollButtonLockState {
match unsafe { ffi::libinput_device_config_scroll_get_button_lock(self.as_raw() as *mut _) } {
ffi::libinput_config_scroll_button_lock_state_LIBINPUT_CONFIG_SCROLL_BUTTON_LOCK_DISABLED => ScrollButtonLockState::Disabled,
ffi::libinput_config_scroll_button_lock_state_LIBINPUT_CONFIG_SCROLL_BUTTON_LOCK_ENABLED => ScrollButtonLockState::Enabled,
_ => panic!("libinput returned invalid libinput_config_scroll_button_lock_state"),
}
}
/// Get the default scroll button lock state
///
/// If `ScrollMethod::OnButtonDown` is not supported, or no button is set,
/// this functions returns `Disabled`.
#[cfg(feature = "libinput_1_15")]
pub fn config_scroll_default_button_lock(&self) -> ScrollButtonLockState {
match unsafe { ffi::libinput_device_config_scroll_get_default_button_lock(self.as_raw() as *mut _) } {
ffi::libinput_config_scroll_button_lock_state_LIBINPUT_CONFIG_SCROLL_BUTTON_LOCK_DISABLED => ScrollButtonLockState::Disabled,
ffi::libinput_config_scroll_button_lock_state_LIBINPUT_CONFIG_SCROLL_BUTTON_LOCK_ENABLED => ScrollButtonLockState::Enabled,
_ => panic!("libinput returned invalid libinput_config_scroll_button_lock_state"),
}
}
/// Set the scroll button lock.
///
/// If the state is `Disabled` the button must physically be held down for
/// button scrolling to work. If the state is `Enabled`, the button is considered
/// logically down after the first press and release sequence, and logically
/// up after the second press and release sequence.
#[cfg(feature = "libinput_1_15")]
pub fn config_scroll_set_button_lock(
&mut self,
state: ScrollButtonLockState,
) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_scroll_set_button_lock(self.as_raw_mut(),
match state {
ScrollButtonLockState::Enabled => ffi::libinput_config_scroll_button_lock_state_LIBINPUT_CONFIG_SCROLL_BUTTON_LOCK_ENABLED,
ScrollButtonLockState::Disabled => ffi::libinput_config_scroll_button_lock_state_LIBINPUT_CONFIG_SCROLL_BUTTON_LOCK_DISABLED,
}
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Get the send-event mode for this device.
///
/// The mode defines when the device processes and sends events
/// to the caller.
///
/// If a caller enables the bits for multiple modes, some of
/// which are subsets of another mode libinput may drop the bits
/// that are subsets. In other words, don't expect
/// `config_send_events_mode` to always return exactly the same
/// as passed into `config_send_events_set_mode`.
pub fn config_send_events_mode(&self) -> SendEventsMode {
SendEventsMode::from_bits_truncate(unsafe {
ffi::libinput_device_config_send_events_get_mode(self.as_raw_mut())
})
}
/// Return the possible send-event modes for this device.
///
/// These modes define when a device may process and send events.
pub fn config_send_events_modes(&self) -> SendEventsMode {
SendEventsMode::from_bits_truncate(unsafe {
ffi::libinput_device_config_send_events_get_modes(self.as_raw_mut())
})
}
/// Set the send-event mode for this device.
///
/// The mode defines when the device processes and sends events
/// to the caller.
///
/// The selected mode may not take effect immediately. Events
/// already received and processed from this device are
/// unaffected and will be passed to the caller on the next call
/// to `<Libinput as Iterator>::next()`.
///
/// If the mode is a mixture of `SendEventsMode`s, the device may
/// wait for or generate events until it is in a neutral state.
/// For example, this may include waiting for or generating
/// button release events.
///
/// If the device is already suspended, this function does
/// nothing and returns success. Changing the send-event mode on
/// a device that has been removed is permitted.
pub fn config_send_events_set_mode(&self, mode: SendEventsMode) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_send_events_set_mode(self.as_raw_mut(), mode.bits())
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Get the finger number to button number mapping for
/// tap-to-click.
///
/// The return value for a device that does not support tapping
/// is always `TapButtonMap::LeftRightMiddle`.
///
/// This will return `None` for devices
/// where `config_tap_finger_count` returns 0.
pub fn config_tap_button_map(&self) -> Option<TapButtonMap> {
if self.config_tap_finger_count() == 0 {
None
} else {
match unsafe { ffi::libinput_device_config_tap_get_button_map(self.as_raw_mut()) } {
ffi::libinput_config_tap_button_map_LIBINPUT_CONFIG_TAP_MAP_LRM => {
Some(TapButtonMap::LeftRightMiddle)
}
ffi::libinput_config_tap_button_map_LIBINPUT_CONFIG_TAP_MAP_LMR => {
Some(TapButtonMap::LeftMiddleRight)
}
_ => panic!("libinput returned invalid 'libinput_config_tap_button_map'"),
}
}
}
/// Get the default finger number to button number mapping for
/// tap-to-click.
///
/// The return value for a device that does not support tapping
/// is always `TapButtonMap::LeftRightMiddle`.
///
/// This will return `None` for devices
/// where `config_tap_finger_count` returns 0.
pub fn config_tap_default_button_map(&self) -> Option<TapButtonMap> {
if self.config_tap_finger_count() == 0 {
None
} else {
match unsafe {
ffi::libinput_device_config_tap_get_default_button_map(self.as_raw_mut())
} {
ffi::libinput_config_tap_button_map_LIBINPUT_CONFIG_TAP_MAP_LRM => {
Some(TapButtonMap::LeftRightMiddle)
}
ffi::libinput_config_tap_button_map_LIBINPUT_CONFIG_TAP_MAP_LMR => {
Some(TapButtonMap::LeftMiddleRight)
}
_ => panic!("libinput returned invalid 'libinput_config_tap_button_map'"),
}
}
}
/// Return whether tap-and-drag is enabled or disabled by default
/// on this device.
pub fn config_tap_default_drag_enabled(&self) -> bool {
match unsafe { ffi::libinput_device_config_tap_get_default_drag_enabled(self.as_raw_mut()) }
{
ffi::libinput_config_drag_state_LIBINPUT_CONFIG_DRAG_ENABLED => true,
ffi::libinput_config_drag_state_LIBINPUT_CONFIG_DRAG_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_drag_state'"),
}
}
/// Check if drag-lock during tapping is enabled by default on
/// this device.
///
/// If the device does not support tapping, this function always
/// returns `false`.
///
/// Drag lock may be enabled by default even when tapping is
/// disabled by default.
pub fn config_tap_default_drag_lock_enabled(&self) -> bool {
match unsafe {
ffi::libinput_device_config_tap_get_default_drag_lock_enabled(self.as_raw_mut())
} {
ffi::libinput_config_drag_lock_state_LIBINPUT_CONFIG_DRAG_LOCK_ENABLED => true,
ffi::libinput_config_drag_lock_state_LIBINPUT_CONFIG_DRAG_LOCK_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_drag_lock_state'"),
}
}
/// Return the default setting for whether tap-to-click is
/// enabled on this device.
pub fn config_tap_default_enabled(&self) -> bool {
match unsafe { ffi::libinput_device_config_tap_get_default_enabled(self.as_raw_mut()) } {
ffi::libinput_config_tap_state_LIBINPUT_CONFIG_TAP_ENABLED => true,
ffi::libinput_config_tap_state_LIBINPUT_CONFIG_TAP_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_tap_state'"),
}
}
/// Return whether tap-and-drag is enabled or disabled on this
/// device.
pub fn config_tap_drag_enabled(&self) -> bool {
match unsafe { ffi::libinput_device_config_tap_get_drag_enabled(self.as_raw_mut()) } {
ffi::libinput_config_drag_state_LIBINPUT_CONFIG_DRAG_ENABLED => true,
ffi::libinput_config_drag_state_LIBINPUT_CONFIG_DRAG_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_drag_state'"),
}
}
/// Check if drag-lock during tapping is enabled on this device.
///
/// If the device does not support tapping, this function always
/// returns `false`.
///
/// Drag lock may be enabled even when tapping is disabled.
pub fn config_tap_drag_lock_enabled(&self) -> bool {
match unsafe { ffi::libinput_device_config_tap_get_drag_lock_enabled(self.as_raw_mut()) } {
ffi::libinput_config_drag_lock_state_LIBINPUT_CONFIG_DRAG_LOCK_ENABLED => true,
ffi::libinput_config_drag_lock_state_LIBINPUT_CONFIG_DRAG_LOCK_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_drag_lock_state'"),
}
}
/// Check if tap-to-click is enabled on this device.
///
/// If the device does not support tapping, this function always
/// returns `false`.
pub fn config_tap_enabled(&self) -> bool {
match unsafe { ffi::libinput_device_config_tap_get_enabled(self.as_raw_mut()) } {
ffi::libinput_config_tap_state_LIBINPUT_CONFIG_TAP_ENABLED => true,
ffi::libinput_config_tap_state_LIBINPUT_CONFIG_TAP_DISABLED => false,
_ => panic!("libinput returned invalid 'libinput_config_tap_state'"),
}
}
ffi_func!(
/// Check if the device supports tap-to-click and how many
/// fingers can be used for tapping.
///
/// See `config_tap_set_enabled` for more information.
pub fn config_tap_finger_count, ffi::libinput_device_config_tap_get_finger_count, u32);
/// Set the finger number to button number mapping for
/// tap-to-click.
///
/// The default mapping on most devices is to have a 1, 2 and 3
/// finger tap to map to the left, right and middle button,
/// respectively. A device may permit changing the button mapping
/// but disallow specific maps. In this case
/// `DeviceConfigError::Disabled` is returned, the caller is
/// expected to handle this case correctly.
///
/// Changing the button mapping may not take effect immediately,
/// the device may wait until it is in a neutral state before
/// applying any changes.
///
/// The mapping may be changed when tap-to-click is disabled. The
/// new mapping takes effect when tap-to-click is enabled in the
/// future.
///
/// ## Note
///
/// This will return `None` for devices where
/// `config_tap_finger_count` returns 0.
pub fn config_tap_set_button_map(&mut self, map: TapButtonMap) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_tap_set_button_map(
self.as_raw_mut(),
match map {
TapButtonMap::LeftRightMiddle => {
ffi::libinput_config_tap_button_map_LIBINPUT_CONFIG_TAP_MAP_LRM
}
TapButtonMap::LeftMiddleRight => {
ffi::libinput_config_tap_button_map_LIBINPUT_CONFIG_TAP_MAP_LMR
}
},
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Enable or disable tap-and-drag on this device.
///
/// When enabled, a single-finger tap immediately followed by a
/// finger down results in a button down event, subsequent finger
/// motion thus triggers a drag. The button is released on finger
/// up.
/// See [Tap-and-drag](https://wayland.freedesktop.org/libinput/doc/latest/tapping.html#tapndrag)
/// for more details.
pub fn config_tap_set_drag_enabled(&mut self, enabled: bool) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_tap_set_drag_enabled(
self.as_raw_mut(),
if enabled {
ffi::libinput_config_drag_state_LIBINPUT_CONFIG_DRAG_ENABLED
} else {
ffi::libinput_config_drag_state_LIBINPUT_CONFIG_DRAG_DISABLED
},
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Enable or disable drag-lock during tapping on this device.
///
/// When enabled, a finger may be lifted and put back on the
/// touchpad within a timeout and the drag process continues.
/// When disabled, lifting the finger during a tap-and-drag will
/// immediately stop the drag.
/// See [Tap-and-drag](https://wayland.freedesktop.org/libinput/doc/latest/tapping.html#tapndrag)
/// for details.
///
/// Enabling drag lock on a device that has tapping disabled is
/// permitted, but has no effect until tapping is enabled.
pub fn config_tap_set_drag_lock_enabled(&mut self, enabled: bool) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_tap_set_drag_lock_enabled(
self.as_raw_mut(),
if enabled {
ffi::libinput_config_drag_lock_state_LIBINPUT_CONFIG_DRAG_LOCK_ENABLED
} else {
ffi::libinput_config_drag_lock_state_LIBINPUT_CONFIG_DRAG_LOCK_DISABLED
},
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
/// Enable or disable tap-to-click on this device, with a default
/// mapping of 1, 2, 3 finger tap mapping to left, right, middle
/// click, respectively.
///
/// Tapping is limited by the number of simultaneous touches
/// supported by the device, see `config_tap_finger_count`.
pub fn config_tap_set_enabled(&mut self, enabled: bool) -> DeviceConfigResult {
match unsafe {
ffi::libinput_device_config_tap_set_enabled(
self.as_raw_mut(),
if enabled {
ffi::libinput_config_tap_state_LIBINPUT_CONFIG_TAP_ENABLED
} else {
ffi::libinput_config_tap_state_LIBINPUT_CONFIG_TAP_DISABLED
},
)
} {
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_SUCCESS => Ok(()),
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_UNSUPPORTED => {
Err(DeviceConfigError::Unsupported)
}
ffi::libinput_config_status_LIBINPUT_CONFIG_STATUS_INVALID => {
Err(DeviceConfigError::Invalid)
}
_ => panic!("libinput returned invalid 'libinput_config_status'"),
}
}
}