base/dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__
   2 #define __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/scrollable/scroll-component-impl.h>
  23 #include <dali-toolkit/public-api/controls/scrollable/scroll-connector.h>
  24 #include <dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Toolkit
  30 {
  31
  32 namespace Internal
  33 {
  34
  35 class ScrollBar;
  36
  37 typedef IntrusivePtr<ScrollBar> ScrollBarPtr;
  38
  39 /**
  40  * ScrollBar is a UI component that can be added to the scrollable controls
  41  * indicating the current scroll position of the scrollable content.
  42  */
  43 class ScrollBar : public ScrollComponentImpl
  44 {
  45
  46 public:
  47
  48   // Properties
  49   enum
  50   {
  51     SCROLLBAR_PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  52     SCROLLBAR_PROPERTY_END_INDEX = SCROLLBAR_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices
  53   };
  54
  55   // Signals
  56   typedef Toolkit::ScrollBar::ScrollPositionNotifiedSignalType ScrollPositionNotifiedSignalType;
  57
  58 public:
  59
  60   /**
  61    * @copydoc Toolkit::ScrollBar::ScrollBar()
  62    */
  63   ScrollBar();
  64
  65   /**
  66    * @copydoc Toolkit::ScrollBar::~ScrollBar()
  67    */
  68   virtual ~ScrollBar();
  69
  70   /**
  71    * @copydoc Toolkit::ScrollBar::New()
  72    */
  73   static Toolkit::ScrollBar New();
  74
  75   /**
  76    * @copydoc Toolkit::ScrollComponentImpl::OnScrollConnectorSet()
  77    */
  78   void OnScrollConnectorSet( Toolkit::ScrollConnector connector );
  79
  80   /**
  81    * @copydoc Toolkit::ScrollBar::SetIndicatorImage()
  82    */
  83   void SetIndicatorImage( Image image );
  84
  85   /**
  86    * @copydoc Toolkit::ScrollBar::GetScrollIndicator()
  87    */
  88   Actor GetScrollIndicator();
  89
  90   /**
  91    * @copydoc Toolkit::ScrollBar::SetPositionNotifications()
  92    */
  93   void SetPositionNotifications( const std::vector<float>& positions );
  94
  95   /**
  96    * @copydoc Toolkit::ScrollBar::SetIndicatorHeightPolicy()
  97    */
  98   void SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy );
  99
 100   /**
 101    * @copydoc Toolkit::ScrollBar::GetIndicatorHeightPolicy()
 102    */
 103   Toolkit::ScrollBar::IndicatorHeightPolicy GetIndicatorHeightPolicy();
 104
 105   /**
 106    * @copydoc Toolkit::ScrollBar::SetIndicatorFixedHeight()
 107    */
 108   void SetIndicatorFixedHeight( float height );
 109
 110   /**
 111    * @copydoc Toolkit::ScrollBar::GetIndicatorFixedHeight()
 112    */
 113   float GetIndicatorFixedHeight();
 114
 115   /**
 116    * @copydoc Toolkit::ScrollBar::SetIndicatorShowDuration()
 117    */
 118   void SetIndicatorShowDuration( float durationSeconds );
 119
 120   /**
 121    * @copydoc Toolkit::ScrollBar::GetIndicatorShowDuration()
 122    */
 123   float GetIndicatorShowDuration();
 124
 125   /**
 126    * @copydoc Toolkit::ScrollBar::SetIndicatorHideDuration()
 127    */
 128   void SetIndicatorHideDuration( float durationSeconds );
 129
 130   /**
 131    * @copydoc Toolkit::ScrollBar::GetIndicatorHideDuration()
 132    */
 133   float GetIndicatorHideDuration();
 134
 135   /**
 136    * @copydoc Toolkit::ScrollBar::Show()
 137    */
 138   void Show();
 139
 140   /**
 141    * @copydoc Toolkit::ScrollBar::Hide()
 142    */
 143  void Hide();
 144
 145  /**
 146   * Signal emitted after the SetScrollDomain() method has been called.
 147   */
 148  ScrollPositionNotifiedSignalType& ScrollPositionNotifiedSignal()
 149  {
 150    return mScrollPositionNotifiedSignal;
 151  }
 152
 153  // Properties
 154
 155  /**
 156   * Called when a property of an object of this type is set.
 157   * @param[in] object The object whose property is set.
 158   * @param[in] index The property index.
 159   * @param[in] value The new property value.
 160   */
 161  static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 162
 163  /**
 164   * Called to retrieve a property of an object of this type.
 165   * @param[in] object The object whose property is to be retrieved.
 166   * @param[in] index The property index.
 167   * @return The current value of the property.
 168   */
 169  static Property::Value GetProperty( BaseObject* object, Property::Index index );
 170
 171 private: // from Control
 172
 173   /**
 174    * @copydoc Toolkit::Control::OnInitialize
 175    */
 176   virtual void OnInitialize();
 177
 178   /**
 179    * @copydoc Toolkit::Control::OnPan
 180    */
 181   virtual void OnPan( PanGesture gesture );
 182
 183 private:
 184
 185   /**
 186    * Apply constraints for background and indicator.
 187    * These constraints are based on values from the scroll connector.
 188    */
 189   void ApplyConstraints();
 190
 191   /**
 192    * Callback when the start & end position and size of the scrollable content are changed.
 193    * @param[in] minPosition The minimum position.
 194    * @param[in] maxPosition The maximum position.
 195    * @param[in] contentSize The size of scrollable content.
 196    */
 197   void OnScrollDomainChanged(float minPosition, float maxPosition, float contentSize);
 198
 199   /**
 200    * Callback when the current scroll position of the scrollable content goes above or
 201    * below the values specified by SetPositionNotifications().
 202    * @param[in] source the property notification that triggered this callback
 203    */
 204   void OnScrollPositionNotified(PropertyNotification& source);
 205
 206   /**
 207    * Process the pan gesture per predefined timeout until the gesture is finished.
 208    * @return True if the timer should be kept running.
 209    */
 210   bool OnPanGestureProcessTick();
 211
 212   /**
 213    * Handle SetProperty for scroll indicator height policy.
 214    * @param[in] propertyValue The new property value.
 215    */
 216   void OnIndicatorHeightPolicyPropertySet(Property::Value propertyValue);
 217
 218 private:
 219
 220   Constrainable mScrollPositionObject;                               ///< From mScrollConnector
 221
 222   ImageActor mBackground;                                            ///< Background image of scroll bar.
 223   ImageActor mIndicator;                                             ///< Image of scroll indicator.
 224   Animation mAnimation;                                              ///< Scroll indicator Show/Hide Animation.
 225
 226   float mIndicatorShowDuration;                                     ///< The duration of scroll indicator show animation
 227   float mIndicatorHideDuration;                                     ///< The duration of scroll indicator hide animation
 228
 229   float mScrollStart;                                               ///< Scroll Start position (start of drag)
 230   Vector3 mGestureDisplacement;                                      ///< Gesture Displacement.
 231
 232   bool mIsPanning;                                                  ///< Whether the scroll bar is being panned.
 233   float mCurrentScrollPosition;                                     ///< The current scroll position updated by the pan gesture
 234
 235   Toolkit::ScrollBar::IndicatorHeightPolicy mIndicatorHeightPolicy;  ///< The height policy of scroll indicator (variable or fixed)
 236   float mIndicatorFixedHeight;                                      ///< The fixed height of scroll indicator
 237
 238   Timer mTimer;                                                      ///< The timer to process the pan gesture after the gesture is started.
 239
 240   Property::Index mPropertyIndicatorPosition;                        ///< Indicatore Position ("indicator-position")
 241
 242   PropertyNotification mPositionNotification;                        ///< Stores the property notification used for scroll position changes
 243
 244   ScrollPositionNotifiedSignalType mScrollPositionNotifiedSignal;
 245
 246   ActiveConstraint mIndicatorSizeConstraint;
 247   ActiveConstraint mIndicatorPositionConstraint;
 248 };
 249
 250 } // namespace Internal
 251
 252 // Helpers for public-api forwarding methods
 253
 254 inline Toolkit::Internal::ScrollBar& GetImpl(Toolkit::ScrollBar& scrollBar)
 255 {
 256   DALI_ASSERT_ALWAYS(scrollBar);
 257
 258   Dali::RefObject& handle = scrollBar.GetImplementation();
 259
 260   return static_cast<Toolkit::Internal::ScrollBar&>(handle);
 261 }
 262
 263 inline const Toolkit::Internal::ScrollBar& GetImpl(const Toolkit::ScrollBar& scrollBar)
 264 {
 265   DALI_ASSERT_ALWAYS(scrollBar);
 266
 267   const Dali::RefObject& handle = scrollBar.GetImplementation();
 268
 269   return static_cast<const Toolkit::Internal::ScrollBar&>(handle);
 270 }
 271
 272 } // namespace Toolkit
 273
 274 } // namespace Dali
 275
 276 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__