From: Peter Hutterer Date: Thu, 28 May 2015 00:46:02 +0000 (+1000) Subject: doc: add illustrations for clickfinger and software button behavior X-Git-Tag: upstream/0.15.0+92+gec468e8~7 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=182290c1548cf2f7d4bb7c26d19ed2ff8fd2af4d;p=platform%2Fupstream%2Flibinput.git doc: add illustrations for clickfinger and software button behavior Signed-off-by: Peter Hutterer --- diff --git a/doc/Makefile.am b/doc/Makefile.am index 3d81d7ce..ed2f72fd 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -24,9 +24,12 @@ header_files = \ diagram_files = \ $(srcdir)/dot/seats-sketch.gv \ $(srcdir)/dot/seats-sketch-libinput.gv \ + $(srcdir)/svg/software-buttons.svg \ + $(srcdir)/svg/clickfinger.svg \ $(srcdir)/svg/button-scrolling.svg \ $(srcdir)/svg/edge-scrolling.svg \ $(srcdir)/svg/palm-detection.svg \ + $(srcdir)/svg/top-software-buttons.svg \ $(srcdir)/svg/twofinger-scrolling.svg html/index.html: libinput.doxygen $(header_files) $(diagram_files) diff --git a/doc/clickpad-softbuttons.dox b/doc/clickpad-softbuttons.dox index 8d919369..e7c4e543 100644 --- a/doc/clickpad-softbuttons.dox +++ b/doc/clickpad-softbuttons.dox @@ -24,15 +24,6 @@ is split in the middle to generate left or right button events on click. The height of the button area depends on the hardware but is usually around 10mm. -@dot -digraph G { - clickpad [ - shape = "record"; - label = "{\nMain\nArea\n\n|{LEFT|RIGHT}}"; - ] -} -@enddot - Left, right and middle button events can be triggered as follows: - if a finger is in the main area or the left button area, a click generates left button events. @@ -40,6 +31,8 @@ Left, right and middle button events can be triggered as follows: - if there is a finger in both the left and right button area, a click generates middle button events. +@image html software-buttons.svg "Left, right and middle-button click with software button areas" + If fingers are down in the main area in addition to fingers in the left or right button area, those fingers are are ignored. A release event always releases the buttons logically down, regardless of @@ -69,6 +62,8 @@ three fingers are held down on the touchpad when a physical click is generated. The location of the fingers does not matter and there are no software-defined button areas. +@image html clickfinger.svg "One, two and three-finger click with Clickfinger behavior" + The Xorg synaptics driver uses 30% of the touchpad dimensions as threshold, libinput does not have this restriction. If two fingers are on the pad while clicking, that is a two-finger click. diff --git a/doc/svg/clickfinger.svg b/doc/svg/clickfinger.svg new file mode 100644 index 00000000..b92dcb44 --- /dev/null +++ b/doc/svg/clickfinger.svg @@ -0,0 +1,207 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/svg/software-buttons.svg b/doc/svg/software-buttons.svg new file mode 100644 index 00000000..903535c8 --- /dev/null +++ b/doc/svg/software-buttons.svg @@ -0,0 +1,175 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/svg/top-software-buttons.svg b/doc/svg/top-software-buttons.svg new file mode 100644 index 00000000..ab311240 --- /dev/null +++ b/doc/svg/top-software-buttons.svg @@ -0,0 +1,213 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/t440-support.dox b/doc/t440-support.dox index 277dbe8e..8e2f9c23 100644 --- a/doc/t440-support.dox +++ b/doc/t440-support.dox @@ -11,21 +11,10 @@ laptops had a separate set of physical buttons for the trackstick. This series removed these buttons, relying on a software emulation of the top section of the touchpad. This is visually marked on the trackpad itself, -approximately like this: - -@dot -digraph G { - subgraph cluster_0 { - margin="0"; - - clickpad [ - shape = "record"; - color = "none"; - label = "{{LLLLLLLLLL|MMMMM|RRRRRRRRR}|\n\n\n\n\n\n\n\n|{LLLLLLLL| |RRRRRRRR}}"; - ] - } -} -@enddot +and clicks can be triggered by pressing the touchpad down with a finger in +the respective area: + +@image html top-software-buttons.svg "Left, right and middle-button click with top software button areas" This page only covers the top software buttons, the bottom button behavior is covered in @ref clickpad_softbuttons "Clickpad software buttons".