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=0639dd5e568548a37af1ace0c7fd01c4a1fd9c78;hp=dc42d9ff492f558b7c7de0d26795dfe3dbfee4a3;hb=6b7c807d4a72e4fae1bbcc7aa64c024f5f84944d;hpb=2eb0f016cf4d8a8282681283ae0e842c0c67bded 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 dc42d9f..0639dd5 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. @@ -73,12 +73,60 @@ public: { enum { - SCROLL_DIRECTION = PROPERTY_START_INDEX, ///< name "scrollDirection", @see SetScrollDirection(), type std::string @SINCE_1_0.0 - INDICATOR_HEIGHT_POLICY, ///< name "indicatorHeightPolicy", @see SetIndicatorHeightPolicy(), type std::string @SINCE_1_0.0 - INDICATOR_FIXED_HEIGHT, ///< name "indicatorFixedHeight", @see SetIndicatorFixedHeight(), type float @SINCE_1_0.0 - INDICATOR_SHOW_DURATION, ///< name "indicatorShowDuration", @see SetIndicatorShowDuration(), type float @SINCE_1_0.0 - INDICATOR_HIDE_DURATION, ///< name "indicatorHideDuration", @see SetIndicatorHideDuration(), type float @SINCE_1_0.0 - SCROLL_POSITION_INTERVALS ///< name "scrollPositionIntervals", @see SetScrollPositionIntervals() type Property::Array @SINCE_1_0.0 + /** + * @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 }; }; @@ -145,7 +193,9 @@ public: 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 @@ -247,6 +297,7 @@ 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 * regardless of the length of scroll content. @@ -315,6 +366,7 @@ 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: @@ -330,6 +382,7 @@ public: // Signals /** * @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: @@ -344,6 +397,7 @@ public: // Signals public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * @SINCE_1_0.0 @@ -357,6 +411,7 @@ public: // Not intended for application developers * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL ScrollBar( Dali::Internal::CustomActor* internal ); + /// @endcond }; /**