X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscroll-view%2Fscroll-view-page-path-effect.h;h=951298d88265b437ba10e79a05014802014df034;hb=13f73abbc38eb319e54c0c1310bb4aa43d86ce6d;hp=af59f833886a672c40cfb131faa4411e3f0bc778;hpb=dcf0eeebe1e683b311b675e93adcc21a0602e671;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h index af59f83..951298d 100644 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-page-path-effect.h @@ -35,12 +35,13 @@ namespace Internal DALI_INTERNAL class ScrollViewPagePathEffect; } /** - * @addtogroup dali-toolkit-controls-scroll-view + * @addtogroup dali_toolkit_controls_scroll_view * @{ */ /** - * ScrollView Page Path Effect. + * @brief ScrollView Page Path Effect. + * * This effect causes Actors to follow a given path. The opacity of the actor will be 0.0 at * the beginning of the path and will go to 1.0 as it is approximating to half of the path to return * to 0.0 at the end of the path @@ -59,6 +60,7 @@ class ScrollViewPagePathEffect; * * Automatic operation: * not implemented. + * @SINCE_1_0.0 */ class DALI_IMPORT_API ScrollViewPagePathEffect : public ScrollViewEffect { @@ -66,7 +68,8 @@ class DALI_IMPORT_API ScrollViewPagePathEffect : public ScrollViewEffect public: /** - * Create an initialized ScrollViewPagePathEffect. + * @brief Create an initialized ScrollViewPagePathEffect. + * @SINCE_1_0.0 * @param[in] path The path that will be used by the scroll effect * @param[in] forward Vector in page object space which will be aligned with the tangent of the path * @param[in] inputPropertyIndex Index of a property of the scroll-view which will be used as the input for the path. @@ -77,21 +80,26 @@ public: static ScrollViewPagePathEffect New(Path path, const Vector3& forward, Dali::Property::Index inputPropertyIndex, const Vector3& pageSize, unsigned int pageCount); /** - * Create an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New() + * @brief Create an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New() * Calling member functions with an uninitialized Toolkit::ScrollViewPagePathEffect is not allowed. + * @SINCE_1_0.0 */ ScrollViewPagePathEffect(); /** - * Downcast an Object handle to ScrollViewPagePathEffect. If handle points to a ScrollViewPagePathEffect the + * @brief Downcast a handle to ScrollViewPagePathEffect handle. + * + * If handle points to a ScrollViewPagePathEffect 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 ScrollViewPagePathEffect or an uninitialized handle */ static ScrollViewPagePathEffect DownCast( BaseHandle handle ); /** - * Manually apply effect to a page in the scroll-view. + * @brief Manually apply effect to a page in the scroll-view. + * @SINCE_1_0.0 * @param[in] page The page to be affected by this effect. * @param[in] pageOrder The order of the page in the scroll-view */ @@ -99,11 +107,14 @@ public: protected: + /// @cond internal /** - * This constructor is used by Dali New() methods. + * @brief This constructor is used by Dali New() methods. + * @SINCE_1_0.0 * @param [in] impl A pointer to a newly allocated Dali resource */ explicit DALI_INTERNAL ScrollViewPagePathEffect( Internal::ScrollViewPagePathEffect *impl ); + /// @endcond };