Renamed TouchSignal to TouchedSignal

[platform/core/uifw/dali-core.git] / dali / devel-api / common / stage.h

diff --git a/dali/devel-api/common/stage.h b/dali/devel-api/common/stage.h
index ea99ee1..90d572c 100644 (file)
--- a/dali/devel-api/common/stage.h
+++ b/dali/devel-api/common/stage.h
@@ -40,13 +40,13 @@ class Stage;
 class Actor;
 class Layer;
 class ObjectRegistry;
-class TouchData;
+class TouchEvent;
 class RenderTaskList;
+class WheelEvent;
 struct Vector2;
 struct Vector3;
 struct Vector4;
-struct KeyEvent;
-struct WheelEvent;
+class KeyEvent;
 
 /**
  * @brief The Stage is a top-level object used for displaying a tree of Actors.
@@ -76,26 +76,22 @@ struct WheelEvent;
  * |-------------------------|--------------------------------------|
  * | keyEvent                | @ref KeyEventSignal()                |
  * | eventProcessingFinished | @ref EventProcessingFinishedSignal() |
- * | touch                   | @ref TouchSignal()                   |
+ * | touched                 | @ref TouchedSignal()                 |
  * | wheelEvent              | @ref WheelEventSignal()              |
  * | contextLost             | @ref ContextLostSignal()             |
  * | contextRegained         | @ref ContextRegainedSignal()         |
  * | sceneCreated            | @ref SceneCreatedSignal()            |
- * @SINCE_1_0.0
  */
 class DALI_CORE_API Stage : public BaseHandle
 {
 public:
 
-  typedef Signal< void (const KeyEvent&) > KeyEventSignalType;       ///< Key event signal type @SINCE_1_0.0
-  typedef Signal< void () > EventProcessingFinishedSignalType;       ///< Event Processing finished signal type @SINCE_1_0.0
-  typedef Signal< void (const TouchData&) > TouchSignalType;         ///< Touch signal type @SINCE_1_1.37
-  typedef Signal< void (const WheelEvent&) > WheelEventSignalType;   ///< Wheel signal type @SINCE_1_0.0
-  typedef Signal< void () > ContextStatusSignal;                     ///< Context status signal type @SINCE_1_0.0
-  typedef Signal< void () > SceneCreatedSignalType;                  ///< Scene created signal type @SINCE_1_0.0
-
-  static const Vector4 DEFAULT_BACKGROUND_COLOR; ///< Default black background.
-  static const Vector4 DEBUG_BACKGROUND_COLOR;   ///< Green background, useful when debugging.
+  typedef Signal< void (const KeyEvent&) > KeyEventSignalType;       ///< Key event signal type
+  typedef Signal< void () > EventProcessingFinishedSignalType;       ///< Event Processing finished signal type
+  typedef Signal< void (const TouchEvent&) > TouchEventSignalType;   ///< Touch signal type
+  typedef Signal< void (const WheelEvent&) > WheelEventSignalType;   ///< Wheel signal type
+  typedef Signal< void () > ContextStatusSignal;                     ///< Context status signal type
+  typedef Signal< void () > SceneCreatedSignalType;                  ///< Scene created signal type
 
   /**
    * @brief Allows the creation of an empty stage handle.
@@ -167,7 +163,6 @@ public:
    * The x component will be the width of the Stage in pixels.
    * The y component will be the height of the Stage in pixels.
    * The z component will be the distance between far and near planes.
-   * @SINCE_1_0.0
    * @return The size of the Stage as a Vector
    */
   Vector2 GetSize() const;
@@ -257,7 +252,6 @@ public:
    * @code
    *   void YourCallbackName(const KeyEvent& event);
    * @endcode
-   * @SINCE_1_0.0
    * @return The signal to connect to
    */
   KeyEventSignalType& KeyEventSignal();
@@ -278,13 +272,13 @@ public:
    * An interrupted event will also be emitted (if it occurs).
    * A callback of the following type may be connected:
    * @code
-   *   void YourCallbackName( TouchData event );
+   *   void YourCallbackName( TouchEvent event );
    * @endcode
    *
    * @return The touch signal to connect to
    * @note Motion events are not emitted.
    */
-  TouchSignalType& TouchSignal();
+  TouchEventSignalType& TouchedSignal();
 
   /**
    * @brief This signal is emitted when wheel event is received.