Purge underscored header file barriers

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

diff --git a/dali/public-api/events/gesture.h b/dali/public-api/events/gesture.h
index fb7d041..0dcdc14 100644 (file)
--- a/dali/public-api/events/gesture.h
+++ b/dali/public-api/events/gesture.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_GESTURE_H__
-#define __DALI_GESTURE_H__
+#ifndef DALI_GESTURE_H
+#define DALI_GESTURE_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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,6 +18,9 @@
  *
  */
 
+// EXTERNAL INCLUDES
+#include <cstdint> // uint32_t
+
 // INTERNAL INCLUDES
 #include <dali/public-api/common/dali-common.h>
 
@@ -38,19 +41,25 @@ namespace Dali
  * To receive a particular gesture, the application has to create and connect to the appropriate
  * GestureDetector.
  *
+ * @SINCE_1_0.0
+ * @note An instance of this class cannot be created.
  * @see GestureDetector
  *
- * @note An instance of this class cannot be created.
  */
-struct DALI_IMPORT_API Gesture
+struct DALI_CORE_API Gesture
 {
   /**
    * @brief Copy constructor.
+   * @SINCE_1_0.0
+   * @param[in] rhs A reference to the copied handle
    */
   Gesture( const Gesture& rhs );
 
   /**
    * @brief Assignment operator.
+   * @SINCE_1_0.0
+   * @param[in] rhs A reference to the copied handle
+   * @return A reference to this
    */
   Gesture& operator=( const Gesture& rhs );
 
@@ -58,31 +67,34 @@ struct DALI_IMPORT_API Gesture
 
   /**
    * @brief Virtual destructor.
+   * @SINCE_1_0.0
    */
   virtual ~Gesture();
 
   /**
-   * @brief Type of gesture.
+   * @brief Enumeration for type of gesture.
+   * @SINCE_1_0.0
    */
   enum Type
   {
-    Pinch      = 1 << 0, ///< When two touch points move away or towards each other.
-    Pan        = 1 << 1, ///< When the user drags their finger(s) in a particular direction.
-    Tap        = 1 << 2, ///< When the user taps the screen.
-    LongPress  = 1 << 3  ///< When the user continues to touch the same area on the screen for the device configured time.
+    Pinch      = 1 << 0, ///< When two touch points move away or towards each other. @SINCE_1_0.0
+    Pan        = 1 << 1, ///< When the user drags their finger(s) in a particular direction. @SINCE_1_0.0
+    Tap        = 1 << 2, ///< When the user taps the screen. @SINCE_1_0.0
+    LongPress  = 1 << 3  ///< When the user continues to touch the same area on the screen for the device configured time. @SINCE_1_0.0
   };
 
   /**
-   * @brief State of the gesture.
+   * @brief Enumeration for state of the gesture.
+   * @SINCE_1_0.0
    */
   enum State
   {
-    Clear,      ///< There is no state associated with this gesture.
-    Started,    ///< The touched points on the screen have moved enough to be considered a gesture.
-    Continuing, ///< The gesture is continuing.
-    Finished,   ///< The user has lifted a finger or touched an additional point on the screen.
-    Cancelled,  ///< The gesture has been cancelled.
-    Possible    ///< A gesture is possible.
+    Clear,      ///< There is no state associated with this gesture. @SINCE_1_0.0
+    Started,    ///< The touched points on the screen have moved enough to be considered a gesture. @SINCE_1_0.0
+    Continuing, ///< The gesture is continuing. @SINCE_1_0.0
+    Finished,   ///< The user has lifted a finger or touched an additional point on the screen. @SINCE_1_0.0
+    Cancelled,  ///< The gesture has been cancelled. @SINCE_1_0.0
+    Possible    ///< A gesture is possible. @SINCE_1_0.0
   };
 
   // Data
@@ -103,13 +115,14 @@ struct DALI_IMPORT_API Gesture
   /**
    * @brief The time the gesture took place.
    */
-  unsigned int time;
+  uint32_t time;
 
 protected: // Creation
 
   /**
    * @brief This constructor is only used by derived classes.
    *
+   * @SINCE_1_0.0
    * @param[in] gestureType   The type of gesture event.
    * @param[in] gestureState  The state of the gesture event.
    */
@@ -122,4 +135,4 @@ protected: // Creation
  */
 } // namespace Dali
 
-#endif // __DALI_GESTURE_H__
+#endif // DALI_GESTURE_H