From c5b87828ee4641b4a3cd7db8d1b86432283873c7 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Tue, 5 Jan 2016 13:33:51 +1000 Subject: [PATCH] doc: add missing tip event to the allowed set of events We can call the various has_changed() functions on a tip event. Signed-off-by: Peter Hutterer --- doc/tablet-support.dox | 4 +-- src/libinput.h | 56 ++++++++++++++++++++++++++++-------------- 2 files changed, 40 insertions(+), 20 deletions(-) diff --git a/doc/tablet-support.dox b/doc/tablet-support.dox index 90c2e098..c95d8052 100644 --- a/doc/tablet-support.dox +++ b/doc/tablet-support.dox @@ -66,8 +66,8 @@ used in relative mode, lying flat on the tablet. Movement typically follows the interaction normal mouse movements have, i.e. slightly lift the tool and place it in a separate location. The proximity detection on Wacom tablets however extends further than the user may lift the mouse, i.e. the -tool may not be lifted out of physical proximity. For such tools, libinput -provides software-emulated proximity. +tool may not be lifted out of physical proximity. For such tools, libinput +provides software-emulated proximity. @section tablet-pressure-offset Pressure offset on worn-out tools diff --git a/src/libinput.h b/src/libinput.h index f1142340..e29b01a6 100644 --- a/src/libinput.h +++ b/src/libinput.h @@ -1348,8 +1348,10 @@ libinput_event_tablet_tool_get_base_event(struct libinput_event_tablet_tool *eve * LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref LIBINPUT_EVENT_TABLET_TOOL_TIP, or * @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this function returns 0. * - * @note It is an application bug to call this function for events other than - * @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS and @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. + * @note It is an application bug to call this function for events other + * than @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref + * LIBINPUT_EVENT_TABLET_TOOL_TIP, or @ref + * LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. * * @param event The libinput tablet event * @return 1 if the axis was updated or 0 otherwise @@ -1366,8 +1368,10 @@ libinput_event_tablet_tool_x_has_changed( * LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref LIBINPUT_EVENT_TABLET_TOOL_TIP, or * @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this function returns 0. * - * @note It is an application bug to call this function for events other than - * @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS and @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. + * @note It is an application bug to call this function for events other + * than @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref + * LIBINPUT_EVENT_TABLET_TOOL_TIP, or @ref + * LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. * * @param event The libinput tablet event * @return 1 if the axis was updated or 0 otherwise @@ -1384,8 +1388,10 @@ libinput_event_tablet_tool_y_has_changed( * LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref LIBINPUT_EVENT_TABLET_TOOL_TIP, or * @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this function returns 0. * - * @note It is an application bug to call this function for events other than - * @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS and @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. + * @note It is an application bug to call this function for events other + * than @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref + * LIBINPUT_EVENT_TABLET_TOOL_TIP, or @ref + * LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. * * @param event The libinput tablet event * @return 1 if the axis was updated or 0 otherwise @@ -1401,9 +1407,13 @@ libinput_event_tablet_tool_pressure_has_changed( * For tablet events that are not of type @ref * LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref LIBINPUT_EVENT_TABLET_TOOL_TIP, or * @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this function returns 0. + * For tablet events of type @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this + * function always returns 1. * - * @note It is an application bug to call this function for events other than - * @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS and @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. + * @note It is an application bug to call this function for events other + * than @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref + * LIBINPUT_EVENT_TABLET_TOOL_TIP, or @ref + * LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. * * @param event The libinput tablet event * @return 1 if the axis was updated or 0 otherwise @@ -1420,8 +1430,10 @@ libinput_event_tablet_tool_distance_has_changed( * LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref LIBINPUT_EVENT_TABLET_TOOL_TIP, or * @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this function returns 0. * - * @note It is an application bug to call this function for events other than - * @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS and @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. + * @note It is an application bug to call this function for events other + * than @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref + * LIBINPUT_EVENT_TABLET_TOOL_TIP, or @ref + * LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. * * @param event The libinput tablet event * @return 1 if the axis was updated or 0 otherwise @@ -1438,8 +1450,10 @@ libinput_event_tablet_tool_tilt_x_has_changed( * LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref LIBINPUT_EVENT_TABLET_TOOL_TIP, or * @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this function returns 0. * - * @note It is an application bug to call this function for events other than - * @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS and @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. + * @note It is an application bug to call this function for events other + * than @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref + * LIBINPUT_EVENT_TABLET_TOOL_TIP, or @ref + * LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. * * @param event The libinput tablet event * @return 1 if the axis was updated or 0 otherwise @@ -1455,8 +1469,10 @@ libinput_event_tablet_tool_tilt_y_has_changed( * LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref LIBINPUT_EVENT_TABLET_TOOL_TIP, or * @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this function returns 0. * - * @note It is an application bug to call this function for events other than - * @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS and @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. + * @note It is an application bug to call this function for events other + * than @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref + * LIBINPUT_EVENT_TABLET_TOOL_TIP, or @ref + * LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. * * @param event The libinput tablet event * @return 1 if the axis was updated or 0 otherwise @@ -1472,8 +1488,10 @@ libinput_event_tablet_tool_rotation_has_changed( * LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref LIBINPUT_EVENT_TABLET_TOOL_TIP, or * @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this function returns 0. * - * @note It is an application bug to call this function for events other than - * @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS and @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. + * @note It is an application bug to call this function for events other + * than @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref + * LIBINPUT_EVENT_TABLET_TOOL_TIP, or @ref + * LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. * * @param event The libinput tablet event * @return 1 if the axis was updated or 0 otherwise @@ -1489,8 +1507,10 @@ libinput_event_tablet_tool_slider_has_changed( * LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref LIBINPUT_EVENT_TABLET_TOOL_TIP, or * @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY, this function returns 0. * - * @note It is an application bug to call this function for events other than - * @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS and @ref LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. + * @note It is an application bug to call this function for events other + * than @ref LIBINPUT_EVENT_TABLET_TOOL_AXIS, @ref + * LIBINPUT_EVENT_TABLET_TOOL_TIP, or @ref + * LIBINPUT_EVENT_TABLET_TOOL_PROXIMITY. * * @param event The libinput tablet event * @return 1 if the axis was updated or 0 otherwise