Revert "WheelEvent class pimpling"
[platform/core/uifw/dali-core.git] / dali / public-api / actors / actor.h
index 2f12cdf..18d1c3d 100644 (file)
@@ -49,9 +49,8 @@ class Renderer;
 struct Degree;
 class Quaternion;
 class Layer;
-class TouchData;
-struct TouchEvent;
-struct HoverEvent;
+class TouchEvent;
+class HoverEvent;
 struct WheelEvent;
 struct Vector2;
 struct Vector3;
@@ -66,7 +65,7 @@ typedef Rect<float> Padding;      ///< Padding definition @SINCE_1_0.0
  *
  * <h3>Multi-Touch Events:</h3>
  *
- * Touch or hover events are received via signals; see Actor::TouchedSignal() and Actor::HoveredSignal() for more details.
+ * Touch or hover events are received via signals; see Actor::TouchSignal() and Actor::HoveredSignal() for more details.
  *
  * <i>Hit Testing Rules Summary:</i>
  *
@@ -216,12 +215,16 @@ typedef Rect<float> Padding;      ///< Padding definition @SINCE_1_0.0
  *   - If the consumed actor on hover-start is not the same as the consumed actor on hover-finished, then
  *     hover signals are also emitted from the hover-started actor with an "Interrupted" state.
  *
+ * <h3>Key Events:</h3>
+ *
+ * Key events are received by an actor once set to grab key events, only one actor can be set as focused.
+ *
  * @nosubgrouping
  *
  * Signals
  * | %Signal Name      | Method                       |
  * |-------------------|------------------------------|
- * | touched           | @ref TouchedSignal()         |
+ * | touch             | @ref TouchSignal()           |
  * | hovered           | @ref HoveredSignal()         |
  * | wheelEvent        | @ref WheelEventSignal()      |
  * | onScene           | @ref OnSceneSignal()         |
@@ -731,8 +734,7 @@ public:
 
   // Typedefs
 
-  typedef Signal< bool (Actor, const TouchEvent&) > TouchSignalType;        ///< @DEPRECATED_1_1.37 @brief Touch signal type @SINCE_1_0.0
-  typedef Signal< bool (Actor, const TouchData&) >  TouchDataSignalType;    ///< Touch signal type @SINCE_1_1.37
+  typedef Signal< bool (Actor, const TouchEvent&) >  TouchEventSignalType;    ///< Touch signal type @SINCE_1_1.37
   typedef Signal< bool (Actor, const HoverEvent&) > HoverSignalType;        ///< Hover signal type @SINCE_1_0.0
   typedef Signal< bool (Actor, const WheelEvent&) > WheelEventSignalType;   ///< Wheel signal type @SINCE_1_0.0
   typedef Signal< void (Actor) > OnSceneSignalType;                         ///< Scene connection signal type @SINCE_1_9.24
@@ -1163,36 +1165,19 @@ public: // Renderer
 public: // Signals
 
   /**
-   * @DEPRECATED_1_1.37 Use TouchSignal() instead.
-   * @brief This signal is emitted when touch input is received.
-   *
-   * A callback of the following type may be connected:
-   * @code
-   *   bool YourCallbackName(Actor actor, const TouchEvent& event);
-   * @endcode
-   * The return value of True, indicates that the touch event should be consumed.
-   * Otherwise the signal will be emitted on the next sensitive parent of the actor.
-   * @SINCE_1_0.0
-   * @return The signal to connect to
-   * @pre The Actor has been initialized.
-   */
-  TouchSignalType& TouchedSignal() DALI_DEPRECATED_API;
-
-  /**
    * @brief This signal is emitted when touch input is received.
    *
    * A callback of the following type may be connected:
    * @code
-   *   bool YourCallbackName( Actor actor, TouchData& touch );
+   *   bool YourCallbackName( Actor actor, TouchEvent& touch );
    * @endcode
    * The return value of True, indicates that the touch event has been consumed.
    * Otherwise the signal will be emitted on the next sensitive parent of the actor.
-   * A true return will also cancel any ongoing gestures.
    * @SINCE_1_1.37
    * @return The signal to connect to
    * @pre The Actor has been initialized.
    */
-  TouchDataSignalType& TouchSignal();
+  TouchEventSignalType& TouchSignal();
 
   /**
    * @brief This signal is emitted when hover input is received.