From 3b0f1d767a218f80acc982463f48cf39fa0f064e Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Thu, 28 Sep 2017 08:57:37 +1000 Subject: [PATCH] doc: add a section for tablet mode switches Signed-off-by: Peter Hutterer --- doc/switches.dox | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/switches.dox b/doc/switches.dox index 5153dc2e..3c2b1585 100644 --- a/doc/switches.dox +++ b/doc/switches.dox @@ -31,4 +31,20 @@ state and the lid state may report as closed even when the lid is physicall open. libinput employs some heuristics to detect user input (specificially typing) to re-enable the touchpad on those devices. +@section switches_tablet_mode Tablet mode switch handling + +Where available, libinput listens to devices providing a tablet mode switch. +This switch is usually triggered on devices that can switch between a normal +laptop layout and a tablet-like layout. One example for such a device is the +Lenovo Yoga. + +The event sent by the kernel is `EV_SW` `SW_TABLET_MODE` and is provided as +@ref LIBINPUT_SWITCH_TABLET_MODE. When the device switches to tablet mode, +the touchpad and internal keyboard are disabled. If a trackpoint exists, +it is disabled too. The input devices are automatically re-enabled whenever +tablet mode is disengaged. + +This handling of tablet mode switches is transparent to the user, no +notifications are sent and the device appears as enabled at all times. + */