1 #ifndef DALI_TOOLKIT_INTERNAL_SCROLLABLE_H
2 #define DALI_TOOLKIT_INTERNAL_SCROLLABLE_H
5 * Copyright (c) 2021 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/internal/controls/control/control-data-impl.h>
26 #include <dali-toolkit/public-api/controls/control-impl.h>
27 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
36 typedef IntrusivePtr<Scrollable> ScrollablePtr;
39 * @copydoc Toolkit::Scrollable
41 class Scrollable : public Control
45 * @copydoc Dali::Toolkit::Scrollable::IsOvershootEnabled
47 bool IsOvershootEnabled() const;
50 * @copydoc Dali::Toolkit::Scrollable::SetOvershootEnabled
52 void SetOvershootEnabled(bool enable);
55 * Adds actor as an Overlay to Scrollable
56 * This method is called by Add-on UI components
57 * such as scroll bars, page indicators.
58 * @param[in] actor Actor to add as an overlay.
60 virtual void AddOverlay(Actor actor) = 0;
63 * Removes overlay actor from Scrollable
64 * This method is called by Add-on UI components
65 * such as scroll bars, page indicators.
66 * @param[in] actor Actor overlay to remove.
68 virtual void RemoveOverlay(Actor actor) = 0;
71 * Retrieves current scroll position.
72 * @returns The current scroll position.
74 virtual Vector2 GetCurrentScrollPosition() const = 0;
77 * Scrolls Scrollable to position specified (contents will scroll to this position)
78 * Position 0,0 is the origin. Increasing X scrolls contents left, while
79 * increasing Y scrolls contents up.
80 * @param[in] position The position to scroll to.
81 * @param[in] duration The duration of the animation in seconds
83 virtual void ScrollTo(const Vector2& position, float duration) = 0;
86 * Set the color of the overshoot effect.
87 * @parm[in] color The color of the overshoot effect
89 virtual void SetOvershootEffectColor(const Vector4& color) = 0;
92 * Retrieve the color of the overshoot effect.
93 * @return The color of the overshoot effect.
95 Vector4 GetOvershootEffectColor() const;
98 * @copydoc Dali::Toolkit::Scrollable::SetOvershootAnimationSpeed(float pixelsPerSecond)
100 void SetOvershootAnimationSpeed(float pixelsPerSecond);
103 * @copydoc Dali::Toolkit::Scrollable::GetOvershootAnimationSpeed()
105 float GetOvershootAnimationSpeed() const;
108 * @copydoc Dali::Toolkit::Scrollable::GetOvershootSize()
110 const Vector2& GetOvershootSize() const;
113 * Set the size of the overshoot effect.
114 * @parm[in] size The size of the overshoot effect
116 virtual void SetOvershootSize(const Vector2& size) = 0;
118 protected: // From Control
119 struct AccessibleImpl : public Control::Impl::AccessibleImpl
121 using Control::Impl::AccessibleImpl::AccessibleImpl;
123 bool IsScrollable() override;
127 * @copydoc Control::OnInitialize
129 virtual void OnInitialize() override;
133 * Temporary function to override EnableScrollOvershoot functionality for overshoot
134 * Only ScrollView needs to override this as HQ has not requested disable functionality in ItemView
135 * @param[in] enable true to enable, false to disable overshoot indicator
137 virtual void EnableScrollOvershoot(bool enable)
143 * @copydoc Dali::Toolkit::Scrollable::ScrollStartedSignal()
145 Toolkit::Scrollable::ScrollStartedSignalType& ScrollStartedSignal();
148 * @copydoc Dali::Toolkit::Scrollable::ScrollUpdatedSignal()
150 Toolkit::Scrollable::ScrollUpdatedSignalType& ScrollUpdatedSignal();
153 * @copydoc Dali::Toolkit::Scrollable::ScrollCompletedSignal()
155 Toolkit::Scrollable::ScrollCompletedSignalType& ScrollCompletedSignal();
158 * Connects a callback function with the object's signals.
159 * @param[in] object The object providing the signal.
160 * @param[in] tracker Used to disconnect the signal.
161 * @param[in] signalName The signal to connect to.
162 * @param[in] functor A newly allocated FunctorDelegate.
163 * @return True if the signal was connected.
164 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
166 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
171 * Called when a property of an object of this type is set.
172 * @param[in] object The object whose property is set.
173 * @param[in] index The property index.
174 * @param[in] value The new property value.
176 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
179 * Called to retrieve a property of an object of this type.
180 * @param[in] object The object whose property is to be retrieved.
181 * @param[in] index The property index.
182 * @return The current value of the property.
184 static Property::Value GetProperty(BaseObject* object, Property::Index index);
188 * Removed default constructor.
190 Scrollable() = delete;
193 * @brief Construct a new Scrollable.
195 * @param[in] behaviourFlags Flags to enable
197 Scrollable(ControlBehaviour behaviourFlags);
200 * A reference counted object may only be deleted by calling Unreference()
202 virtual ~Scrollable();
206 * Gets position property.
208 * @return The current position
210 Vector2 GetPropertyPosition() const;
214 Scrollable(const Scrollable&);
217 Scrollable& operator=(const Scrollable& rhs);
220 Vector4 mOvershootEffectColor; ///<The color of the overshoot bouncing effect
221 float mOvershootAnimationSpeed; ///<The speed of the overshoot animation (pixels per second)
222 Vector2 mOvershootSize; ///<The size of the overshoot effect
224 Dali::AlphaFunction::BuiltinFunction mScrollToAlphaFunction; ///< The ScrollTo() animations use this
226 Toolkit::Scrollable::ScrollStartedSignalType mScrollStartedSignal;
227 Toolkit::Scrollable::ScrollUpdatedSignalType mScrollUpdatedSignal;
228 Toolkit::Scrollable::ScrollCompletedSignalType mScrollCompletedSignal;
231 bool mOvershootEnabled : 1;
234 } // namespace Internal
236 // Helpers for public-api forwarding methods
238 inline Toolkit::Internal::Scrollable& GetImpl(Toolkit::Scrollable& scrollable)
240 DALI_ASSERT_ALWAYS(scrollable);
242 Dali::RefObject& handle = scrollable.GetImplementation();
244 return static_cast<Toolkit::Internal::Scrollable&>(handle);
247 inline const Toolkit::Internal::Scrollable& GetImpl(const Toolkit::Scrollable& scrollable)
249 DALI_ASSERT_ALWAYS(scrollable);
251 const Dali::RefObject& handle = scrollable.GetImplementation();
253 return static_cast<const Toolkit::Internal::Scrollable&>(handle);
256 } // namespace Toolkit
260 #endif // DALI_TOOLKIT_INTERNAL_SCROLLABLE_H