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 Flora License, Version 1.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://floralicense.org/license/
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.
21 #include <dali-toolkit/public-api/controls/scrollable/scroll-component-impl.h>
22 #include <dali-toolkit/public-api/controls/scrollable/scroll-connector.h>
23 #include <dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h>
36 typedef IntrusivePtr<ScrollBar> ScrollBarPtr;
39 * ScrollBar is a UI component that can be added to the scrollable controls
40 * indicating the current scroll position of the scrollable content.
42 class ScrollBar : public ScrollComponentImpl
50 SCROLLBAR_PROPERTY_START_INDEX = ControlImpl::CONTROL_PROPERTY_END_INDEX + 1,
51 SCROLLBAR_PROPERTY_END_INDEX = SCROLLBAR_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices
55 typedef Toolkit::ScrollBar::ScrollPositionNotifiedSignalType ScrollPositionNotifiedSignalType;
60 * @copydoc Toolkit::ScrollBar::ScrollBar()
65 * @copydoc Toolkit::ScrollBar::~ScrollBar()
70 * @copydoc Toolkit::ScrollBar::New()
72 static Toolkit::ScrollBar New();
75 * @copydoc Toolkit::ScrollComponentImpl::OnScrollConnectorSet()
77 void OnScrollConnectorSet( Toolkit::ScrollConnector connector );
80 * @copydoc Toolkit::ScrollBar::SetBackgroundImage()
82 void SetBackgroundImage( Image image, const Vector4& border );
85 * @copydoc Toolkit::ScrollBar::SetIndicatorImage()
87 void SetIndicatorImage( Image image );
90 * @copydoc Toolkit::ScrollBar::SetIndicatorImage()
92 void SetIndicatorImage( Image image, const Vector4& border );
95 * @copydoc Toolkit::ScrollBar::GetScrollIndicator()
97 Actor GetScrollIndicator();
100 * @copydoc Toolkit::ScrollBar::SetPositionNotifications()
102 void SetPositionNotifications( const std::vector<float>& positions );
105 * @copydoc Toolkit::ScrollBar::SetIndicatorHeightPolicy()
107 void SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy );
110 * @copydoc Toolkit::ScrollBar::GetIndicatorHeightPolicy()
112 Toolkit::ScrollBar::IndicatorHeightPolicy GetIndicatorHeightPolicy();
115 * @copydoc Toolkit::ScrollBar::SetIndicatorFixedHeight()
117 void SetIndicatorFixedHeight( float height );
120 * @copydoc Toolkit::ScrollBar::GetIndicatorFixedHeight()
122 float GetIndicatorFixedHeight();
125 * @copydoc Toolkit::ScrollBar::Show()
130 * @copydoc Toolkit::ScrollBar::Hide()
135 * Signal emitted after the SetScrollDomain() method has been called.
137 ScrollPositionNotifiedSignalType& ScrollPositionNotifiedSignal()
139 return mScrollPositionNotifiedSignal;
145 * Called when a property of an object of this type is set.
146 * @param[in] object The object whose property is set.
147 * @param[in] index The property index.
148 * @param[in] value The new property value.
150 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
153 * Called to retrieve a property of an object of this type.
154 * @param[in] object The object whose property is to be retrieved.
155 * @param[in] index The property index.
156 * @return The current value of the property.
158 static Property::Value GetProperty( BaseObject* object, Property::Index index );
160 private: // from Control
163 * @copydoc Toolkit::Control::OnInitialize
165 virtual void OnInitialize();
168 * @copydoc Toolkit::Control::OnPan
170 virtual void OnPan( PanGesture gesture );
175 * Apply constraints for background and indicator.
176 * These constraints are based on values from the scroll connector.
178 void ApplyConstraints();
181 * Callback when the start & end position and size of the scrollable content are changed.
182 * @param[in] minPosition The minimum position.
183 * @param[in] maxPosition The maximum position.
184 * @param[in] contentSize The size of scrollable content.
186 void OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize);
189 * Callback when the current scroll position of the scrollable content goes above or
190 * below the values specified by SetPositionNotifications().
191 * @param[in] source the property notification that triggered this callback
193 void OnScrollPositionNotified(PropertyNotification& source);
196 * Process the pan gesture per predefined timeout until the gesture is finished.
197 * @return True if the timer should be kept running.
199 bool OnPanGestureProcessTick();
202 * Handle SetProperty for scroll indicator height policy.
203 * @param[in] propertyValue The new property value.
205 void OnIndicatorHeightPolicyPropertySet(Property::Value propertyValue);
209 Constrainable mScrollPositionObject; ///< From mScrollConnector
211 ImageActor mBackground; ///< Background image of scroll bar.
212 ImageActor mIndicator; ///< Image of scroll indicator.
213 Animation mAnimation; ///< Scroll indicator Show/Hide Animation.
215 float mScrollStart; ///< Scroll Start position (start of drag)
216 Vector3 mGestureDisplacement; ///< Gesture Displacement.
218 bool mIsPanning; ///< Whether the scroll bar is being panned.
219 float mCurrentScrollPosition; ///< The current scroll position updated by the pan gesture
221 Toolkit::ScrollBar::IndicatorHeightPolicy mIndicatorHeightPolicy; ///< The height policy of scroll indicator (variable or fixed)
222 float mIndicatorFixedHeight; ///< The fixed height of scroll indicator
224 Timer mTimer; ///< The timer to process the pan gesture after the gesture is started.
226 Property::Index mPropertyIndicatorPosition; ///< Indicatore Position ("indicator-position")
228 PropertyNotification mPositionNotification; ///< Stores the property notification used for scroll position changes
230 ScrollPositionNotifiedSignalType mScrollPositionNotifiedSignal;
232 ActiveConstraint mIndicatorSizeConstraint;
233 ActiveConstraint mIndicatorPositionConstraint;
236 } // namespace Internal
238 // Helpers for public-api forwarding methods
240 inline Toolkit::Internal::ScrollBar& GetImpl(Toolkit::ScrollBar& scrollBar)
242 DALI_ASSERT_ALWAYS(scrollBar);
244 Dali::RefObject& handle = scrollBar.GetImplementation();
246 return static_cast<Toolkit::Internal::ScrollBar&>(handle);
249 inline const Toolkit::Internal::ScrollBar& GetImpl(const Toolkit::ScrollBar& scrollBar)
251 DALI_ASSERT_ALWAYS(scrollBar);
253 const Dali::RefObject& handle = scrollBar.GetImplementation();
255 return static_cast<const Toolkit::Internal::ScrollBar&>(handle);
258 } // namespace Toolkit
262 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__