[SRUK] Initial copy from Tizen 2.2 version
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / scrollable / scroll-view / scroll-view-carousel-effect-impl.h
1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_CAROUSEL_EFFECT_H__
2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_CAROUSEL_EFFECT_H__
3
4 //
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
6 //
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
10 //
11 //     http://floralicense.org/license/
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 // INTERNAL INCLUDES
21 #include <dali/public-api/animation/animation.h>
22 #include <dali/public-api/animation/alpha-functions.h>
23 #include <dali/public-api/animation/time-period.h>
24 #include <dali/public-api/object/ref-object.h>
25 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view.h>
26 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-effect.h>
27 #include <dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-view-carousel-effect.h>
28
29 namespace Dali
30 {
31
32 class Animation;
33
34 namespace Toolkit
35 {
36
37 class ScrollView;
38
39 namespace Internal
40 {
41
42 class ScrollViewEffect;
43
44 /**
45  * @copydoc Toolkit::ScrollViewCarouselEffect
46  */
47 class ScrollViewCarouselEffect : public ScrollViewEffect
48 {
49
50 public:
51
52   /**
53    * Constructor
54    */
55   ScrollViewCarouselEffect();
56
57 public:
58
59   /**
60    * @copydoc ScrollViewEffect::ApplyToActor
61    */
62   void ApplyToActor(Actor child, const Vector2& angleSwing);
63
64 public:
65
66   /**
67    * @copydoc ScrollViewEffect::OnAttach
68    */
69   virtual void OnAttach(Toolkit::ScrollView& scrollView);
70
71   /**
72    * @copydoc ScrollViewEffect::OnDetach
73    */
74   virtual void OnDetach(Toolkit::ScrollView& scrollView);
75
76 protected:
77
78   /**
79    * A reference counted object may only be deleted by calling Unreference()
80    */
81   virtual ~ScrollViewCarouselEffect();
82
83 private:
84
85   Property::Index mPropertyActivate;                      ///< Activation property (0.0 - deactivated, 1.0 - fully activated)
86
87 };
88
89 } // namespace Internal
90
91 // Helpers for public-api forwarding methods
92
93 inline Internal::ScrollViewCarouselEffect& GetImpl(Dali::Toolkit::ScrollViewCarouselEffect& obj)
94 {
95   DALI_ASSERT_ALWAYS(obj);
96
97   Dali::RefObject& handle = obj.GetBaseObject();
98
99   return static_cast<Internal::ScrollViewCarouselEffect&>(handle);
100 }
101
102 inline const Internal::ScrollViewCarouselEffect& GetImpl(const Dali::Toolkit::ScrollViewCarouselEffect& obj)
103 {
104   DALI_ASSERT_ALWAYS(obj);
105
106   const Dali::RefObject& handle = obj.GetBaseObject();
107
108   return static_cast<const Internal::ScrollViewCarouselEffect&>(handle);
109 }
110
111 } // namespace Toolkit
112
113 } // namespace Dali
114
115 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_VIEW_CAROUSEL_EFFECT_H__