Making DALi public API typesafe using guaranteed types; uint8_t, uint32_t

[platform/core/uifw/dali-core.git] / dali / public-api / events / touch-event.h

diff --git a/dali/public-api/events/touch-event.h b/dali/public-api/events/touch-event.h
index 244b2b0..f4adbf8 100644 (file)
--- a/dali/public-api/events/touch-event.h
+++ b/dali/public-api/events/touch-event.h
@@ -2,7 +2,7 @@
 #define __DALI_TOUCH_EVENT_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,39 +25,49 @@
 namespace Dali
 {
 /**
- * @addtogroup dali-core-events
+ * @addtogroup dali_core_events
  * @{
  */
 
 /**
+ * @DEPRECATED_1_1.37 Use TouchData instead
+ *
  * @brief Touch events are a collection of touch points at a specific moment in time.
  *
  * When a multi-touch event occurs, each touch point represents the points that are currently being
  * touched or the points where a touch has stopped.
+ * @SINCE_1_0.0
  */
-struct DALI_IMPORT_API TouchEvent
+struct DALI_CORE_API TouchEvent
 {
   // Construction & Destruction
 
   /**
-   * @brief Default constructor
+   * @DEPRECATED_1_1.37
+   * @brief Default constructor.
+   * @SINCE_1_0.0
    */
-  TouchEvent();
+  TouchEvent() DALI_DEPRECATED_API;
 
   /**
-   * @brief Constructor
-   * @param[in]  time  The time the event occurred
+   * @DEPRECATED_1_1.37
+   * @brief Constructor.
+   * @SINCE_1_0.0
+   * @param[in] time The time the event occurred
    */
-  TouchEvent(unsigned long time);
+  TouchEvent(unsigned long time) DALI_DEPRECATED_API;
 
   /**
-   * @brief Destructor
+   * @DEPRECATED_1_1.37
+   * @brief Destructor.
+   * @SINCE_1_0.0
    */
-  ~TouchEvent();
+  ~TouchEvent() DALI_DEPRECATED_API;
 
   // Data
 
   /**
+   * @DEPRECATED_1_1.37
    * @brief This is a container of points for this touch event.
    *
    * The first point in the set is always the
@@ -66,6 +76,7 @@ struct DALI_IMPORT_API TouchEvent
   TouchPointContainer points;
 
   /**
+   * @DEPRECATED_1_1.37
    * @brief The time (in ms) that the touch event occurred.
    */
   unsigned long time;
@@ -73,23 +84,27 @@ struct DALI_IMPORT_API TouchEvent
   // Convenience Methods
 
   /**
+   * @DEPRECATED_1_1.37
    * @brief Returns the total number of points in this TouchEvent.
    *
-   * @return Total number of Points.
+   * @SINCE_1_0.0
+   * @return Total number of Points
    */
-  unsigned int GetPointCount() const;
+  uint32_t GetPointCount() const DALI_DEPRECATED_API;
 
   /**
+   * @DEPRECATED_1_1.37
    * @brief Returns a touch point at the index requested.
    *
    * The first point in the set is always the primary
    * touch point (i.e. the first point touched in a multi-touch event).
+   * @SINCE_1_0.0
+   * @param[in] point The index of the required Point
+   * @return Point requested
    * @note "point" should be less than the value returned by GetPointCount().
    *       If out of range, then program asserts.
-   * @param[in] point The index of the required Point.
-   * @return Point requested
    */
-  const TouchPoint& GetPoint(unsigned int point) const;
+  const TouchPoint& GetPoint( uint32_t point ) const DALI_DEPRECATED_API;
 };
 
 /**