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

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

diff --git a/dali/public-api/events/hover-event.h b/dali/public-api/events/hover-event.h
index fde089a..e5c9f48 100644 (file)
--- a/dali/public-api/events/hover-event.h
+++ b/dali/public-api/events/hover-event.h
@@ -2,7 +2,7 @@
 #define __DALI_HOVER_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.
@@ -18,36 +18,47 @@
  *
  */
 
+// EXTERNAL INCLUDES
+#include <cstdint> // uint32_t
+
 // INTERNAL INCLUDES
 #include <dali/public-api/common/dali-common.h>
 #include <dali/public-api/events/touch-point.h>
 
 namespace Dali
 {
+/**
+ * @addtogroup dali_core_events
+ * @{
+ */
 
 /**
  * @brief Hover 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
  * hovered or the points where a hover has stopped.
+ * @SINCE_1_0.0
  */
-struct DALI_IMPORT_API HoverEvent
+struct DALI_CORE_API HoverEvent
 {
   // Construction & Destruction
 
   /**
-   * @brief Default constructor
+   * @brief Default constructor.
+   * @SINCE_1_0.0
    */
   HoverEvent();
 
   /**
-   * @brief Constructor
-   * @param[in]  time  The time the event occurred
+   * @brief Constructor.
+   * @SINCE_1_0.0
+   * @param[in] time The time the event occurred
    */
   HoverEvent(unsigned long time);
 
   /**
-   * @brief Destructor
+   * @brief Destructor.
+   * @SINCE_1_0.0
    */
   ~HoverEvent();
 
@@ -71,23 +82,28 @@ struct DALI_IMPORT_API HoverEvent
   /**
    * @brief Returns the total number of points in this HoverEvent.
    *
-   * @return Total number of Points.
+   * @SINCE_1_0.0
+   * @return Total number of Points
    */
-  unsigned int GetPointCount() const;
+  uint32_t GetPointCount() const;
 
   /**
    * @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;
 };
 
+/**
+ * @}
+ */
 } // namespace Dali
 
 #endif // __DALI_HOVER_EVENT_H__