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=3bd0adc616893402125627c4d3ec648388021aec;hp=5da66a55f9e36a09f7394ab4e0261eb4645c13eb;hb=a3b69d118ee5f918a827b23ea76813a7aefad845;hpb=31df2b9472ccbe0ae460a958535be8ef790c96f2 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 5da66a5..3bd0adc 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) 2015 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. @@ -33,16 +33,21 @@ namespace Internal DALI_INTERNAL class ScrollBar; } +/** + * @addtogroup dali_toolkit_controls_scroll_bar + * @{ + */ /** - * ScrollBar is a UI component that can be linked to the scrollable objects + * @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 | - * |----------------------------------|--------------------------------------------| - * | pan-finished | @ref PanFinishedSignal() | - * | scroll-position-interval-reached | @ref ScrollPositionIntervalReachedSignal() | + * | %Signal Name | Method | + * |-------------------------------|--------------------------------------------| + * | panFinished | @ref PanFinishedSignal() | + * | scrollPositionIntervalReached | @ref ScrollPositionIntervalReachedSignal() | + * @SINCE_1_0.0 */ class DALI_IMPORT_API ScrollBar : public Control { @@ -51,27 +56,81 @@ public: // Properties /** - * @brief The start and end property ranges for this control. + * @brief Enumeration for the start and end property ranges for this control. + * @SINCE_1_0.0 */ enum PropertyRange { - PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices + 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. + * @brief Enumeration for the instance of properties belonging to the ScrollBar class. + * @SINCE_1_0.0 */ struct Property { + /** + * @brief Enumeration for the instance of properties belonging to the ScrollBar class. + * @SINCE_1_0.0 + */ enum { - SCROLL_DIRECTION = PROPERTY_START_INDEX, ///< name "scroll-direction", @see SetScrollDirection(), type std::string - INDICATOR_HEIGHT_POLICY, ///< 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 - SCROLL_POSITION_INTERVALS ///< name "scroll-position-intervals",@see SetScrollPositionIntervals() type Property::Array + /** + * @brief name "scrollDirection", type std::string. + * @SINCE_1_0.0 + * @see SetScrollDirection() + */ + SCROLL_DIRECTION = PROPERTY_START_INDEX, + /** + * @brief name "indicatorHeightPolicy", type std::string. + * @SINCE_1_0.0 + * @see SetIndicatorHeightPolicy() + */ + INDICATOR_HEIGHT_POLICY, + /** + * @brief name "indicatorFixedHeight", type float. + * @SINCE_1_0.0 + * @see SetIndicatorFixedHeight() + */ + INDICATOR_FIXED_HEIGHT, + /** + * @brief name "indicatorShowDuration", type float. + * @SINCE_1_0.0 + * @see SetIndicatorShowDuration() + */ + INDICATOR_SHOW_DURATION, + /** + * @brief name "indicatorHideDuration", type float. + * @SINCE_1_0.0 + * @see SetIndicatorHideDuration() + */ + INDICATOR_HIDE_DURATION, + /** + * @brief name "scrollPositionIntervals", type Property::Array. + * @SINCE_1_0.0 + * @see SetScrollPositionIntervals() + */ + 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 }; }; @@ -84,88 +143,101 @@ public: /** * @brief Direction. + * @SINCE_1_0.0 */ enum Direction { - Vertical = 0, ///< Scroll in the vertical direction - Horizontal ///< Scroll in the horizontal 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() + * @brief Creates an uninitialized ScrollBar; this can be initialized with ScrollBar::New() * Calling member functions with an uninitialized Dali::Object is not allowed. + * @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 ); /** - * @brief Destructor + * @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 - * @param[in] direction The direction of scroll bar (either vertically or horizontally). - * @return A pointer to the created ScrollBar. + * @brief Creates 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(Direction direction = Vertical); /** - * @brief Downcast an Object handle to ScrollBar. If handle points to a ScrollBar the - * downcast produces valid handle. If not the returned handle is left uninitialized. + * @brief Downcasts 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 + * @return Handle to a ScrollBar or an uninitialized handle */ static ScrollBar DownCast( BaseHandle handle ); /** - * @brief Set the source of the scroll position properties. - * - * * @pre The handle to the object owing the scroll properties has been initialised and the property index must be vaild. + * @brief Sets the source of the scroll position properties. * - * @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). + * @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) + * @pre The handle to the object owing the scroll properties has been initialised and the property index must be valid. */ 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. * - * @pre The scroll bar actor has been initialised. - * - * @param[in] indicator The indicator that moves to indicate the current 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 initialized. */ void SetScrollIndicator( Actor indicator ); /** * @brief Gets the indicator of scroll bar. * - * @pre The scroll bar actor has been initialised. - * - * @return The indicator indicates the current scroll position of the scrollable content. + * @SINCE_1_0.0 + * @return The indicator indicates the current scroll position of the scrollable content + * @pre The scroll bar actor has been initialized. */ Actor GetScrollIndicator(); @@ -173,9 +245,9 @@ public: * @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. * - * @pre The scroll bar actor has been initialised. - * + * @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 initialized. */ void SetScrollPositionIntervals( const Dali::Vector& positions ); @@ -183,99 +255,111 @@ public: * @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. * - * @pre The scroll bar actor has been initialised. - * + * @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 initialized. + * */ Dali::Vector GetScrollPositionIntervals() const; /** * @brief Sets the direction of scroll bar to scroll either vertically or horizontally. * - * @pre The scroll bar actor has been initialised. - * - * @param[in] direction The direction of scroll bar (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 initialized. */ void SetScrollDirection( Direction direction ); /** * @brief Gets the direction of scroll bar. * - * @return 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. * - * @pre The scroll bar actor has been initialised. - * + * @SINCE_1_0.0 * @param[in] policy The height policy of scroll indicator + * @pre The scroll bar actor has been initialized. */ 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() 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 + * However, when the height policy of scroll indicator is set to be fixed, the height will be kept fixed * regardless of the length of scroll content. * - * @pre The scroll bar actor has been initialised. - * + * @SINCE_1_0.0 * @param[in] height The fixed height of the scroll indicator + * @pre The scroll bar actor has been initialized. + * */ 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() const; /** - * @brief Sets the duration in second for the scroll indicator to become fully visible + * @brief Sets the duration in seconds for the scroll indicator to become fully visible. * + * @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. * - * @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 + * @brief Gets the duration in seconds 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() const; /** - * @brief Sets the duration in second for the scroll indicator to become fully invisible + * @brief Sets the duration in seconds for the scroll indicator to become fully invisible. * + * @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. * - * @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 + * @brief Gets the duration in seconds 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() const; /** - * @brief Shows the scroll indicator + * @brief Shows the scroll indicator. + * @SINCE_1_0.0 */ void ShowIndicator(); /** - * @brief Hides the scroll indicator + * @brief Hides the scroll indicator. + * @SINCE_1_0.0 */ void HideIndicator(); @@ -283,51 +367,59 @@ public: // Signals /** * @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(); * @endcode + * @SINCE_1_0.0 + * @return The signal to connect to * @pre The Object has been initialized. - * @return The signal to connect to. */ 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. - * @return The signal to connect to. */ ScrollBar::ScrollPositionIntervalReachedSignalType& ScrollPositionIntervalReachedSignal(); public: // Not intended for application developers + /// @cond internal /** - * Creates a handle using the Toolkit::Internal implementation. - * @param[in] implementation The Control 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. - * @param[in] internal A pointer to the internal CustomActor. + * @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__