diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2017-01-24 14:58:17 +1000 |
|---|---|---|
| committer | Peter Hutterer <peter.hutterer@who-t.net> | 2017-01-26 14:44:04 +1000 |
| commit | e2877acb89edcba93e3567e86082a1247e179008 (patch) | |
| tree | 5339c4b329a1a05faff61e8a4228c7d880c8bdfe /src/libinput.h | |
| parent | 87f3ea760c7375b464ec10a295f9e3a3ae56386c (diff) | |
Clarify the default 'off' position of a switch
So we don't need to send an "off" event for every switch on startup.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'src/libinput.h')
| -rw-r--r-- | src/libinput.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/libinput.h b/src/libinput.h index f8b123a4..436923d4 100644 --- a/src/libinput.h +++ b/src/libinput.h @@ -601,7 +601,11 @@ libinput_tablet_pad_mode_group_get_user_data( /** * @ingroup device * - * The state of a switch. + * The state of a switch. The default state of a switch is @ref + * LIBINPUT_SWITCH_STATE_OFF and no event is sent to confirm a switch in the + * off position. If a switch is logically on during initialization, libinput + * sends an event of type @ref LIBINPUT_EVENT_SWITCH_TOGGLE with a state + * @ref LIBINPUT_SWITCH_STATE_ON. */ enum libinput_switch_state { LIBINPUT_SWITCH_STATE_OFF = 0, |