1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__
2 #define __DALI_TOOLKIT_INTERNAL_SCROLLABLE_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 #include <dali/dali.h>
23 #include <dali/public-api/common/map-wrapper.h>
26 #include <dali-toolkit/public-api/controls/control-impl.h>
27 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
28 #include <dali-toolkit/public-api/controls/scrollable/scroll-component-impl.h>
40 typedef IntrusivePtr<Scrollable> ScrollablePtr;
43 * @copydoc Toolkit::Scrollable
45 class Scrollable : public Control
48 static const std::string SCROLLABLE_CAN_SCROLL_VERTICAL;
49 static const std::string SCROLLABLE_CAN_SCROLL_HORIZONTAL;
52 * Create a new Scrollable.
53 * @return A public handle to the newly allocated Scrollable.
55 // static Dali::Toolkit::Scrollable New();
60 * @copydoc Dali::Toolkit::Scrollable::IsScrollComponentEnabled(Scrollable::ScrollComponentType type)
62 bool IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const;
65 * @copydoc Dali::Toolkit::Scrollable::EnableScrollComponent(Scrollable::ScrollComponentType type)
67 void EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type);
70 * @copydoc Dali::Toolkit::Scrollable::DisableScrollComponent(Scrollable::ScrollComponentType type)
72 void DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type);
75 * Gets the size of the domain (minimum/maximum extents for each axis to scroll to)
76 * @return the domain size
78 virtual Vector3 GetDomainSize() const = 0;
81 * Adds actor as an Overlay to Scrollable
82 * This method is called by Add-on UI components
83 * such as scroll bars, page indicators.
84 * @param[in] actor Actor to add as an overlay.
86 virtual void AddOverlay(Actor actor) = 0;
89 * Removes overlay actor from Scrollable
90 * This method is called by Add-on UI components
91 * such as scroll bars, page indicators.
92 * @param[in] actor Actor overlay to remove.
94 virtual void RemoveOverlay(Actor actor) = 0;
97 * Retrieves current scroll position.
98 * @returns The current scroll position.
100 virtual Vector3 GetCurrentScrollPosition() const = 0;
103 * Scrolls Scrollable to position specified (contents will scroll to this position)
104 * Position 0,0 is the origin. Increasing X scrolls contents left, while
105 * increasing Y scrolls contents up.
106 * @param[in] position The position to scroll to.
107 * @param[in] duration The duration of the animation in seconds
109 virtual void ScrollTo(const Vector3 &position, float duration) = 0;
112 * Set the color of the overshoot effect.
113 * @parm[in] color The color of the overshoot effect
115 virtual void SetOvershootEffectColor( const Vector4& color ) = 0;
118 * Retrieve the color of the overshoot effect.
119 * @return The color of the overshoot effect.
121 Vector4 GetOvershootEffectColor() const;
126 * Temporary function to override EnableScrollComponent functionality for overshoot
127 * Only ScrollView needs to override this as HQ has not requested disable functionality in ItemView
128 * @param[in] enable true to enable, false to disable overshoot indicator
130 virtual void SetOvershootEnabled(bool enable) {}
135 * @copydoc Dali::Toolkit::Scrollable::ScrollStartedSignal()
137 Toolkit::Scrollable::ScrollStartedSignalV2& ScrollStartedSignal();
140 * @copydoc Dali::Toolkit::Scrollable::ScrollUpdatedSignal()
142 Toolkit::Scrollable::ScrollUpdatedSignalV2& ScrollUpdatedSignal();
145 * @copydoc Dali::Toolkit::Scrollable::ScrollCompletedSignal()
147 Toolkit::Scrollable::ScrollCompletedSignalV2& ScrollCompletedSignal();
150 * @copydoc Dali::Toolkit::Scrollable::ScrollClampedSignal()
152 Toolkit::Scrollable::ScrollClampedSignalV2& ScrollClampedSignal();
155 * Connects a callback function with the object's signals.
156 * @param[in] object The object providing the signal.
157 * @param[in] tracker Used to disconnect the signal.
158 * @param[in] signalName The signal to connect to.
159 * @param[in] functor A newly allocated FunctorDelegate.
160 * @return True if the signal was connected.
161 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
163 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
168 * Called when a property of an object of this type is set.
169 * @param[in] object The object whose property is set.
170 * @param[in] index The property index.
171 * @param[in] value The new property value.
173 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
176 * Called to retrieve a property of an object of this type.
177 * @param[in] object The object whose property is to be retrieved.
178 * @param[in] index The property index.
179 * @return The current value of the property.
181 static Property::Value GetProperty( BaseObject* object, Property::Index index );
186 * Construct a new Scrollable.
191 * A reference counted object may only be deleted by calling Unreference()
193 virtual ~Scrollable();
196 * Register common properties
198 void RegisterCommonProperties();
203 * Gets position property.
205 * @return The current position
207 Vector3 GetPropertyPosition() const;
212 Scrollable(const Scrollable&);
215 Scrollable& operator=(const Scrollable& rhs);
218 * Helper to create an initialized ScrollComponent
219 * @param[in] scrollable reference to ScrollView implementation
220 * @param[in] type the type of scroll component to create.
221 * @return A pointer to the created ScrollComponent.
223 Toolkit::ScrollComponent NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type);
227 Vector4 mOvershootEffectColor; ///<The color of the overshoot bouncing effect
229 Property::Index mPropertyRelativePosition;///< Scroll Relative Position ("scroll-relative-position") [range from 0.0f - 1.0f in each axes]
230 Property::Index mPropertyPositionMin; ///< Scroll Domain Minimum ("position-min")
231 Property::Index mPropertyPositionMax; ///< Scroll Domain Maximum ("position-max")
232 Property::Index mPropertyScrollDirection; ///< Scroll direction ("scroll-direction")
233 Property::Index mPropertyCanScrollVertical; ///< Whether the current scroll domain is large enough to scroll vertically
234 Property::Index mPropertyCanScrollHorizontal; ///< Whether the current scroll domain is large enough to scroll horizontally
236 std::map<Toolkit::Scrollable::ScrollComponentType, ScrollComponentPtr> mComponent; ///< ScrollComponent (such as a scrollbar/page indicator/status)
238 Toolkit::Scrollable::ScrollStartedSignalV2 mScrollStartedSignalV2;
239 Toolkit::Scrollable::ScrollUpdatedSignalV2 mScrollUpdatedSignalV2;
240 Toolkit::Scrollable::ScrollCompletedSignalV2 mScrollCompletedSignalV2;
241 Toolkit::Scrollable::ScrollClampedSignalV2 mScrollClampedSignalV2;
245 typedef std::map<Toolkit::Scrollable::ScrollComponentType, ScrollComponentPtr> ComponentContainer;
246 typedef ComponentContainer::iterator ComponentIter;
248 ComponentContainer mComponents; ///< ScrollComponent (such as a scrollbar/page indicator/status)
249 bool mOvershootEnabled:1;
252 } // namespace Internal
254 // Helpers for public-api forwarding methods
256 inline Toolkit::Internal::Scrollable& GetImpl(Toolkit::Scrollable& scrollable)
258 DALI_ASSERT_ALWAYS(scrollable);
260 Dali::RefObject& handle = scrollable.GetImplementation();
262 return static_cast<Toolkit::Internal::Scrollable&>(handle);
265 inline const Toolkit::Internal::Scrollable& GetImpl(const Toolkit::Scrollable& scrollable)
267 DALI_ASSERT_ALWAYS(scrollable);
269 const Dali::RefObject& handle = scrollable.GetImplementation();
271 return static_cast<const Toolkit::Internal::Scrollable&>(handle);
274 } // namespace Toolkit
278 #endif // __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__