1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__
2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_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/adaptor-framework/timer.h>
23 #include <dali/public-api/actors/image-actor.h>
24 #include <dali/public-api/animation/constraint.h>
25 #include <dali/public-api/animation/animation.h>
26 #include <dali/public-api/object/property-notification.h>
29 #include <dali-toolkit/public-api/controls/scrollable/scroll-component-impl.h>
30 #include <dali-toolkit/public-api/controls/scrollable/scroll-connector.h>
31 #include <dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h>
44 typedef IntrusivePtr<ScrollBar> ScrollBarPtr;
47 * ScrollBar is a UI component that can be added to the scrollable controls
48 * indicating the current scroll position of the scrollable content.
50 class ScrollBar : public ScrollComponentImpl
56 typedef Toolkit::ScrollBar::ScrollPositionNotifiedSignalType ScrollPositionNotifiedSignalType;
61 * @copydoc Toolkit::ScrollBar::ScrollBar()
66 * @copydoc Toolkit::ScrollBar::~ScrollBar()
71 * @copydoc Toolkit::ScrollBar::New()
73 static Toolkit::ScrollBar New();
76 * @copydoc Toolkit::ScrollComponentImpl::OnScrollConnectorSet()
78 void OnScrollConnectorSet( Toolkit::ScrollConnector connector );
81 * @copydoc Toolkit::ScrollBar::SetIndicatorImage()
83 void SetIndicatorImage( Image image );
86 * @copydoc Toolkit::ScrollBar::GetScrollIndicator()
88 Actor GetScrollIndicator();
91 * @copydoc Toolkit::ScrollBar::SetPositionNotifications()
93 void SetPositionNotifications( const std::vector<float>& positions );
96 * @copydoc Toolkit::ScrollBar::SetIndicatorHeightPolicy()
98 void SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy );
101 * @copydoc Toolkit::ScrollBar::GetIndicatorHeightPolicy()
103 Toolkit::ScrollBar::IndicatorHeightPolicy GetIndicatorHeightPolicy();
106 * @copydoc Toolkit::ScrollBar::SetIndicatorFixedHeight()
108 void SetIndicatorFixedHeight( float height );
111 * @copydoc Toolkit::ScrollBar::GetIndicatorFixedHeight()
113 float GetIndicatorFixedHeight();
116 * @copydoc Toolkit::ScrollBar::SetIndicatorShowDuration()
118 void SetIndicatorShowDuration( float durationSeconds );
121 * @copydoc Toolkit::ScrollBar::GetIndicatorShowDuration()
123 float GetIndicatorShowDuration();
126 * @copydoc Toolkit::ScrollBar::SetIndicatorHideDuration()
128 void SetIndicatorHideDuration( float durationSeconds );
131 * @copydoc Toolkit::ScrollBar::GetIndicatorHideDuration()
133 float GetIndicatorHideDuration();
136 * @copydoc Toolkit::ScrollBar::Show()
141 * @copydoc Toolkit::ScrollBar::Hide()
146 * Signal emitted after the SetScrollDomain() method has been called.
148 ScrollPositionNotifiedSignalType& ScrollPositionNotifiedSignal()
150 return mScrollPositionNotifiedSignal;
154 * Connects a callback function with the object's signals.
155 * @param[in] object The object providing the signal.
156 * @param[in] tracker Used to disconnect the signal.
157 * @param[in] signalName The signal to connect to.
158 * @param[in] functor A newly allocated FunctorDelegate.
159 * @return True if the signal was connected.
160 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
162 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
167 * Called when a property of an object of this type is set.
168 * @param[in] object The object whose property is set.
169 * @param[in] index The property index.
170 * @param[in] value The new property value.
172 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
175 * Called to retrieve a property of an object of this type.
176 * @param[in] object The object whose property is to be retrieved.
177 * @param[in] index The property index.
178 * @return The current value of the property.
180 static Property::Value GetProperty( BaseObject* object, Property::Index index );
182 private: // from Control
185 * @copydoc Toolkit::Control::OnInitialize
187 virtual void OnInitialize();
190 * @copydoc Toolkit::Control::OnPan
192 virtual void OnPan( PanGesture gesture );
195 * @copydoc Toolkit::Control::OnControlSizeSet( const Vector3& size )
197 virtual void OnControlSizeSet( const Vector3& size );
202 * Apply constraints for background and indicator.
203 * These constraints are based on values from the scroll connector.
205 void ApplyConstraints();
208 * Callback when the start & end position and size of the scrollable content are changed.
209 * @param[in] minPosition The minimum position.
210 * @param[in] maxPosition The maximum position.
211 * @param[in] contentSize The size of scrollable content.
213 void OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize);
216 * Callback when the current scroll position of the scrollable content goes above or
217 * below the values specified by SetPositionNotifications().
218 * @param[in] source the property notification that triggered this callback
220 void OnScrollPositionNotified(PropertyNotification& source);
223 * Process the pan gesture per predefined timeout until the gesture is finished.
224 * @return True if the timer should be kept running.
226 bool OnPanGestureProcessTick();
229 * Handle SetProperty for scroll indicator height policy.
230 * @param[in] propertyValue The new property value.
232 void OnIndicatorHeightPolicyPropertySet(Property::Value propertyValue);
236 Handle mScrollPositionObject; ///< From mScrollConnector
238 ImageActor mIndicator; ///< Image of scroll indicator.
239 Animation mAnimation; ///< Scroll indicator Show/Hide Animation.
241 float mIndicatorShowDuration; ///< The duration of scroll indicator show animation
242 float mIndicatorHideDuration; ///< The duration of scroll indicator hide animation
244 float mScrollStart; ///< Scroll Start position (start of drag)
245 Vector3 mGestureDisplacement; ///< Gesture Displacement.
247 bool mIsPanning; ///< Whether the scroll bar is being panned.
248 float mCurrentScrollPosition; ///< The current scroll position updated by the pan gesture
250 Toolkit::ScrollBar::IndicatorHeightPolicy mIndicatorHeightPolicy; ///< The height policy of scroll indicator (variable or fixed)
251 float mIndicatorFixedHeight; ///< The fixed height of scroll indicator
253 Timer mTimer; ///< The timer to process the pan gesture after the gesture is started.
255 Property::Index mPropertyIndicatorPosition; ///< Indicatore Position ("indicator-position")
257 PropertyNotification mPositionNotification; ///< Stores the property notification used for scroll position changes
259 ScrollPositionNotifiedSignalType mScrollPositionNotifiedSignal;
261 Constraint mIndicatorPositionConstraint;
264 } // namespace Internal
266 // Helpers for public-api forwarding methods
268 inline Toolkit::Internal::ScrollBar& GetImpl(Toolkit::ScrollBar& scrollBar)
270 DALI_ASSERT_ALWAYS(scrollBar);
272 Dali::RefObject& handle = scrollBar.GetImplementation();
274 return static_cast<Toolkit::Internal::ScrollBar&>(handle);
277 inline const Toolkit::Internal::ScrollBar& GetImpl(const Toolkit::ScrollBar& scrollBar)
279 DALI_ASSERT_ALWAYS(scrollBar);
281 const Dali::RefObject& handle = scrollBar.GetImplementation();
283 return static_cast<const Toolkit::Internal::ScrollBar&>(handle);
286 } // namespace Toolkit
290 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__