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=b4c7ee3acd6967d08b86764c43976eb6bad1d971;hb=HEAD;hp=de7c64961c9145b2755046e8adaba66f6c8c7f14;hpb=2071317d301e9d5af326a3a2efcd2996263fbead;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 de7c649..b4c7ee3 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 @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__ -#define __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__ +#ifndef DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H +#define DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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. @@ -21,25 +21,31 @@ // INTERNAL INCLUDES #include +// INTERNAL INCLUDES +#include + namespace Dali { - class Actor; class Path; namespace Toolkit { - namespace Internal DALI_INTERNAL { class ScrollViewPagePathEffect; } +/** + * @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 @@ -55,56 +61,65 @@ class ScrollViewPagePathEffect; * * Automatic operation: * not implemented. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API ScrollViewPagePathEffect : public ScrollViewEffect +class DALI_TOOLKIT_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] pageSize Size of a page in the scrollview + * @param[in] inputPropertyIndex Index of a property of the scroll-view which will be used as the input for the path + * @param[in] viewPageSize 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); + static ScrollViewPagePathEffect New(Path path, const Vector3& forward, Dali::Property::Index inputPropertyIndex, const Vector3& viewPageSize, 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 ); + 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 ); + 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 ); - + explicit DALI_INTERNAL ScrollViewPagePathEffect(Internal::ScrollViewPagePathEffect* impl); + /// @endcond }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali -#endif // __DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H__ +#endif // DALI_TOOLKIT_SCROLL_VIEW_PAGE_PATH_EFFECT_H