DALi signals refactor to remove V2 naming
[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / public-api / controls / scrollable / scrollable.h
index 7c0af4e..907f7a1 100644 (file)
@@ -101,6 +101,7 @@ public:
   /// @name Properties
   /** @{ */
   static const Property::Index PROPERTY_OVERSHOOT_EFFECT_COLOR;         ///< Property, name "overshoot-effect-color",  @see SetOvershootEffectColor(),  type VECTOR4
+  static const Property::Index PROPERTY_OVERSHOOT_ANIMATION_SPEED;      ///< Property, name "overshoot-animation-speed",  @see SetOvershootAnimationSpeed(),  type FLOAT
   /** @} */
 
   /// @name Signals
@@ -113,25 +114,25 @@ public:
 
 public:
 
-  typedef SignalV2< void ( const Vector3& ) > ScrollStartedSignalV2;   ///< ScrollStarted signal type
-  typedef SignalV2< void ( const Vector3& ) > ScrollCompletedSignalV2; ///< ScrollCompleted signal type
-  typedef SignalV2< void ( const Vector3& ) > ScrollUpdatedSignalV2;   ///< Scroll updated signal type
-  typedef SignalV2< void ( const ClampEvent& ) > ScrollClampedSignalV2; ///< Scroll clamped signal type
+  typedef Signal< void ( const Vector3& ) > ScrollStartedSignalType;   ///< ScrollStarted signal type
+  typedef Signal< void ( const Vector3& ) > ScrollCompletedSignalType; ///< ScrollCompleted signal type
+  typedef Signal< void ( const Vector3& ) > ScrollUpdatedSignalType;   ///< Scroll updated signal type
+  typedef Signal< void ( const ClampEvent& ) > ScrollClampedSignalType; ///< Scroll clamped signal type
 
   /**
    * @brief Signal emitted when the Scrollable has moved (whether by touch or animation).
    */
-  ScrollStartedSignalV2& ScrollStartedSignal();
+  ScrollStartedSignalType& ScrollStartedSignal();
 
   /**
    * @brief Signal emitted when the Scrollable has moved (whether by touch or animation).
    */
-  ScrollUpdatedSignalV2& ScrollUpdatedSignal();
+  ScrollUpdatedSignalType& ScrollUpdatedSignal();
 
   /**
    * @brief Signal emitted when the Scrollable has completed movement (whether by touch or animation).
    */
-  ScrollCompletedSignalV2& ScrollCompletedSignal();
+  ScrollCompletedSignalType& ScrollCompletedSignal();
 
   /**
    * @brief Signal emitted when the Scrollable is pushing against a domain boundary
@@ -139,7 +140,7 @@ public:
    *
    * @return The signal to connect to
    */
-  ScrollClampedSignalV2& ScrollClampedSignal();
+  ScrollClampedSignalType& ScrollClampedSignal();
 
 public:
 
@@ -219,6 +220,19 @@ public:
    */
   Vector4 GetOvershootEffectColor() const;
 
+  /**
+   * @brief Set the speed of overshoot animation in pixels per second.
+   * When the speed is not greater than 0, the overshoot is set instantly with no animation.
+   * @param[in] pixelsPerSecond The speed of the overshoot animation.
+   */
+  void SetOvershootAnimationSpeed( float pixelsPerSecond );
+
+  /**
+   * @brief Get the speed of overshoot animation in pixels per second.
+   * @return The speed of the overshoot animation.
+   */
+  float GetOvershootAnimationSpeed() const;
+
 public: // Not intended for application developers
 
   /**