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 Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
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.
22 * @addtogroup CAPI_DALI_TOOLKIT_SCROLL_VIEW_MODULE
27 #include <dali/dali.h>
29 namespace Dali DALI_IMPORT_API
40 namespace Internal DALI_INTERNAL
42 class ScrollViewEffect;
43 class ScrollViewWobbleEffect;
47 class ScrollViewEffect;
49 typedef std::vector<ScrollViewEffect> ScrollViewEffectContainer; ///< Container of Dali::Toolkit::ScrollViewEffect%s
50 typedef ScrollViewEffectContainer::iterator ScrollViewEffectIter; ///< Iterator for Dali::Toolkit::ScrollViewEffectContainer
51 typedef ScrollViewEffectContainer::const_iterator ScrollViewEffectConstIter; ///< Const Iterator for Dali::Toolkit::ScrollViewEffectContainer
54 * @brief ScrollView Effect base class, used to apply custom effects to a
55 * ScrollView instance.
57 * Such effects are purely logical (i.e. physics), and may produce
58 * properties that can be used with visual effects. Such as creating
59 * constraints that are applied to ShaderEffects or Actors using these
60 * properties as inputs.
62 class ScrollViewEffect : public Dali::BaseHandle
68 * @brief Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes.
70 * Calling member functions with an uninitialized Toolkit::BaseObject is not allowed.
74 public: // Not intended for application developers
77 * @brief This constructor is used by Dali New() methods.
79 * @param [in] impl A pointer to a newly allocated Dali resource
81 ScrollViewEffect(Internal::ScrollViewEffect *impl);
85 } // namespace Toolkit
92 #endif // __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__