Add new API to ScrollBar to set background and indicator images.
[platform/core/uifw/dali-toolkit.git] / capi / dali-toolkit / public-api / controls / scroll-bar / scroll-bar.h
index d48304d..4e150cd 100755 (executable)
@@ -111,8 +111,23 @@ public:
    *
    * @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.
+   *
+   * 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.
    */
void SetBackgroundImage( Image image, const Vector4& border );
 void SetIndicatorImage( Image image );
 
   /**
    * @brief Sets the image for the indicator of scroll bar.
@@ -125,6 +140,8 @@ public:
    *
    * @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 );