atspi: enhance elm_atspi_gesture_cb_set document

Change-Id: Ib6ff7016389bf9b6252c517c2565839e5f5943d1

diff --git a/src/lib/elm_interface_atspi_accessible.eo b/src/lib/elm_interface_atspi_accessible.eo
index 313985b..c40c652 100644 (file)
--- a/src/lib/elm_interface_atspi_accessible.eo
+++ b/src/lib/elm_interface_atspi_accessible.eo
@@ -232,6 +232,10 @@ mixin Elm_Interface_Atspi_Accessible ()
          set {
             [[Sets gesture callback to give widget.
 
+              Warning: Please do not abuse this API. The purpose of this API is
+              to support special application such as screen-reader guidance.
+              Before using this API, please check if there is another way.
+
               \@if MOBILE \@since_tizen 4.0
               \@elseif WEARABLE \@since_tizen 3.0
               \@endif

diff --git a/src/lib/elm_interface_atspi_accessible.h b/src/lib/elm_interface_atspi_accessible.h
index 94d9f26..2d4ca4c 100644 (file)
--- a/src/lib/elm_interface_atspi_accessible.h
+++ b/src/lib/elm_interface_atspi_accessible.h
@@ -74,6 +74,16 @@ enum _Elm_Atspi_Gesture_Type
 };
 /**
  * Type of gesture that is emitted on assistive technology client side.
+ *
+ * @warning do not use ELM_ATSPI_GESTURE_TWO_FINGERS_FLICK_*, and
+ * ELM_ATSPI_GESTURE_TWO_FINGERS_HOVER. These gestures are not emitted on
+ * assistive technology client side. The window manager emits mouse event
+ * directly. So if you need to check these gestures, you have to handle mouse
+ * events. If you want to make highlighted object to get mouse events directly,
+ * then please use elm_atspi_accessible_attribute_append as below.
+ *
+ * elm_atspi_accessible_attribute_append(obj, "gesture_required", "scroll");
+ *
  * @if MOBILE @since_tizen 4.0 @elseif WEARABLE @since_tizen 3.0 @endif
  */
 typedef enum _Elm_Atspi_Gesture_Type Elm_Atspi_Gesture_Type;