Moved Gesture::State and -::Type to gesture-enumerations.h.
[platform/core/uifw/dali-core.git] / dali / public-api / events / long-press-gesture-detector.h
index 815a8d6..5265842 100644 (file)
@@ -1,8 +1,8 @@
-#ifndef __DALI_LONG_PRESS_GESTURE_DETECTOR_H__
-#define __DALI_LONG_PRESS_GESTURE_DETECTOR_H__
+#ifndef DALI_LONG_PRESS_GESTURE_DETECTOR_H
+#define DALI_LONG_PRESS_GESTURE_DETECTOR_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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/events/gesture-detector.h>
 #include <dali/public-api/signals/dali-signal.h>
@@ -34,15 +37,15 @@ namespace Internal DALI_INTERNAL
 class LongPressGestureDetector;
 }
 
-struct LongPressGesture;
+class LongPressGesture;
 
 /**
  * @brief This class emits a signals when a long press gesture occurs that meets the requirements set by the application.
  * @SINCE_1_0.0
  *
  * For any valid long press, two signals will be emitted:
- * - First identifying the beginning (state = Started) i.e. when fingers held down for the required time.
- * - Second identifying the ending (state = Finished) i.e. when fingers are released.
+ * - First identifying the beginning (state = GestureState::STARTED) i.e. when fingers held down for the required time.
+ * - Second identifying the ending (state = GestureState::FINISHED) i.e. when fingers are released.
  *
  * The application programmer can use this gesture detector as follows:
  * @code
@@ -58,7 +61,7 @@ struct LongPressGesture;
  * |-------------------|-----------------------|
  * | longPressDetected | @ref DetectedSignal() |
  */
-class DALI_IMPORT_API LongPressGestureDetector : public GestureDetector
+class DALI_CORE_API LongPressGestureDetector : public GestureDetector
 {
 public: // Typedefs
 
@@ -92,7 +95,7 @@ public: // Creation & Destruction
    * @param[in] touchesRequired The number of touches required
    * @return A handle to a newly allocated Dali resource
    */
-  static LongPressGestureDetector New(unsigned int touchesRequired);
+  static LongPressGestureDetector New(uint32_t touchesRequired);
 
   /**
    * @brief Creates an initialized LongPressGestureDetector with the minimum and maximum number of touches required.
@@ -104,7 +107,7 @@ public: // Creation & Destruction
    * @param[in] maxTouches The maximum number of touches required
    * @return A handle to a newly allocated Dali resource
    */
-  static LongPressGestureDetector New(unsigned int minTouches, unsigned int maxTouches);
+  static LongPressGestureDetector New(uint32_t minTouches, uint32_t maxTouches);
 
   /**
    * @brief Downcasts a handle to LongPressGestureDetector handle.
@@ -156,7 +159,7 @@ public: // Setters
    * @pre The gesture detector has been initialized.
    * @note The default is '1'.
    */
-  void SetTouchesRequired(unsigned int touches);
+  void SetTouchesRequired(uint32_t touches);
 
   /**
    * @brief Sets the minimum and maximum touches required.
@@ -170,7 +173,7 @@ public: // Setters
    * @pre The gesture detector has been initialized.
    * @note The default is '1'.
    */
-  void SetTouchesRequired(unsigned int minTouches, unsigned int maxTouches);
+  void SetTouchesRequired(uint32_t minTouches, uint32_t maxTouches);
 
 public: // Getters
 
@@ -181,7 +184,7 @@ public: // Getters
    * @return The minimum number of touches required
    * @pre The gesture detector has been initialized.
    */
-  unsigned int GetMinimumTouchesRequired() const;
+  uint32_t GetMinimumTouchesRequired() const;
 
   /**
    * @brief Retrieves the maximum number of touches required.
@@ -190,7 +193,7 @@ public: // Getters
    * @return The maximum number of touches required
    * @pre The gesture detector has been initialized.
    */
-  unsigned int GetMaximumTouchesRequired() const;
+  uint32_t GetMaximumTouchesRequired() const;
 
 public: // Signals
 
@@ -226,4 +229,4 @@ public: // Not intended for Application developers
  */
 } // namespace Dali
 
-#endif // __DALI_LONG_PRESS_GESTURE_DETECTOR_H__
+#endif // DALI_LONG_PRESS_GESTURE_DETECTOR_H