base/dali-toolkit/internal/controls/scrollable/scrollable-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__
   2 #define __DALI_TOOLKIT_INTERNAL_SCROLLABLE_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/common/map-wrapper.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/controls/control-impl.h>
  26 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
  27 #include <dali-toolkit/public-api/controls/scrollable/scroll-component-impl.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Internal
  36 {
  37
  38 class Scrollable;
  39 typedef IntrusivePtr<Scrollable> ScrollablePtr;
  40
  41 /**
  42  * @copydoc Toolkit::Scrollable
  43  */
  44 class Scrollable : public Control
  45 {
  46 public:
  47   static const std::string SCROLLABLE_CAN_SCROLL_VERTICAL;
  48   static const std::string SCROLLABLE_CAN_SCROLL_HORIZONTAL;
  49
  50   /**
  51    * Create a new Scrollable.
  52    * @return A public handle to the newly allocated Scrollable.
  53    */
  54 //  static Dali::Toolkit::Scrollable New();
  55
  56 public:
  57
  58   /**
  59    * @copydoc Dali::Toolkit::Scrollable::IsScrollComponentEnabled(Scrollable::ScrollComponentType type)
  60    */
  61   bool IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const;
  62
  63   /**
  64    * @copydoc Dali::Toolkit::Scrollable::EnableScrollComponent(Scrollable::ScrollComponentType type)
  65    */
  66   void EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type);
  67
  68   /**
  69    * @copydoc Dali::Toolkit::Scrollable::DisableScrollComponent(Scrollable::ScrollComponentType type)
  70    */
  71   void DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type);
  72
  73   /**
  74    * Gets the size of the domain (minimum/maximum extents for each axis to scroll to)
  75    * @return the domain size
  76    */
  77   virtual Vector3 GetDomainSize() const = 0;
  78
  79   /**
  80    * Adds actor as an Overlay to Scrollable
  81    * This method is called by Add-on UI components
  82    * such as scroll bars, page indicators.
  83    * @param[in] actor Actor to add as an overlay.
  84    */
  85   virtual void AddOverlay(Actor actor) = 0;
  86
  87   /**
  88    * Removes overlay actor from Scrollable
  89    * This method is called by Add-on UI components
  90    * such as scroll bars, page indicators.
  91    * @param[in] actor Actor overlay to remove.
  92    */
  93   virtual void RemoveOverlay(Actor actor) = 0;
  94
  95   /**
  96    * Retrieves current scroll position.
  97    * @returns The current scroll position.
  98    */
  99   virtual Vector3 GetCurrentScrollPosition() const = 0;
 100
 101   /**
 102    * Scrolls Scrollable to position specified (contents will scroll to this position)
 103    * Position 0,0 is the origin. Increasing X scrolls contents left, while
 104    * increasing Y scrolls contents up.
 105    * @param[in] position The position to scroll to.
 106    * @param[in] duration The duration of the animation in seconds
 107    */
 108   virtual void ScrollTo(const Vector3 &position, float duration) = 0;
 109
 110   /**
 111    * Set the color of the overshoot effect.
 112    * @parm[in] color The color of the overshoot effect
 113    */
 114   virtual void SetOvershootEffectColor( const Vector4& color ) = 0;
 115
 116   /**
 117    * Retrieve the color of the overshoot effect.
 118    * @return The color of the overshoot effect.
 119    */
 120   Vector4 GetOvershootEffectColor() const;
 121
 122   /**
 123    * @copydoc Dali::Toolkit::Scrollable::SetOvershootAnimationSpeed(float pixelsPerSecond)
 124    */
 125   void SetOvershootAnimationSpeed( float pixelsPerSecond );
 126
 127   /**
 128    * @copydoc Dali::Toolkit::Scrollable::GetOvershootAnimationSpeed()
 129    */
 130   float GetOvershootAnimationSpeed() const;
 131
 132 private:
 133
 134   /**
 135    * Temporary function to override EnableScrollComponent functionality for overshoot
 136    * Only ScrollView needs to override this as HQ has not requested disable functionality in ItemView
 137    * @param[in] enable true to enable, false to disable overshoot indicator
 138    */
 139   virtual void SetOvershootEnabled(bool enable) {}
 140
 141 public: //Signals
 142
 143   /**
 144    * @copydoc Dali::Toolkit::Scrollable::ScrollStartedSignal()
 145    */
 146   Toolkit::Scrollable::ScrollStartedSignalV2& ScrollStartedSignal();
 147
 148   /**
 149    * @copydoc Dali::Toolkit::Scrollable::ScrollUpdatedSignal()
 150    */
 151   Toolkit::Scrollable::ScrollUpdatedSignalV2& ScrollUpdatedSignal();
 152
 153   /**
 154    * @copydoc Dali::Toolkit::Scrollable::ScrollCompletedSignal()
 155    */
 156   Toolkit::Scrollable::ScrollCompletedSignalV2& ScrollCompletedSignal();
 157
 158   /**
 159    * @copydoc Dali::Toolkit::Scrollable::ScrollClampedSignal()
 160    */
 161   Toolkit::Scrollable::ScrollClampedSignalV2& ScrollClampedSignal();
 162
 163   /**
 164    * Connects a callback function with the object's signals.
 165    * @param[in] object The object providing the signal.
 166    * @param[in] tracker Used to disconnect the signal.
 167    * @param[in] signalName The signal to connect to.
 168    * @param[in] functor A newly allocated FunctorDelegate.
 169    * @return True if the signal was connected.
 170    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 171    */
 172   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 173
 174   //properties
 175
 176   /**
 177    * Called when a property of an object of this type is set.
 178    * @param[in] object The object whose property is set.
 179    * @param[in] index The property index.
 180    * @param[in] value The new property value.
 181    */
 182   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 183
 184   /**
 185    * Called to retrieve a property of an object of this type.
 186    * @param[in] object The object whose property is to be retrieved.
 187    * @param[in] index The property index.
 188    * @return The current value of the property.
 189    */
 190   static Property::Value GetProperty( BaseObject* object, Property::Index index );
 191
 192 protected:
 193
 194   /**
 195    * Construct a new Scrollable.
 196    */
 197   Scrollable();
 198
 199   /**
 200    * A reference counted object may only be deleted by calling Unreference()
 201    */
 202   virtual ~Scrollable();
 203
 204   /**
 205    * Register common properties
 206    */
 207   void RegisterCommonProperties();
 208
 209 private:
 210
 211   /**
 212    * Gets position property.
 213    *
 214    * @return The current position
 215    */
 216   Vector3 GetPropertyPosition() const;
 217
 218 private:
 219
 220   // Undefined
 221   Scrollable(const Scrollable&);
 222
 223   // Undefined
 224   Scrollable& operator=(const Scrollable& rhs);
 225
 226   /**
 227    * Helper to create an initialized ScrollComponent
 228    * @param[in] scrollable reference to ScrollView implementation
 229    * @param[in] type the type of scroll component to create.
 230    * @return A pointer to the created ScrollComponent.
 231    */
 232   Toolkit::ScrollComponent NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type);
 233
 234 protected:
 235
 236   Vector4         mOvershootEffectColor;    ///<The color of the overshoot bouncing effect
 237   float           mOvershootAnimationSpeed; ///<The speed of the overshoot animation (pixels per second)
 238
 239   Property::Index mPropertyRelativePosition;///< Scroll Relative Position ("scroll-relative-position") [range from 0.0f - 1.0f in each axes]
 240   Property::Index mPropertyPositionMin;     ///< Scroll Domain Minimum ("position-min")
 241   Property::Index mPropertyPositionMax;     ///< Scroll Domain Maximum ("position-max")
 242   Property::Index mPropertyScrollDirection; ///< Scroll direction ("scroll-direction")
 243   Property::Index mPropertyCanScrollVertical;    ///< Whether the current scroll domain is large enough to scroll vertically
 244   Property::Index mPropertyCanScrollHorizontal;    ///< Whether the current scroll domain is large enough to scroll horizontally
 245
 246   std::map<Toolkit::Scrollable::ScrollComponentType, ScrollComponentPtr> mComponent;  ///< ScrollComponent (such as a scrollbar/page indicator/status)
 247
 248   Toolkit::Scrollable::ScrollStartedSignalV2 mScrollStartedSignalV2;
 249   Toolkit::Scrollable::ScrollUpdatedSignalV2 mScrollUpdatedSignalV2;
 250   Toolkit::Scrollable::ScrollCompletedSignalV2 mScrollCompletedSignalV2;
 251   Toolkit::Scrollable::ScrollClampedSignalV2 mScrollClampedSignalV2;
 252
 253 private:
 254
 255   typedef std::map<Toolkit::Scrollable::ScrollComponentType, ScrollComponentPtr> ComponentContainer;
 256   typedef ComponentContainer::iterator ComponentIter;
 257
 258   ComponentContainer mComponents;  ///< ScrollComponent (such as a scrollbar/page indicator/status)
 259   bool mOvershootEnabled:1;
 260 };
 261
 262 } // namespace Internal
 263
 264 // Helpers for public-api forwarding methods
 265
 266 inline Toolkit::Internal::Scrollable& GetImpl(Toolkit::Scrollable& scrollable)
 267 {
 268   DALI_ASSERT_ALWAYS(scrollable);
 269
 270   Dali::RefObject& handle = scrollable.GetImplementation();
 271
 272   return static_cast<Toolkit::Internal::Scrollable&>(handle);
 273 }
 274
 275 inline const Toolkit::Internal::Scrollable& GetImpl(const Toolkit::Scrollable& scrollable)
 276 {
 277   DALI_ASSERT_ALWAYS(scrollable);
 278
 279   const Dali::RefObject& handle = scrollable.GetImplementation();
 280
 281   return static_cast<const Toolkit::Internal::Scrollable&>(handle);
 282 }
 283
 284 } // namespace Toolkit
 285
 286 } // namespace Dali
 287
 288 #endif // __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__