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/public-api/common/map-wrapper.h>
25 #include <dali-toolkit/public-api/controls/control-impl.h>
26 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
27 #include <dali-toolkit/public-api/controls/scrollable/scroll-component-impl.h>
39 typedef IntrusivePtr<Scrollable> ScrollablePtr;
42 * @copydoc Toolkit::Scrollable
44 class Scrollable : public Control
49 * @copydoc Dali::Toolkit::Scrollable::IsScrollComponentEnabled(Scrollable::ScrollComponentType type)
51 bool IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const;
54 * @copydoc Dali::Toolkit::Scrollable::EnableScrollComponent(Scrollable::ScrollComponentType type)
56 void EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type);
59 * @copydoc Dali::Toolkit::Scrollable::DisableScrollComponent(Scrollable::ScrollComponentType type)
61 void DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type);
64 * Gets the size of the domain (minimum/maximum extents for each axis to scroll to)
65 * @return the domain size
67 virtual Vector3 GetDomainSize() const = 0;
70 * Adds actor as an Overlay to Scrollable
71 * This method is called by Add-on UI components
72 * such as scroll bars, page indicators.
73 * @param[in] actor Actor to add as an overlay.
75 virtual void AddOverlay(Actor actor) = 0;
78 * Removes overlay actor from Scrollable
79 * This method is called by Add-on UI components
80 * such as scroll bars, page indicators.
81 * @param[in] actor Actor overlay to remove.
83 virtual void RemoveOverlay(Actor actor) = 0;
86 * Retrieves current scroll position.
87 * @returns The current scroll position.
89 virtual Vector3 GetCurrentScrollPosition() const = 0;
92 * Scrolls Scrollable to position specified (contents will scroll to this position)
93 * Position 0,0 is the origin. Increasing X scrolls contents left, while
94 * increasing Y scrolls contents up.
95 * @param[in] position The position to scroll to.
96 * @param[in] duration The duration of the animation in seconds
98 virtual void ScrollTo(const Vector3 &position, float duration) = 0;
101 * Set the color of the overshoot effect.
102 * @parm[in] color The color of the overshoot effect
104 virtual void SetOvershootEffectColor( const Vector4& color ) = 0;
107 * Retrieve the color of the overshoot effect.
108 * @return The color of the overshoot effect.
110 Vector4 GetOvershootEffectColor() const;
113 * @copydoc Dali::Toolkit::Scrollable::SetOvershootAnimationSpeed(float pixelsPerSecond)
115 void SetOvershootAnimationSpeed( float pixelsPerSecond );
118 * @copydoc Dali::Toolkit::Scrollable::GetOvershootAnimationSpeed()
120 float GetOvershootAnimationSpeed() const;
125 * Temporary function to override EnableScrollComponent functionality for overshoot
126 * Only ScrollView needs to override this as HQ has not requested disable functionality in ItemView
127 * @param[in] enable true to enable, false to disable overshoot indicator
129 virtual void SetOvershootEnabled(bool enable) {}
134 * @copydoc Dali::Toolkit::Scrollable::ScrollStartedSignal()
136 Toolkit::Scrollable::ScrollStartedSignalType& ScrollStartedSignal();
139 * @copydoc Dali::Toolkit::Scrollable::ScrollUpdatedSignal()
141 Toolkit::Scrollable::ScrollUpdatedSignalType& ScrollUpdatedSignal();
144 * @copydoc Dali::Toolkit::Scrollable::ScrollCompletedSignal()
146 Toolkit::Scrollable::ScrollCompletedSignalType& ScrollCompletedSignal();
149 * Connects a callback function with the object's signals.
150 * @param[in] object The object providing the signal.
151 * @param[in] tracker Used to disconnect the signal.
152 * @param[in] signalName The signal to connect to.
153 * @param[in] functor A newly allocated FunctorDelegate.
154 * @return True if the signal was connected.
155 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
157 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
162 * Called when a property of an object of this type is set.
163 * @param[in] object The object whose property is set.
164 * @param[in] index The property index.
165 * @param[in] value The new property value.
167 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
170 * Called to retrieve a property of an object of this type.
171 * @param[in] object The object whose property is to be retrieved.
172 * @param[in] index The property index.
173 * @return The current value of the property.
175 static Property::Value GetProperty( BaseObject* object, Property::Index index );
180 * Construct a new Scrollable.
185 * @brief Construct a new Scrollable.
187 * @param[in] behaviourFlags Flags to enable
189 Scrollable( ControlBehaviour behaviourFlags );
192 * A reference counted object may only be deleted by calling Unreference()
194 virtual ~Scrollable();
199 * Gets position property.
201 * @return The current position
203 Vector3 GetPropertyPosition() const;
208 Scrollable(const Scrollable&);
211 Scrollable& operator=(const Scrollable& rhs);
214 * Helper to create an initialized ScrollComponent
215 * @param[in] scrollable reference to ScrollView implementation
216 * @param[in] type the type of scroll component to create.
217 * @return A pointer to the created ScrollComponent.
219 Toolkit::ScrollComponent NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type);
223 Vector4 mOvershootEffectColor; ///<The color of the overshoot bouncing effect
224 float mOvershootAnimationSpeed; ///<The speed of the overshoot animation (pixels per second)
226 std::map<Toolkit::Scrollable::ScrollComponentType, ScrollComponentPtr> mComponent; ///< ScrollComponent (such as a scrollbar/page indicator/status)
228 Toolkit::Scrollable::ScrollStartedSignalType mScrollStartedSignal;
229 Toolkit::Scrollable::ScrollUpdatedSignalType mScrollUpdatedSignal;
230 Toolkit::Scrollable::ScrollCompletedSignalType mScrollCompletedSignal;
234 typedef std::map<Toolkit::Scrollable::ScrollComponentType, ScrollComponentPtr> ComponentContainer;
235 typedef ComponentContainer::iterator ComponentIter;
237 ComponentContainer mComponents; ///< ScrollComponent (such as a scrollbar/page indicator/status)
238 bool mOvershootEnabled:1;
241 } // namespace Internal
243 // Helpers for public-api forwarding methods
245 inline Toolkit::Internal::Scrollable& GetImpl(Toolkit::Scrollable& scrollable)
247 DALI_ASSERT_ALWAYS(scrollable);
249 Dali::RefObject& handle = scrollable.GetImplementation();
251 return static_cast<Toolkit::Internal::Scrollable&>(handle);
254 inline const Toolkit::Internal::Scrollable& GetImpl(const Toolkit::Scrollable& scrollable)
256 DALI_ASSERT_ALWAYS(scrollable);
258 const Dali::RefObject& handle = scrollable.GetImplementation();
260 return static_cast<const Toolkit::Internal::Scrollable&>(handle);
263 } // namespace Toolkit
267 #endif // __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__