Include required header files directly rather than through dali.h
[platform/core/uifw/dali-toolkit.git] / base / dali-toolkit / public-api / controls / scroll-bar / scroll-bar.h
index d67b9c0..a4b387d 100755 (executable)
  *
  */
 
+// EXTERNAL INCLUDES
+#include <dali/public-api/common/vector-wrapper.h>
+
 // INTERNAL INCLUDES
-#include <dali/dali.h>
 #include <dali-toolkit/public-api/controls/scrollable/scroll-component.h>
 
 namespace Dali DALI_IMPORT_API
@@ -51,8 +53,10 @@ public:
   typedef SignalV2< void ( float ) > ScrollPositionNotifiedSignalType;
 
   // Properties
-  static const Property::Index PROPERTY_INDICATOR_HEIGHT_POLICY;         ///< name "indicator-height-policy", type STRING
-  static const Property::Index PROPERTY_INDICATOR_FIXED_HEIGHT;          ///< name "indicator-fixed-height",  type FLOAT
+  static const Property::Index PROPERTY_INDICATOR_HEIGHT_POLICY;         ///< name "indicator-height-policy", @see SetIndicatorHeightPolicy(), type STRING
+  static const Property::Index PROPERTY_INDICATOR_FIXED_HEIGHT;          ///< name "indicator-fixed-height",  @see SetIndicatorFixedHeight(),  type FLOAT
+  static const Property::Index PROPERTY_INDICATOR_SHOW_DURATION;         ///< name "indicator-show-duration", @see SetIndicatorShowDuration(), type FLOAT
+  static const Property::Index PROPERTY_INDICATOR_HIDE_DURATION;         ///< name "indicator-hide-duration", @see SetIndicatorHideDuration(), type FLOAT
 
 public:
 
@@ -104,21 +108,6 @@ public:
   static ScrollBar DownCast( BaseHandle handle );
 
   /**
-   * @brief Sets the image for the background of scroll indicator.
-   *
-   * @pre The scroll bar actor has been initialised.
-   *
-   * The background image is resized (stretched according to scale settings),
-   * to the size of the ScrollBar.
-   *
-   * @param[in] image The image to cover background
-   * @param[in] border The nine patch border for the image.
-   *
-   * @deprecated Use Control::SetBackground()
-   */
-  void SetBackgroundImage( Image image, const Vector4& border );
-
-  /**
    * @brief Sets the image for the indicator of scroll bar.
    *
    * @pre The scroll bar actor has been initialised.
@@ -132,22 +121,6 @@ public:
   void SetIndicatorImage( Image image );
 
   /**
-   * @brief Sets the image for the indicator of scroll bar.
-   *
-   * @pre The scroll bar actor has been initialised.
-   *
-   * The indicator image is resized (stretched according to scale settings),
-   * to reflect the size of the scroll indicator and minimum/maximum limits
-   * of the scroll position.
-   *
-   * @param[in] image The image of indicator that moves to indicate the current scroll position.
-   * @param[in] border The nine patch border for the image.
-   *
-   * @deprecated Use the new 9-patch API
-   */
-  void SetIndicatorImage( Image image, const Vector4& border );
-
-  /**
    * @brief Gets the indicator of scroll bar.
    *
    * @pre The scroll bar actor has been initialised.
@@ -201,6 +174,36 @@ public:
   float GetIndicatorFixedHeight();
 
   /**
+   * @brief Sets the duration in second for the scroll indicator to become fully visible
+   *
+   * @pre The scroll bar actor has been initialised.
+   *
+   * @param[in] durationSeconds The duration for the scroll indicator to become fully visible
+   */
+  void SetIndicatorShowDuration( float durationSeconds );
+
+  /**
+   * @brief Gets the duration in second for the scroll indicator to become fully visible
+   * @return The duration for the scroll indicator to become fully visible
+   */
+  float GetIndicatorShowDuration();
+
+  /**
+   * @brief Sets the duration in second for the scroll indicator to become fully invisible
+   *
+   * @pre The scroll bar actor has been initialised.
+   *
+   * @param[in] durationSeconds The duration for the scroll indicator to become fully invisible
+   */
+  void SetIndicatorHideDuration( float durationSeconds );
+
+  /**
+   * @brief Gets the duration in second for the scroll indicator to become fully invisible
+   * @return The duration for the scroll indicator to become fully invisible
+   */
+  float GetIndicatorHideDuration();
+
+  /**
    * @brief Shows the scroll indicator
    */
   void Show();