X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fscrollable%2Fscroll-view%2Fscroll-view-effect.h;h=d6f340228fc35e7849da4c42a8d3b5e4da3eca4f;hb=d886d0a7b8637b2ad52844096091b63991157ff3;hp=3b2fb131ec17fb0aff3c06db4f0d7bd0b7ea9c17;hpb=e4e5db1d2d7997e7bf803a531048d8dcb959083b;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h old mode 100644 new mode 100755 index 3b2fb13..d6f3402 --- a/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h +++ b/dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__ -#define __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__ +#ifndef DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H +#define DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H /* - * Copyright (c) 2015 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. @@ -19,9 +19,11 @@ */ // EXTERNAL INCLUDES -#include #include +// INTERNAL INCLUDES +#include + namespace Dali { @@ -38,48 +40,56 @@ namespace Internal DALI_INTERNAL class ScrollViewEffect; class ScrollViewWobbleEffect; } +/** + * @addtogroup dali_toolkit_controls_scroll_view + * @{ + */ class ScrollView; class ScrollViewEffect; -typedef std::vector ScrollViewEffectContainer; ///< Container of Dali::Toolkit::ScrollViewEffect%s -typedef ScrollViewEffectContainer::iterator ScrollViewEffectIter; ///< Iterator for Dali::Toolkit::ScrollViewEffectContainer -typedef ScrollViewEffectContainer::const_iterator ScrollViewEffectConstIter; ///< Const Iterator for Dali::Toolkit::ScrollViewEffectContainer - /** * @brief ScrollView Effect base class, used to apply custom effects to a * ScrollView instance. * * Such effects are purely logical (i.e. physics), and may produce - * properties that can be used with visual effects. Such as creating + * properties that can be used with visual effects, such as creating * constraints that are applied to ShaderEffects or Actors using these * properties as inputs. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API ScrollViewEffect : public Dali::BaseHandle +class DALI_TOOLKIT_API ScrollViewEffect : public Dali::BaseHandle { public: /** - * @brief Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes. + * @brief Creates an uninitialized ScrollViewEffect; this can only be initialized with derived classes. * * Calling member functions with an uninitialized Toolkit::BaseObject is not allowed. + * @SINCE_1_0.0 */ ScrollViewEffect(); public: // Not intended for application developers + /// @cond internal /** * @brief This constructor is used by Dali New() methods. * - * @param [in] impl A pointer to a newly allocated Dali resource + * @SINCE_1_0.0 + * @param[in] impl A pointer to a newly allocated Dali resource */ explicit DALI_INTERNAL ScrollViewEffect(Internal::ScrollViewEffect *impl); + /// @endcond }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali -#endif // __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__ +#endif // DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H