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 // EXTERNAL INCLUDES
  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/common/dali-vector.h>
  27 #include <dali/public-api/object/property-notification.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/public-api/controls/control-impl.h>
  31 #include <dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 class ScrollBar;
  43
  44 typedef IntrusivePtr<ScrollBar> ScrollBarPtr;
  45
  46 /**
  47  * ScrollBar is a UI component that can be added to the scrollable controls
  48  * indicating the current scroll position of the scrollable content.
  49  */
  50 class ScrollBar : public Control
  51 {
  52
  53 public:
  54
  55   // Signals
  56   typedef Toolkit::ScrollBar::PanFinishedSignalType PanFinishedSignalType;
  57   typedef Toolkit::ScrollBar::ScrollPositionIntervalReachedSignalType ScrollPositionIntervalReachedSignalType;
  58
  59 public:
  60
  61   /**
  62    * @copydoc Toolkit::ScrollBar::New()
  63    */
  64   static Toolkit::ScrollBar New(Toolkit::ScrollBar::Direction direction);
  65
  66   /**
  67    * @copydoc Toolkit::ScrollBar::SetScrollPropertySource()
  68    */
  69   void SetScrollPropertySource( Handle handle, Property::Index propertyScrollPosition, Property::Index propertyMinScrollPosition, Property::Index propertyMaxScrollPosition, Property::Index propertyScrollContentSize );
  70
  71   /**
  72    * @copydoc Toolkit::ScrollBar::SetScrollIndicator()
  73    */
  74   void SetScrollIndicator( Actor indicator );
  75
  76   /**
  77    * @copydoc Toolkit::ScrollBar::GetScrollIndicator()
  78    */
  79   Actor GetScrollIndicator();
  80
  81   /**
  82    * @copydoc Toolkit::ScrollBar::SetScrollPositionIntervals()
  83    */
  84   void SetScrollPositionIntervals( const Dali::Vector<float>& positions );
  85
  86   /**
  87    * @copydoc Toolkit::ScrollBar::GetScrollPositionIntervals()
  88    */
  89   Dali::Vector<float> GetScrollPositionIntervals() const;
  90
  91   /**
  92    * @copydoc Toolkit::ScrollBar::SetScrollDirection()
  93    */
  94   void SetScrollDirection( Toolkit::ScrollBar::Direction direction );
  95
  96   /**
  97    * @copydoc Toolkit::ScrollBar::GetScrollDirection()
  98    */
  99   Toolkit::ScrollBar::Direction GetScrollDirection() const;
 100
 101   /**
 102    * @copydoc Toolkit::ScrollBar::SetIndicatorHeightPolicy()
 103    */
 104   void SetIndicatorHeightPolicy( Toolkit::ScrollBar::IndicatorHeightPolicy policy );
 105
 106   /**
 107    * @copydoc Toolkit::ScrollBar::GetIndicatorHeightPolicy()
 108    */
 109   Toolkit::ScrollBar::IndicatorHeightPolicy GetIndicatorHeightPolicy() const;
 110
 111   /**
 112    * @copydoc Toolkit::ScrollBar::SetIndicatorFixedHeight()
 113    */
 114   void SetIndicatorFixedHeight( float height );
 115
 116   /**
 117    * @copydoc Toolkit::ScrollBar::GetIndicatorFixedHeight()
 118    */
 119   float GetIndicatorFixedHeight() const;
 120
 121   /**
 122    * @copydoc Toolkit::ScrollBar::SetIndicatorShowDuration()
 123    */
 124   void SetIndicatorShowDuration( float durationSeconds );
 125
 126   /**
 127    * @copydoc Toolkit::ScrollBar::GetIndicatorShowDuration()
 128    */
 129   float GetIndicatorShowDuration() const;
 130
 131   /**
 132    * @copydoc Toolkit::ScrollBar::SetIndicatorHideDuration()
 133    */
 134   void SetIndicatorHideDuration( float durationSeconds );
 135
 136   /**
 137    * @copydoc Toolkit::ScrollBar::GetIndicatorHideDuration()
 138    */
 139   float GetIndicatorHideDuration() const;
 140
 141   /**
 142    * @copydoc Toolkit::ScrollBar::ShowIndicator()
 143    */
 144   void ShowIndicator();
 145
 146   /**
 147    * @copydoc Toolkit::ScrollBar::HideIndicator()
 148    */
 149  void HideIndicator();
 150
 151  /**
 152   * @copydoc Toolkit::ScrollBar::PanFinishedSignal()
 153   */
 154  PanFinishedSignalType& PanFinishedSignal()
 155  {
 156    return mPanFinishedSignal;
 157  }
 158
 159  /**
 160   * @copydoc Toolkit::ScrollBar::ScrollPositionIntervalReachedSignal()
 161   */
 162  ScrollPositionIntervalReachedSignalType& ScrollPositionIntervalReachedSignal()
 163  {
 164    return mScrollPositionIntervalReachedSignal;
 165  }
 166
 167  /**
 168   * Connects a callback function with the object's signals.
 169   * @param[in] object The object providing the signal.
 170   * @param[in] tracker Used to disconnect the signal.
 171   * @param[in] signalName The signal to connect to.
 172   * @param[in] functor A newly allocated FunctorDelegate.
 173   * @return True if the signal was connected.
 174   * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 175   */
 176  static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 177
 178  // Properties
 179
 180  /**
 181   * Called when a property of an object of this type is set.
 182   * @param[in] object The object whose property is set.
 183   * @param[in] index The property index.
 184   * @param[in] value The new property value.
 185   */
 186  static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 187
 188  /**
 189   * Called to retrieve a property of an object of this type.
 190   * @param[in] object The object whose property is to be retrieved.
 191   * @param[in] index The property index.
 192   * @return The current value of the property.
 193   */
 194  static Property::Value GetProperty( BaseObject* object, Property::Index index );
 195
 196 private: // from Control
 197
 198   /**
 199    * @copydoc Toolkit::Control::OnInitialize
 200    */
 201   virtual void OnInitialize();
 202
 203   /**
 204    * @copydoc Toolkit::Control::OnPan
 205    */
 206   virtual void OnPan( const PanGesture& gesture );
 207
 208   /**
 209    * @copydoc CustomActorImpl::OnSizeSet( const Vector3& size )
 210    */
 211   virtual void OnSizeSet( const Vector3& size );
 212
 213 private:
 214
 215   /**
 216    * Create the default indicator actor.
 217    */
 218   void CreateDefaultIndicatorActor();
 219
 220   /**
 221    * Apply constraints for background and indicator.
 222    * These constraints are based on values from the scroll connector.
 223    */
 224   void ApplyConstraints();
 225
 226   /**
 227    * Callback when the current scroll position of the scrollable content goes above or
 228    * below the values specified by SetScrollPositionIntervals().
 229    * @param[in] source the property notification that triggered this callback
 230    */
 231   void OnScrollPositionIntervalReached(PropertyNotification& source);
 232
 233   /**
 234    * Process the pan gesture per predefined timeout until the gesture is finished.
 235    * @return True if the timer should be kept running.
 236    */
 237   bool OnPanGestureProcessTick();
 238
 239   /**
 240    * Handle SetProperty for scroll direction.
 241    * @param[in] propertyValue The new property value.
 242    */
 243   void OnScrollDirectionPropertySet(Property::Value propertyValue);
 244
 245   /**
 246    * Handle SetProperty for scroll indicator height policy.
 247    * @param[in] propertyValue The new property value.
 248    */
 249   void OnIndicatorHeightPolicyPropertySet(Property::Value propertyValue);
 250
 251 private:
 252
 253   /**
 254    * Constructor.
 255    * It initializes ScrollBar members.
 256    */
 257   ScrollBar( Toolkit::ScrollBar::Direction direction );
 258
 259   /**
 260    * A reference counted object may only be deleted by calling Unreference()
 261    */
 262   virtual ~ScrollBar();
 263
 264 private:
 265
 266   Actor mIndicator;                                                  ///< Image of scroll indicator.
 267   Animation mAnimation;                                              ///< Scroll indicator Show/Hide Animation.
 268
 269   Toolkit::ScrollBar::Direction mDirection;                          ///< The direction of scroll bar (vertical or horizontal)
 270
 271   Handle mScrollableObject;                                          ///< Object to be scrolled
 272
 273   Property::Index mPropertyScrollPosition;                           ///< Index of scroll position property owned by the object to be scrolled
 274   Property::Index mPropertyMinScrollPosition;                        ///< Index of minimum scroll position property owned by the object to be scrolled
 275   Property::Index mPropertyMaxScrollPosition;                        ///< Index of maximum scroll position property owned by the object to be scrolled
 276   Property::Index mPropertyScrollContentSize;                        ///< Index of scroll content size property owned by the object to be scrolled
 277
 278   float mIndicatorShowDuration;                                     ///< The duration of scroll indicator show animation
 279   float mIndicatorHideDuration;                                     ///< The duration of scroll indicator hide animation
 280
 281   float mScrollStart;                                                ///< Scroll Start position (start of drag)
 282   Vector3 mGestureDisplacement;                                      ///< Gesture Displacement.
 283
 284   bool mIsPanning;                                                  ///< Whether the scroll bar is being panned.
 285   float mCurrentScrollPosition;                                     ///< The current scroll position updated by the pan gesture
 286
 287   Toolkit::ScrollBar::IndicatorHeightPolicy mIndicatorHeightPolicy;  ///< The height policy of scroll indicator (variable or fixed)
 288   float mIndicatorFixedHeight;                                      ///< The fixed height of scroll indicator
 289
 290   Timer mContractDelayTimer;                                         ///< Timer guarantee contract delay time.
 291   Timer mPanProcessTimer;                                            ///< The timer to process the pan gesture after the gesture is started.
 292
 293   Dali::Vector<float> mScrollPositionIntervals;                     ///< List of values to receive notification for when the current scroll position goes above or below them
 294   PropertyNotification mPositionNotification;                        ///< Stores the property notification used for scroll position changes
 295
 296   PanFinishedSignalType mPanFinishedSignal;
 297   ScrollPositionIntervalReachedSignalType mScrollPositionIntervalReachedSignal;
 298
 299   Constraint mIndicatorPositionConstraint;
 300   Constraint mIndicatorSizeConstraint;
 301   Constraint mScrollPositionInCurrentAxisConstraint;
 302 };
 303
 304 } // namespace Internal
 305
 306 // Helpers for public-api forwarding methods
 307
 308 inline Toolkit::Internal::ScrollBar& GetImpl(Toolkit::ScrollBar& scrollBar)
 309 {
 310   DALI_ASSERT_ALWAYS(scrollBar);
 311
 312   Dali::RefObject& handle = scrollBar.GetImplementation();
 313
 314   return static_cast<Toolkit::Internal::ScrollBar&>(handle);
 315 }
 316
 317 inline const Toolkit::Internal::ScrollBar& GetImpl(const Toolkit::ScrollBar& scrollBar)
 318 {
 319   DALI_ASSERT_ALWAYS(scrollBar);
 320
 321   const Dali::RefObject& handle = scrollBar.GetImplementation();
 322
 323   return static_cast<const Toolkit::Internal::ScrollBar&>(handle);
 324 }
 325
 326 } // namespace Toolkit
 327
 328 } // namespace Dali
 329
 330 #endif // __DALI_TOOLKIT_INTERNAL_SCROLL_BAR_H__