1 #ifndef DALI_TOOLKIT_INTERNAL_SCROLLABLE_H
2 #define DALI_TOOLKIT_INTERNAL_SCROLLABLE_H
5 * Copyright (c) 2019 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/animation/alpha-function.h>
25 #include <dali-toolkit/public-api/controls/control-impl.h>
26 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
38 typedef IntrusivePtr<Scrollable> ScrollablePtr;
41 * @copydoc Toolkit::Scrollable
43 class Scrollable : public Control
48 * @copydoc Dali::Toolkit::Scrollable::IsOvershootEnabled
50 bool IsOvershootEnabled() const;
53 * @copydoc Dali::Toolkit::Scrollable::SetOvershootEnabled
55 void SetOvershootEnabled(bool enable);
58 * Adds actor as an Overlay to Scrollable
59 * This method is called by Add-on UI components
60 * such as scroll bars, page indicators.
61 * @param[in] actor Actor to add as an overlay.
63 virtual void AddOverlay(Actor actor) = 0;
66 * Removes overlay actor from Scrollable
67 * This method is called by Add-on UI components
68 * such as scroll bars, page indicators.
69 * @param[in] actor Actor overlay to remove.
71 virtual void RemoveOverlay(Actor actor) = 0;
74 * Retrieves current scroll position.
75 * @returns The current scroll position.
77 virtual Vector2 GetCurrentScrollPosition() const = 0;
80 * Scrolls Scrollable to position specified (contents will scroll to this position)
81 * Position 0,0 is the origin. Increasing X scrolls contents left, while
82 * increasing Y scrolls contents up.
83 * @param[in] position The position to scroll to.
84 * @param[in] duration The duration of the animation in seconds
86 virtual void ScrollTo(const Vector2 &position, float duration) = 0;
89 * Set the color of the overshoot effect.
90 * @parm[in] color The color of the overshoot effect
92 virtual void SetOvershootEffectColor( const Vector4& color ) = 0;
95 * Retrieve the color of the overshoot effect.
96 * @return The color of the overshoot effect.
98 Vector4 GetOvershootEffectColor() const;
101 * @copydoc Dali::Toolkit::Scrollable::SetOvershootAnimationSpeed(float pixelsPerSecond)
103 void SetOvershootAnimationSpeed( float pixelsPerSecond );
106 * @copydoc Dali::Toolkit::Scrollable::GetOvershootAnimationSpeed()
108 float GetOvershootAnimationSpeed() const;
111 * @copydoc Dali::Toolkit::Scrollable::GetOvershootSize()
113 const Vector2& GetOvershootSize() const;
116 * Set the size of the overshoot effect.
117 * @parm[in] size The size of the overshoot effect
119 virtual void SetOvershootSize( const Vector2& size ) = 0;
121 protected: // From Control
124 * @copydoc Control::OnInitialize
126 virtual void OnInitialize() override;
131 * Temporary function to override EnableScrollOvershoot functionality for overshoot
132 * Only ScrollView needs to override this as HQ has not requested disable functionality in ItemView
133 * @param[in] enable true to enable, false to disable overshoot indicator
135 virtual void EnableScrollOvershoot(bool enable) {}
140 * @copydoc Dali::Toolkit::Scrollable::ScrollStartedSignal()
142 Toolkit::Scrollable::ScrollStartedSignalType& ScrollStartedSignal();
145 * @copydoc Dali::Toolkit::Scrollable::ScrollUpdatedSignal()
147 Toolkit::Scrollable::ScrollUpdatedSignalType& ScrollUpdatedSignal();
150 * @copydoc Dali::Toolkit::Scrollable::ScrollCompletedSignal()
152 Toolkit::Scrollable::ScrollCompletedSignalType& ScrollCompletedSignal();
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 * Removed default constructor.
188 Scrollable() = delete;
191 * @brief Construct a new Scrollable.
193 * @param[in] behaviourFlags Flags to enable
195 Scrollable( ControlBehaviour behaviourFlags );
198 * A reference counted object may only be deleted by calling Unreference()
200 virtual ~Scrollable();
205 * Gets position property.
207 * @return The current position
209 Vector2 GetPropertyPosition() const;
214 Scrollable(const Scrollable&);
217 Scrollable& operator=(const Scrollable& rhs);
221 Vector4 mOvershootEffectColor; ///<The color of the overshoot bouncing effect
222 float mOvershootAnimationSpeed; ///<The speed of the overshoot animation (pixels per second)
223 Vector2 mOvershootSize; ///<The size of the overshoot effect
225 Dali::AlphaFunction::BuiltinFunction mScrollToAlphaFunction; ///< The ScrollTo() animations use this
227 Toolkit::Scrollable::ScrollStartedSignalType mScrollStartedSignal;
228 Toolkit::Scrollable::ScrollUpdatedSignalType mScrollUpdatedSignal;
229 Toolkit::Scrollable::ScrollCompletedSignalType mScrollCompletedSignal;
233 bool mOvershootEnabled:1;
236 } // namespace Internal
238 // Helpers for public-api forwarding methods
240 inline Toolkit::Internal::Scrollable& GetImpl(Toolkit::Scrollable& scrollable)
242 DALI_ASSERT_ALWAYS(scrollable);
244 Dali::RefObject& handle = scrollable.GetImplementation();
246 return static_cast<Toolkit::Internal::Scrollable&>(handle);
249 inline const Toolkit::Internal::Scrollable& GetImpl(const Toolkit::Scrollable& scrollable)
251 DALI_ASSERT_ALWAYS(scrollable);
253 const Dali::RefObject& handle = scrollable.GetImplementation();
255 return static_cast<const Toolkit::Internal::Scrollable&>(handle);
258 } // namespace Toolkit
262 #endif // DALI_TOOLKIT_INTERNAL_SCROLLABLE_H