[gtk+/wip/garnacho/touchpad-gestures: 103/105] gtkgesture: Add note to gtk_gesture_get_bounding_box()

[Carlos Garnacho <carlosg src gnome org>]

commit 54370d3313dae211a5782d0179768790a89a6b42
Author: Carlos Garnacho <carlosg gnome org>
Date:   Fri Jul 24 12:59:59 2015 +0200

    gtkgesture: Add note to gtk_gesture_get_bounding_box()
    
    This is the only function that's will be semantically confusing
    with touchpad gesture events, explain what's to be expected there.

 gtk/gtkgesture.c |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkgesture.c b/gtk/gtkgesture.c
index 03733a3..f3556de 100644
--- a/gtk/gtkgesture.c
+++ b/gtk/gtkgesture.c
@@ -1352,6 +1352,12 @@ _gtk_gesture_get_last_update_time (GtkGesture       *gesture,
  * box containing all active touches. Otherwise, %FALSE will be
  * returned.
  *
+ * Note: This function will yield unexpected results on touchpad
+ * gestures. Since there is no correlation between physical and
+ * pixel distances, these will look as if constrained in an
+ * infinitely small area, @rect width and height will thus be 0
+ * regardless of the number of touchpoints.
+ *
  * Returns: %TRUE if there are active touches, %FALSE otherwise
  *
  * Since: 3.14