#ifndef __DALI_TOOLKIT_SCROLL_BAR_H__
#define __DALI_TOOLKIT_SCROLL_BAR_H__
-//
-// 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.
-//
+/*
+ * Copyright (c) 2015 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.
+ *
+ */
+
+// EXTERNAL INCLUDES
+#include <dali/public-api/common/dali-vector.h>
// INTERNAL INCLUDES
-#include <dali/dali.h>
-#include <dali-toolkit/public-api/controls/control.h>
+#include <dali-toolkit/public-api/controls/scrollable/scroll-component.h>
-namespace Dali DALI_IMPORT_API
+namespace Dali
{
namespace Toolkit
/**
* ScrollBar is a UI component that can be added to the scrollable controls
* indicating the current scroll position of the scrollable content.
+ *
+ * Signals
+ * | %Signal Name | Method |
+ * |--------------------------|-------------------------------------|
+ * | scroll-position-notified | @ref ScrollPositionNotifiedSignal() |
*/
-class ScrollBar : public Control
+class DALI_IMPORT_API ScrollBar : public ScrollComponent
{
public:
+ /**
+ * @brief The start and end property ranges for this control.
+ */
+ enum PropertyRange
+ {
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
+ };
+
+ /**
+ * @brief An enumeration of properties belonging to the ScrollBar class.
+ */
+ struct Property
+ {
+ enum
+ {
+ INDICATOR_HEIGHT_POLICY = PROPERTY_START_INDEX, ///< name "indicator-height-policy", @see SetIndicatorHeightPolicy(), type std::string
+ INDICATOR_FIXED_HEIGHT, ///< name "indicator-fixed-height", @see SetIndicatorFixedHeight(), type float
+ INDICATOR_SHOW_DURATION, ///< name "indicator-show-duration", @see SetIndicatorShowDuration(), type float
+ INDICATOR_HIDE_DURATION, ///< name "indicator-hide-duration", @see SetIndicatorHideDuration(), type float
+ };
+ };
+
// Signals
- static const char* const SCROLL_POSITION_NOTIFIED_SIGNAL_NAME; ///< "scroll-position-notified" signal name
- typedef SignalV2< void ( float ) > ScrollPositionNotifiedSignalType;
+ typedef Signal< void ( float ) > ScrollPositionNotifiedSignalType;
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)
ScrollBar& operator=( const ScrollBar& scrollBar );
/**
- * @brief Virtual destructor.
- * Dali::Object derived classes typically do not contain member data.
+ * @brief Destructor
+ *
+ * This is non-virtual since derived Handle types must not contain data or virtual methods.
*/
- virtual ~ScrollBar();
+ ~ScrollBar();
/**
* @brief Create an initialized ScrollBar
static ScrollBar DownCast( BaseHandle handle );
/**
- * @brief Sets the scroll connector for the scroll bar.
+ * @brief Sets the image for the indicator of scroll bar.
*
* @pre The scroll bar actor has been initialised.
*
- * @param[in] connector Scroll connector used to connect scrollable container with this ScrollBar
+ * 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 SetScrollConnector( ScrollConnector connector );
+ void SetIndicatorImage( Image image );
/**
- * @brief Sets the image for the background of scroll indicator.
+ * @brief Gets the indicator of scroll bar.
*
* @pre The scroll bar actor has been initialised.
*
- * The background image is resized (stretched according to scale settings),
- * to the size of the ScrollBar.
+ * @return The indicator indicates the current scroll position of the scrollable content.
+ */
+ Actor GetScrollIndicator();
+
+ /**
+ * @brief Sets the values to get notification when the current scroll position of the scrollable
+ * content goes above or below any of these values.
+ *
+ * @pre The scroll bar actor has been initialised.
*
- * @param[in] image The image to cover background
- * @param[in] border The nine patch border for the image.
+ * @param[in] positions List of values to receive notifications for when the current scroll position crosses them
*/
- void SetBackgroundImage( Image image, const Vector4& border );
+ void SetPositionNotifications( const Dali::Vector<float>& positions );
/**
- * @brief Sets the image for the indicator of scroll bar.
+ * @brief Sets the height policy of scroll indicator to have either variable or fixed height.
*
* @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] policy The height policy of scroll indicator
+ */
+ void SetIndicatorHeightPolicy( IndicatorHeightPolicy policy );
+
+ /**
+ * @brief Gets the height policy of scroll indicator.
*
- * @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.
+ * @return The height policy of scroll indicator
*/
- void SetIndicatorImage( Image image, const Vector4& border );
+ IndicatorHeightPolicy GetIndicatorHeightPolicy();
/**
- * @brief Gets the indicator of scroll bar.
+ * @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.
*
- * The indicator indicates the current scroll position of the scrollable content.
+ * @param[in] height The fixed height of the scroll indicator
*/
- Actor GetScrollIndicator();
+ void SetIndicatorFixedHeight( float height );
/**
- * @brief Sets the values to get notification when the current scroll position of the scrollable
- * content goes above or below any of these values.
+ * @brief Gets the fix height of scroll indicator.
+ * @return The fixed height of the scroll indicator
+ */
+ 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] positions List of values to receive notifications for when the current scroll position crosses them
+ * @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
*/
- void SetPositionNotifications( const std::vector<float>& positions );
+ float GetIndicatorHideDuration();
/**
* @brief Shows the scroll indicator
* Creates a handle using the Toolkit::Internal implementation.
* @param[in] implementation The Control implementation.
*/
- ScrollBar( Internal::ScrollBar& implementation );
+ DALI_INTERNAL ScrollBar( Internal::ScrollBar& implementation );
/**
* Allows the creation of this Control from an Internal::CustomActor pointer.
* @param[in] internal A pointer to the internal CustomActor.
*/
- ScrollBar( Dali::Internal::CustomActor* internal );
+ explicit DALI_INTERNAL ScrollBar( Dali::Internal::CustomActor* internal );
};
} // namespace Toolkit
projects / platform / core / uifw / dali-toolkit.git / blobdiff