diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2017-02-01 13:56:32 +1000 |
|---|---|---|
| committer | Peter Hutterer <peter.hutterer@who-t.net> | 2017-02-01 13:56:32 +1000 |
| commit | 45d7794de2fb8c24fddd5cd91d946900e4bb4495 (patch) | |
| tree | de9a11a38388b5910f4c8b58689af86c584e02db /doc | |
| parent | 65c4b27260589dc5b70ff04398db337af9cda8a9 (diff) | |
| parent | 2dc6534ec0bc0b42dd2437ccfaa1eed04e98dcb2 (diff) | |
Merge branch 'wip/switch-interface'
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 1 | ||||
| -rw-r--r-- | doc/switches.dox | 16 |
2 files changed, 17 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 698a316..a92d791 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -22,6 +22,7 @@ header_files = \ $(srcdir)/reporting-bugs.dox \ $(srcdir)/scrolling.dox \ $(srcdir)/seats.dox \ + $(srcdir)/switches.dox \ $(srcdir)/t440-support.dox \ $(srcdir)/tablet-support.dox \ $(srcdir)/tapping.dox \ diff --git a/doc/switches.dox b/doc/switches.dox new file mode 100644 index 0000000..4bb2675 --- /dev/null +++ b/doc/switches.dox @@ -0,0 +1,16 @@ +/** +@page switches Switches + +libinput supports a couple of switches. Unlike button events that come in +press and release pairs, switches are usually toggled once and left at the +setting for an extended period of time. + +Only some switches are handled by libinput, see @ref libinput_switch for a +list of supported switches. Switch events are exposed to the caller, but +libinput may handle some switch events internally and enable or disable +specific features based on a switch state. + +The order of switch events is guaranteed to be correct, i.e., a switch will +never send consecutive switch on, or switch off, events. + +*/ |