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=d988212cc2be310078229a3403fbadc0c60de208;hp=dffb7a4f62473cd5e2b48b815a8aa1c1f0738023;hb=b694e7e2ae624e206e1548b1a863c554eb9cd4d7;hpb=caf7677175a0e8b9c690d4f2ab73adc295f22c0e 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 dffb7a4..d988212 100755 --- a/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h +++ b/dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_SCROLL_BAR_H__ -#define __DALI_TOOLKIT_SCROLL_BAR_H__ +#ifndef DALI_TOOLKIT_SCROLL_BAR_H +#define DALI_TOOLKIT_SCROLL_BAR_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 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. @@ -49,14 +49,14 @@ class ScrollBar; * | scrollPositionIntervalReached | @ref ScrollPositionIntervalReachedSignal() | * @SINCE_1_0.0 */ -class DALI_IMPORT_API ScrollBar : public Control +class DALI_TOOLKIT_API ScrollBar : public Control { 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 @@ -66,71 +66,96 @@ public: }; /** - * @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 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 */ enum { /** - * @brief name "scrollDirection", type std::string - * @see SetScrollDirection() + * @brief The scrolling direction of the indicator. + * @details Name "scrollDirection", type Property::STRING. + * Possible values are "Vertical" and "Horizontal". * @SINCE_1_0.0 + * @see SetScrollDirection() */ SCROLL_DIRECTION = PROPERTY_START_INDEX, + /** - * @brief name "indicatorHeightPolicy", type std::string - * @see SetIndicatorHeightPolicy() + * @brief The indicator height policy. + * @details Name "indicatorHeightPolicy", type Property::STRING. + * Possible values are "Variable" and "Fixed". * @SINCE_1_0.0 + * @see SetIndicatorHeightPolicy() */ INDICATOR_HEIGHT_POLICY, + /** - * @brief name "indicatorFixedHeight", type float - * @see SetIndicatorFixedHeight() + * @brief The fixed height of the indicator. + * @details Name "indicatorFixedHeight", type Property::FLOAT. * @SINCE_1_0.0 + * @see SetIndicatorFixedHeight() */ INDICATOR_FIXED_HEIGHT, + /** - * @brief name "indicatorShowDuration", type float - * @see SetIndicatorShowDuration() + * @brief The duration in seconds to show the indicator. + * @details Name "indicatorShowDuration", type Property::FLOAT. * @SINCE_1_0.0 + * @see SetIndicatorShowDuration() */ INDICATOR_SHOW_DURATION, + /** - * @brief name "indicatorHideDuration", type float - * @see SetIndicatorHideDuration() + * @brief The duration in seconds to hide the indicator. + * @details Name "indicatorHideDuration", type Property::FLOAT. * @SINCE_1_0.0 + * @see SetIndicatorHideDuration() */ INDICATOR_HIDE_DURATION, + /** - * @brief name "scrollPositionIntervals", type Property::Array - * @see SetScrollPositionIntervals() + * @brief The intervals at which point a notification is emitted. + * @details 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. + * @brief The minimum height for a variable size indicator. + * @details Name "indicatorMinimumHeight", type Property::FLOAT. * @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. + * @brief The padding at the start of the indicator. + * @details Name "indicatorStartPadding", type Property::FLOAT. + * For example, the padding at 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. + * @brief The padding at the end of the indicator. + * @details Name "indicatorEndPadding", type Property::FLOAT. + * For example, the padding at the bottom if scrollDirection is Vertical. * @SINCE_1_1.36 */ - INDICATOR_END_PADDING + INDICATOR_END_PADDING, + + /** + * @brief The duration that transient indicators will remain fully visible. + * @details name "indicatorTransientDuration", type Property::FLOAT. + * @SINCE_1_2.60 + */ + INDICATOR_TRANSIENT_DURATION, }; }; @@ -162,7 +187,7 @@ public: }; /** - * @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 */ @@ -184,7 +209,7 @@ public: 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 @@ -192,35 +217,34 @@ public: ~ScrollBar(); /** - * @brief Create an initialized 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. + * @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 a handle to ScrollBar handle. + * @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. + * 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. * * @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). + * @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 ); @@ -228,9 +252,8 @@ public: * @brief Sets the indicator of scroll bar. * * @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] indicator The indicator that moves to indicate the current scroll position + * @pre The scroll bar actor has been initialized. */ void SetScrollIndicator( Actor indicator ); @@ -238,9 +261,8 @@ public: * @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 + * @pre The scroll bar actor has been initialized. */ Actor GetScrollIndicator(); @@ -250,8 +272,7 @@ public: * * @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. - * + * @pre The scroll bar actor has been initialized. */ void SetScrollPositionIntervals( const Dali::Vector& positions ); @@ -261,7 +282,7 @@ public: * * @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. + * @pre The scroll bar actor has been initialized. * */ Dali::Vector GetScrollPositionIntervals() const; @@ -270,9 +291,8 @@ public: * @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. - * + * @param[in] direction The direction of scroll bar (either vertically or horizontally) + * @pre The scroll bar actor has been initialized. */ void SetScrollDirection( Direction direction ); @@ -280,7 +300,7 @@ public: * @brief Gets the direction of scroll bar. * * @SINCE_1_0.0 - * @return The direction of scroll bar. + * @return The direction of scroll bar */ Direction GetScrollDirection() const; @@ -289,8 +309,7 @@ public: * * @SINCE_1_0.0 * @param[in] policy The height policy of scroll indicator - * @pre The scroll bar actor has been initialised. - * + * @pre The scroll bar actor has been initialized. */ void SetIndicatorHeightPolicy( IndicatorHeightPolicy policy ); @@ -306,12 +325,12 @@ public: * @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. * * @SINCE_1_0.0 * @param[in] height The fixed height of the scroll indicator - * @pre The scroll bar actor has been initialised. + * @pre The scroll bar actor has been initialized. * */ void SetIndicatorFixedHeight( float height ); @@ -324,7 +343,7 @@ public: 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 @@ -334,14 +353,14 @@ public: 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 @@ -351,20 +370,20 @@ public: 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(); @@ -381,7 +400,7 @@ public: // Signals * void YourCallbackName(); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to * @pre The Object has been initialized. */ ScrollBar::PanFinishedSignalType& PanFinishedSignal(); @@ -397,7 +416,7 @@ public: // Signals * void YourCallbackName(float currentScrollPosition); * @endcode * @SINCE_1_0.0 - * @return The signal to connect to. + * @return The signal to connect to * @pre The Object has been initialized. */ ScrollBar::ScrollPositionIntervalReachedSignalType& ScrollPositionIntervalReachedSignal(); @@ -408,14 +427,14 @@ public: // Not intended for application developers /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 - * @param[in] implementation The Control implementation. + * @param[in] implementation The Control implementation */ DALI_INTERNAL ScrollBar( Internal::ScrollBar& implementation ); /** * @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. + * @param[in] internal A pointer to the internal CustomActor */ explicit DALI_INTERNAL ScrollBar( Dali::Internal::CustomActor* internal ); /// @endcond @@ -428,4 +447,4 @@ public: // Not intended for application developers } // namespace Dali -#endif // __DALI_TOOLKIT_SCROLL_BAR_H__ +#endif // DALI_TOOLKIT_SCROLL_BAR_H