X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fscroll-bar%2Fscroll-bar.h;h=ef50b30fac6a5c1736dca4f481dd3ceac6d37e98;hp=f246c937396075855410abf8a7aae431b052b8f5;hb=f4a28993f3f77f15015e5c9b4e1bedd06e23b926;hpb=dc3613bb6248908c267a76e378b04962bce85664 diff --git a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h index f246c93..ef50b30 100755 --- a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h +++ b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h @@ -2,7 +2,7 @@ #define __DALI_TOOLKIT_SCROLL_BAR_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2016 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. @@ -18,11 +18,8 @@ * */ -// EXTERNAL INCLUDES -#include - // INTERNAL INCLUDES -#include +#include namespace Dali { @@ -30,63 +27,155 @@ namespace Dali namespace Toolkit { -// Forward declarations -class ScrollConnector; - namespace Internal DALI_INTERNAL { // Forward declarations class ScrollBar; } +/** + * @addtogroup dali_toolkit_controls_scroll_bar + * @{ + */ /** - * ScrollBar is a UI component that can be added to the scrollable controls - * indicating the current scroll position of the scrollable content. + * @brief ScrollBar is a UI component that can be linked to the scrollable objects + * indicating the current scroll position of the scrollable object. * * Signals - * | %Signal Name | Method | - * |--------------------------|-------------------------------------| - * | scroll-position-notified | @ref ScrollPositionNotifiedSignal() | + * | %Signal Name | Method | + * |-------------------------------|--------------------------------------------| + * | panFinished | @ref PanFinishedSignal() | + * | scrollPositionIntervalReached | @ref ScrollPositionIntervalReachedSignal() | + * @SINCE_1_0.0 */ -class DALI_IMPORT_API ScrollBar : public ScrollComponent +class DALI_IMPORT_API ScrollBar : public Control { public: + // Properties + + /** + * @brief The start and end property ranges for this control. + * @SINCE_1_0.0 + */ + enum PropertyRange + { + PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0 + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0 + }; + + /** + * @brief An enumeration of properties belonging to the ScrollBar class. + * @SINCE_1_0.0 + */ + struct Property + { + enum + { + /** + * @brief name "scrollDirection", type std::string + * @see SetScrollDirection() + * @SINCE_1_0.0 + */ + SCROLL_DIRECTION = PROPERTY_START_INDEX, + /** + * @brief name "indicatorHeightPolicy", type std::string + * @see SetIndicatorHeightPolicy() + * @SINCE_1_0.0 + */ + INDICATOR_HEIGHT_POLICY, + /** + * @brief name "indicatorFixedHeight", type float + * @see SetIndicatorFixedHeight() + * @SINCE_1_0.0 + */ + INDICATOR_FIXED_HEIGHT, + /** + * @brief name "indicatorShowDuration", type float + * @see SetIndicatorShowDuration() + * @SINCE_1_0.0 + */ + INDICATOR_SHOW_DURATION, + /** + * @brief name "indicatorHideDuration", type float + * @see SetIndicatorHideDuration() + * @SINCE_1_0.0 + */ + INDICATOR_HIDE_DURATION, + /** + * @brief name "scrollPositionIntervals", type Property::Array + * @see SetScrollPositionIntervals() + * @SINCE_1_0.0 + */ + SCROLL_POSITION_INTERVALS, + /** + * @brief name "indicatorMinimumHeight", type float + * The minimum height for a variable size indicator. + * @SINCE_1_1.36 + */ + INDICATOR_MINIMUM_HEIGHT, + /** + * @brief name "indicatorStartPadding", type float + * The padding at the start of the indicator. For example, the top if scrollDirection is Vertical. + * @SINCE_1_1.36 + */ + INDICATOR_START_PADDING, + /** + * @brief name "indicatorEndPadding", type float + * The padding at the end of the indicator. For example, the bottom if scrollDirection is Vertical. + * @SINCE_1_1.36 + */ + INDICATOR_END_PADDING + }; + }; + // Signals - typedef Signal< void ( float ) > ScrollPositionNotifiedSignalType; - // Properties - 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 + typedef Signal< void () > PanFinishedSignalType; + typedef Signal< void ( float ) > ScrollPositionIntervalReachedSignalType; public: /** + * @brief Direction. + * @SINCE_1_0.0 + */ + enum Direction + { + Vertical = 0, ///< Scroll in the vertical direction @SINCE_1_0.0 + Horizontal ///< Scroll in the horizontal direction @SINCE_1_0.0 + }; + + /** * @brief Indicator height policy. + * @SINCE_1_0.0 */ 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 + Variable = 0, ///< Variable height changed dynamically according to the length of scroll content @SINCE_1_0.0 + Fixed ///< Fixed height regardless of the length of scroll content @SINCE_1_0.0 }; /** * @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) + * @SINCE_1_0.0 */ ScrollBar(); /** * @brief Copy constructor. + * @SINCE_1_0.0 + * @param[in] scrollBar Handle to an object */ ScrollBar( const ScrollBar& scrollBar ); /** * @brief Assignment operator. + * @SINCE_1_0.0 + * @param[in] scrollBar Handle to an object + * @return A reference to this */ ScrollBar& operator=( const ScrollBar& scrollBar ); @@ -94,162 +183,245 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~ScrollBar(); /** * @brief Create an initialized ScrollBar + * @SINCE_1_0.0 + * @param[in] direction The direction of scroll bar (either vertically or horizontally). * @return A pointer to the created ScrollBar. */ - static ScrollBar New(); + static ScrollBar New(Direction direction = Vertical); /** - * @brief Downcast an Object handle to ScrollBar. If handle points to a ScrollBar the + * @brief Downcast a handle to ScrollBar handle. + * + * If handle points to a ScrollBar the * downcast produces valid handle. If not the returned handle is left uninitialized. + * @SINCE_1_0.0 * @param[in] handle Handle to an object * @return handle to a ScrollBar or an uninitialized handle */ static ScrollBar DownCast( BaseHandle handle ); /** - * @brief Sets the image for the indicator of scroll bar. + * @brief Set the source of the scroll position properties. * - * @pre The scroll bar actor has been initialised. + * * @pre The handle to the object owing the scroll properties has been initialised and the property index must be vaild. + * + * @SINCE_1_0.0 + * @param[in] handle The handle of the object owing the scroll properties. + * @param[in] propertyScrollPosition The index of the scroll position property (The scroll position, type float). + * @param[in] propertyMinScrollPosition The index of the minimum scroll position property (The minimum scroll position, type float). + * @param[in] propertyMaxScrollPosition The index of the maximum scroll position property (The maximum scroll position, type float). + * @param[in] propertyScrollContentSize The index of the scroll content size property (The size of the scrollable content in actor coordinates, type float). + */ + void SetScrollPropertySource( Handle handle, Dali::Property::Index propertyScrollPosition, Dali::Property::Index propertyMinScrollPosition, Dali::Property::Index propertyMaxScrollPosition, Dali::Property::Index propertyScrollContentSize ); + + /** + * @brief Sets the indicator of scroll bar. * - * 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. + * @SINCE_1_0.0 + * @param[in] indicator The indicator that moves to indicate the current scroll position. + * @pre The scroll bar actor has been initialised. * - * @param[in] image The image of indicator that moves to indicate the current scroll position. */ - void SetIndicatorImage( Image image ); + void SetScrollIndicator( Actor indicator ); /** * @brief Gets the indicator of scroll bar. * + * @SINCE_1_0.0 + * @return The indicator indicates the current scroll position of the scrollable content. * @pre The scroll bar actor has been initialised. * - * @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. + * @brief Sets the list of values to get notification when the current scroll position of the scrollable + * object goes above or below any of these values. * + * @SINCE_1_0.0 + * @param[in] positions List of values to receive notifications for when the current scroll position crosses them * @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 */ - void SetPositionNotifications( const std::vector& positions ); + void SetScrollPositionIntervals( const Dali::Vector& positions ); /** - * @brief Sets the height policy of scroll indicator to have either variable or fixed height. + * @brief Gets the list of values to receive notifications when the current scroll position of the scrollable + * object goes above or below any of these values. + * + * @SINCE_1_0.0 + * @return The list of values to receive notifications for when the current scroll position crosses them + * @pre The scroll bar actor has been initialised. + * + */ + Dali::Vector GetScrollPositionIntervals() const; + + /** + * @brief Sets the direction of scroll bar to scroll either vertically or horizontally. * + * @SINCE_1_0.0 + * @param[in] direction The direction of scroll bar (either vertically or horizontally). * @pre The scroll bar actor has been initialised. * + */ + void SetScrollDirection( Direction direction ); + + /** + * @brief Gets the direction of scroll bar. + * + * @SINCE_1_0.0 + * @return The direction of scroll bar. + */ + Direction GetScrollDirection() const; + + /** + * @brief Sets the height policy of scroll indicator to have either variable or fixed height. + * + * @SINCE_1_0.0 * @param[in] policy The height policy of scroll indicator + * @pre The scroll bar actor has been initialised. + * */ void SetIndicatorHeightPolicy( IndicatorHeightPolicy policy ); /** * @brief Gets the height policy of scroll indicator. * + * @SINCE_1_0.0 * @return The height policy of scroll indicator */ - IndicatorHeightPolicy GetIndicatorHeightPolicy(); + IndicatorHeightPolicy GetIndicatorHeightPolicy() const; /** * @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. * + * @SINCE_1_0.0 + * @param[in] height The fixed height of the scroll indicator * @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. + * @SINCE_1_0.0 * @return The fixed height of the scroll indicator */ - float GetIndicatorFixedHeight(); + float GetIndicatorFixedHeight() const; /** * @brief Sets the duration in second for the scroll indicator to become fully visible * - * @pre The scroll bar actor has been initialised. - * + * @SINCE_1_0.0 * @param[in] durationSeconds The duration for the scroll indicator to become fully visible + * @pre The scroll bar actor has been initialised; durationSeconds must be zero or greater; zero means the indicator will be shown instantly. + * */ void SetIndicatorShowDuration( float durationSeconds ); /** * @brief Gets the duration in second for the scroll indicator to become fully visible + * @SINCE_1_0.0 * @return The duration for the scroll indicator to become fully visible */ - float GetIndicatorShowDuration(); + float GetIndicatorShowDuration() const; /** * @brief Sets the duration in second for the scroll indicator to become fully invisible * - * @pre The scroll bar actor has been initialised. - * + * @SINCE_1_0.0 * @param[in] durationSeconds The duration for the scroll indicator to become fully invisible + * @pre The scroll bar actor has been initialised; durationSeconds must be zero or greater; zero means the indicator will be hidden instantly. + * */ void SetIndicatorHideDuration( float durationSeconds ); /** * @brief Gets the duration in second for the scroll indicator to become fully invisible + * @SINCE_1_0.0 * @return The duration for the scroll indicator to become fully invisible */ - float GetIndicatorHideDuration(); + float GetIndicatorHideDuration() const; /** * @brief Shows the scroll indicator + * @SINCE_1_0.0 */ - void Show(); + void ShowIndicator(); /** * @brief Hides the scroll indicator + * @SINCE_1_0.0 */ - void Hide(); + void HideIndicator(); + +public: // Signals /** - * @brief Signal emitted when the current scroll position of the scrollable content goes above or below the values - * specified by SetPositionNotifications. + * @brief Signal emitted when panning is finished on the scroll indicator. + * + * Signal only emitted when the source of the scroll position properties are set. * * A callback of the following type may be connected: * @code - * void YourCallbackName(float currentScrollPosition); + * void YourCallbackName(); * @endcode + * @SINCE_1_0.0 + * @return The signal to connect to. * @pre The Object has been initialized. + */ + ScrollBar::PanFinishedSignalType& PanFinishedSignal(); + + /** + * @brief Signal emitted when the current scroll position of the scrollable content + * goes above or below the values specified by SCROLL_POSITION_INTERVALS property. + * + * Signal only emitted when the source of the scroll position properties are set. + * + * A callback of the following type may be connected: + * @code + * void YourCallbackName(float currentScrollPosition); + * @endcode + * @SINCE_1_0.0 * @return The signal to connect to. + * @pre The Object has been initialized. */ - ScrollBar::ScrollPositionNotifiedSignalType& ScrollPositionNotifiedSignal(); + ScrollBar::ScrollPositionIntervalReachedSignalType& ScrollPositionIntervalReachedSignal(); public: // Not intended for application developers + /// @cond internal /** - * Creates a handle using the Toolkit::Internal implementation. + * @brief Creates a handle using the Toolkit::Internal implementation. + * @SINCE_1_0.0 * @param[in] implementation The Control implementation. */ DALI_INTERNAL ScrollBar( Internal::ScrollBar& implementation ); /** - * Allows the creation of this Control from an Internal::CustomActor pointer. + * @brief Allows the creation of this Control from an Internal::CustomActor pointer. + * @SINCE_1_0.0 * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL ScrollBar( Dali::Internal::CustomActor* internal ); + /// @endcond }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali -/** - * @} - */ #endif // __DALI_TOOLKIT_SCROLL_BAR_H__