summaryrefslogtreecommitdiff
path: root/doc/switches.dox
blob: 4bb267573fb4533b7fcbf6bcac451a8aba1bc58e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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.

*/