Merge "Add ALIASES for new DALi doxygen tagging rule to dali.doxy.in" into devel...
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / scrollable / scroll-view / scroll-view-effect.h
1 #ifndef __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__
2 #define __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__
3
4 /*
5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali/public-api/object/base-handle.h>
23
24 namespace Dali
25 {
26
27 struct Vector2;
28 struct Vector3;
29 struct Vector4;
30 class PropertyInput;
31
32 namespace Toolkit
33 {
34
35 namespace Internal DALI_INTERNAL
36 {
37 class ScrollViewEffect;
38 class ScrollViewWobbleEffect;
39 }
40 /**
41  * @addtogroup dali_toolkit_controls_scroll_view
42  * @{
43  */
44
45 class ScrollView;
46 class ScrollViewEffect;
47
48 /**
49  * @brief ScrollView Effect base class, used to apply custom effects to a
50  * ScrollView instance.
51  *
52  * Such effects are purely logical (i.e. physics), and may produce
53  * properties that can be used with visual effects.  Such as creating
54  * constraints that are applied to ShaderEffects or Actors using these
55  * properties as inputs.
56  */
57 class DALI_IMPORT_API ScrollViewEffect : public Dali::BaseHandle
58 {
59
60 public:
61
62   /**
63    * @brief Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes.
64    *
65    * Calling member functions with an uninitialized Toolkit::BaseObject is not allowed.
66    */
67   ScrollViewEffect();
68
69 public: // Not intended for application developers
70
71   /**
72    * @brief This constructor is used by Dali New() methods.
73    *
74    * @param [in] impl A pointer to a newly allocated Dali resource
75    */
76   explicit DALI_INTERNAL ScrollViewEffect(Internal::ScrollViewEffect *impl);
77
78 };
79
80 /**
81  * @}
82  */
83 } // namespace Toolkit
84
85 } // namespace Dali
86
87 #endif // __DALI_TOOLKIT_SCROLL_VIEW_EFFECT_H__