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

diff --git a/capi/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h b/capi/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h
index 02376ee..4e150cd 100755 (executable)
--- a/capi/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h
+++ b/capi/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h
@@ -1,22 +1,21 @@
 #ifndef __DALI_TOOLKIT_SCROLL_BAR_H__
 #define __DALI_TOOLKIT_SCROLL_BAR_H__
 
-/*
- * Copyright (c) 2014 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.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */
+//
+// Copyright (c) 2014 Samsung Electronics Co., Ltd.
+//
+// Licensed under the Flora License, Version 1.0 (the License);
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://floralicense.org/license/
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an AS IS BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
 
 // INTERNAL INCLUDES
 #include <dali/dali.h>
@@ -50,9 +49,22 @@ public:
   static const char* const SCROLL_POSITION_NOTIFIED_SIGNAL_NAME;        ///< "scroll-position-notified" signal name
   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
+
 public:
 
   /**
+   * @brief Indicator height policy.
+   */
+  enum IndicatorHeightPolicy
+  {
+    Variable = 0,  ///< Variable height changed dynamically according to the length of scroll content
+    Fixed          ///< Fixed height regardless of the length of scroll content
+  };
+
+  /**
    * @brief Create an uninitialized ScrollBar; this can be initialized with ScrollBar::New()
    * Calling member functions with an uninitialized Dali::Object is not allowed.
    * or horizontally (false)
@@ -99,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 );
+  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 SetIndicatorImage( Image image );
 
   /**
    * @brief Sets the image for the indicator of scroll bar.
@@ -113,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 );
 
@@ -121,7 +150,7 @@ public:
    *
    * @pre The scroll bar actor has been initialised.
    *
-   * The indicator indicates the current scroll position of the scrollable content.
+   * @return The indicator indicates the current scroll position of the scrollable content.
    */
   Actor GetScrollIndicator();
 
@@ -136,6 +165,40 @@ public:
   void SetPositionNotifications( const std::vector<float>& positions );
 
   /**
+   * @brief Sets the height policy of scroll indicator to have either variable or fixed height.
+   *
+   * @pre The scroll bar actor has been initialised.
+   *
+   * @param[in] policy The height policy of scroll indicator
+   */
+  void SetIndicatorHeightPolicy( IndicatorHeightPolicy policy );
+
+  /**
+   * @brief Gets the height policy of scroll indicator.
+   *
+   * @return The height policy of scroll indicator
+   */
+  IndicatorHeightPolicy GetIndicatorHeightPolicy();
+
+  /**
+   * @brief Sets the fixed height of scroll indicator.
+   * Normally the height of scroll indicator is changed dynamically according to the length of scroll content.
+   * However, when the height policy of scroll indicator is set to be fixed, the height will keep fixed
+   * regardless of the length of scroll content.
+   *
+   * @pre The scroll bar actor has been initialised.
+   *
+   * @param[in] height The fixed height of the scroll indicator
+   */
+  void SetIndicatorFixedHeight( float height );
+
+  /**
+   * @brief Gets the fix height of scroll indicator.
+   * @return The fixed height of the scroll indicator
+   */
+  float GetIndicatorFixedHeight();
+
+  /**
    * @brief Shows the scroll indicator
    */
   void Show();