X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscroll-view%2Fscroll-view-page-path-effect.h;h=dc2369414d901003992977f84ec48ff48749abf4;hp=af59f833886a672c40cfb131faa4411e3f0bc778;hb=552e2979540e0ae7c11b70c78ef02e182cccbe2c;hpb=5c07fde9dd6a022e2080c871994499e56eff89aa 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..dc23694 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,15 +35,16 @@ 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 + * to 0.0 at the end of the path. * * * ScrollView @@ -59,6 +60,7 @@ class ScrollViewPagePathEffect; * * Automatic operation: * not implemented. + * @SINCE_1_0.0 */ class DALI_IMPORT_API ScrollViewPagePathEffect : public ScrollViewEffect { @@ -66,44 +68,53 @@ class DALI_IMPORT_API ScrollViewPagePathEffect : public ScrollViewEffect public: /** - * Create an initialized ScrollViewPagePathEffect. + * @brief Creates 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. + * @param[in] inputPropertyIndex Index of a property of the scroll-view which will be used as the input for the path * @param[in] pageSize Size of a page in the scrollview * @param[in] pageCount Total number of pages in the scrollview - * @return A handle to a newly allocated Dali resource. + * @return A handle to a newly allocated Dali resource */ 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 Creates 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 - * downcast produces valid handle. If not the returned handle is left uninitialized. + * @brief Downcasts 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 + * @return Handle to a ScrollViewPagePathEffect or an uninitialized handle */ static ScrollViewPagePathEffect DownCast( BaseHandle handle ); /** - * Manually apply effect to a page in the scroll-view. - * @param[in] page The page to be affected by this effect. - * @param[in] pageOrder The order of the 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 */ void ApplyToPage( Actor page, unsigned int pageOrder ); protected: + /// @cond internal /** - * This constructor is used by Dali New() methods. - * @param [in] impl A pointer to a newly allocated Dali resource + * @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 };