1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__
2 #define __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.0 (the License);
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://floralicense.org/license/
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an AS IS BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
21 * @addtogroup CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE
26 #include <dali/dali.h>
28 namespace Dali DALI_IMPORT_API
39 namespace Internal DALI_INTERNAL
41 class ScrollViewEffect;
42 class ScrollViewWobbleEffect;
46 class ScrollViewEffect;
48 typedef std::vector<ScrollViewEffect> ScrollViewEffectContainer; ///< Container of Dali::Toolkit::ScrollViewEffect%s
49 typedef ScrollViewEffectContainer::iterator ScrollViewEffectIter; ///< Iterator for Dali::Toolkit::ScrollViewEffectContainer
50 typedef ScrollViewEffectContainer::const_iterator ScrollViewEffectConstIter; ///< Const Iterator for Dali::Toolkit::ScrollViewEffectContainer
53 * @brief ScrollView Effect base class, used to apply custom effects to a
54 * ScrollView instance.
56 * Such effects are purely logical (i.e. physics), and may produce
57 * properties that can be used with visual effects. Such as creating
58 * constraints that are applied to ShaderEffects or Actors using these
59 * properties as inputs.
61 class ScrollViewEffect : public Dali::BaseHandle
67 * @brief Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes.
69 * Calling member functions with an uninitialized Toolkit::BaseObject is not allowed.
73 public: // Not intended for application developers
76 * @brief This constructor is used by Dali New() methods.
78 * @param [in] impl A pointer to a newly allocated Dali resource
80 ScrollViewEffect(Internal::ScrollViewEffect *impl);
84 } // namespace Toolkit
91 #endif // __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__