(Events) Cleaned up documentation

Change-Id: Ied26dfde72b9124c40489f67230235938db634ec
Signed-off-by: Adeel Kazmi <adeel.kazmi@samsung.com>

diff --git a/capi/dali/public-api/events/long-press-gesture-detector.h b/capi/dali/public-api/events/long-press-gesture-detector.h
index f0d65d8..e7cdfab 100644 (file)
--- a/capi/dali/public-api/events/long-press-gesture-detector.h
+++ b/capi/dali/public-api/events/long-press-gesture-detector.h
@@ -49,7 +49,7 @@ struct LongPressGesture;
  * @code
  * LongPressGestureDetector detector = LongPressGestureDetector::New();
  * detector.Attach(myActor);
- * detector.SignalDetected().Connect(this, &MyApplication::OnLongPress);
+ * detector.DetectedSignal().Connect(this, &MyApplication::OnLongPress);
  * @endcode
  *
  * @see LongPressGesture

diff --git a/capi/dali/public-api/events/pan-gesture-detector.h b/capi/dali/public-api/events/pan-gesture-detector.h
index 4596625..f9786f8 100644 (file)
--- a/capi/dali/public-api/events/pan-gesture-detector.h
+++ b/capi/dali/public-api/events/pan-gesture-detector.h
@@ -48,7 +48,7 @@ struct PanGesture;
  * @code
  * PanGestureDetector detector = PanGestureDetector::New();
  * detector.Attach(myActor);
- * detector.SignalDetected().Connect(this, &MyApplication::OnPan);
+ * detector.DetectedSignal().Connect(this, &MyApplication::OnPan);
  *
  * // Detect pan gesture for single and double touch.
  * detector.SetMaximumTouchesRequired(2);

diff --git a/capi/dali/public-api/events/pinch-gesture-detector.h b/capi/dali/public-api/events/pinch-gesture-detector.h
index 1e013a4..fa49fa7 100644 (file)
--- a/capi/dali/public-api/events/pinch-gesture-detector.h
+++ b/capi/dali/public-api/events/pinch-gesture-detector.h
@@ -48,7 +48,7 @@ struct PinchGesture;
  * @code
  * PinchGestureDetector detector = PinchGestureDetector::New();
  * detector.Attach(myActor);
- * detector.SignalDetected().Connect(this, &MyApplication::OnPinch);
+ * detector.DetectedSignal().Connect(this, &MyApplication::OnPinch);
  * @endcode
  *
  * @see PinchGesture

diff --git a/capi/dali/public-api/events/tap-gesture-detector.h b/capi/dali/public-api/events/tap-gesture-detector.h
index 2c03bf2..cb0c5db 100644 (file)
--- a/capi/dali/public-api/events/tap-gesture-detector.h
+++ b/capi/dali/public-api/events/tap-gesture-detector.h
@@ -50,7 +50,7 @@ struct TapGesture;
  * @code
  * TapGestureDetector detector = TapGestureDetector::New();
  * detector.Attach(myActor);
- * detector.SignalDetected().Connect(this, &MyApplication::OnTap);
+ * detector.DetectedSignal().Connect(this, &MyApplication::OnTap);
  * @endcode
  *
  * @see TapGesture

diff --git a/dali/internal/event/events/long-press-gesture-processor.h b/dali/internal/event/events/long-press-gesture-processor.h
index 5e0627f..d34f246 100644 (file)
--- a/dali/internal/event/events/long-press-gesture-processor.h
+++ b/dali/internal/event/events/long-press-gesture-processor.h
@@ -42,11 +42,8 @@ class Stage;
  * Long Press Gesture Event Processing:
  *
  * When we receive a long press gesture event, we do the following:
- * - Determine the hit actor underneath the long press gesture event.
- * - Determine whether this actor is attached to any of the detectors or is a child of an actor
- *   attached to one of the detectors.
- * - Ensure the touches in the long press event match the requirements of the detector.
- * - Emit the gesture when all the above conditions are met.
+ * - Find the actor that requires a long-press at the long press position.
+ * - Emit the gesture if the event satisfies the detector conditions.
  */
 class LongPressGestureProcessor : public GestureProcessor
 {

diff --git a/dali/internal/event/events/pan-gesture-processor.h b/dali/internal/event/events/pan-gesture-processor.h
index 60fab3e..9cd2de0 100644 (file)
--- a/dali/internal/event/events/pan-gesture-processor.h
+++ b/dali/internal/event/events/pan-gesture-processor.h
@@ -46,11 +46,9 @@ class PanGesture;
 /**
  * Pan Gesture Event Processing:
  *
- * When we receive a pinch gesture event, we do the following:
- * - Determine the hot actor underneath the current position of the pan gesture event.
- * - Determine whether this actor is, or is a child of, the actor(s) attached to any of the
- *   detectors.
- * - Emit the gesture when all the above conditions are met.
+ * When we receive a pan gesture event, we do the following:
+ * - Find the actor that requires a pan where the pan started from (i.e. the down position).
+ * - Emit the gesture if the event satisfies the detector conditions.
  *
  * The above is only checked when our gesture starts.  We continue sending the pan gesture to the
  * same actor and detector until the pan ends or is cancelled.
@@ -74,7 +72,7 @@ public:
 public: // To be called by GestureEventProcessor
 
   /**
-   * This method is called whenever a pinch gesture event occurs.
+   * This method is called whenever a pan gesture event occurs.
    * @param[in] panEvent The event that has occurred.
    */
   void Process( const Integration::PanGestureEvent& panEvent );

diff --git a/dali/internal/event/events/pinch-gesture-processor.cpp b/dali/internal/event/events/pinch-gesture-processor.cpp
index bec5c1e..07051b6 100644 (file)
--- a/dali/internal/event/events/pinch-gesture-processor.cpp
+++ b/dali/internal/event/events/pinch-gesture-processor.cpp
@@ -132,7 +132,7 @@ void PinchGestureProcessor::Process( const Integration::PinchGestureEvent& pinch
         // Record the current render-task for Screen->Actor coordinate conversions
         mCurrentRenderTask = hitTestResults.renderTask;
 
-        // Set mCurrentPanEvent to use inside overridden methods called from ProcessAndEmit()
+        // Set mCurrentPinchEvent to use inside overridden methods called from ProcessAndEmit()
         mCurrentPinchEvent = &pinchEvent;
         ProcessAndEmit( hitTestResults );
         mCurrentPinchEvent = NULL;

diff --git a/dali/internal/event/events/pinch-gesture-processor.h b/dali/internal/event/events/pinch-gesture-processor.h
index 68a98a4..c76259c 100644 (file)
--- a/dali/internal/event/events/pinch-gesture-processor.h
+++ b/dali/internal/event/events/pinch-gesture-processor.h
@@ -42,9 +42,8 @@ class Stage;
  * Pinch Gesture Event Processing:
  *
  * When we receive a pinch gesture event, we do the following:
- * - Determine the hit actor underneath the center of the pinch gesture event.
- * - Determine whether this actor is, or is a child of, the actor attached to any of the detectors.
- * - Emit the gesture when all the above conditions are met.
+ * - Find the hit actor that requires a pinch underneath the center-point of the pinch.
+ * - Emit the gesture if the event satisfies the detector conditions.
  *
  * The above is only checked when our gesture starts. We continue sending the pinch gesture to this
  * detector until the pinch ends or is cancelled.

diff --git a/dali/internal/event/events/tap-gesture-processor.h b/dali/internal/event/events/tap-gesture-processor.h
index a83b6ea..84b90a4 100644 (file)
--- a/dali/internal/event/events/tap-gesture-processor.h
+++ b/dali/internal/event/events/tap-gesture-processor.h
@@ -42,11 +42,8 @@ class Actor;
  * Tap Gesture Event Processing:
  *
  * When we receive a tap gesture event, we do the following:
- * - Determine the hit actor underneath the tap gesture event.
- * - Determine whether this actor is attached to any of the detectors or is a child of an actor
- *   attached to one of the detectors.
- * - Ensure the taps and the touches in the tap event match the requirements of the detector.
- * - Emit the gesture when all the above conditions are met.
+ * - Find the actor that requires a tap where the tap occurred.
+ * - Emit the gesture if the tap gesture event satisfies the detector conditions.
  */
 class TapGestureProcessor : public GestureProcessor
 {
@@ -143,4 +140,4 @@ private:
 
 } // namespace Dali
 
-#endif // __DALI_INTERNAL_PINCH_GESTURE_EVENT_PROCESSOR_H__
+#endif // __DALI_INTERNAL_TAP_GESTURE_EVENT_PROCESSOR_H__