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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control-impl.h>
  23 #include <dali-toolkit/public-api/controls/scrollable/scrollable.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Toolkit
  29 {
  30
  31 namespace Internal
  32 {
  33
  34 class Scrollable;
  35 typedef IntrusivePtr<Scrollable> ScrollablePtr;
  36
  37 /**
  38  * @copydoc Toolkit::Scrollable
  39  */
  40 class Scrollable : public Control
  41 {
  42 public:
  43
  44   /**
  45    * @copydoc Dali::Toolkit::Scrollable::IsOvershootEnabled
  46    */
  47   bool IsOvershootEnabled() const;
  48
  49   /**
  50    * @copydoc Dali::Toolkit::Scrollable::SetOvershootEnabled
  51    */
  52   void SetOvershootEnabled(bool enable);
  53
  54   /**
  55    * Gets the size of the domain (minimum/maximum extents for each axis to scroll to)
  56    * @return the domain size
  57    */
  58   virtual Vector2 GetDomainSize() const = 0;
  59
  60   /**
  61    * Adds actor as an Overlay to Scrollable
  62    * This method is called by Add-on UI components
  63    * such as scroll bars, page indicators.
  64    * @param[in] actor Actor to add as an overlay.
  65    */
  66   virtual void AddOverlay(Actor actor) = 0;
  67
  68   /**
  69    * Removes overlay actor from Scrollable
  70    * This method is called by Add-on UI components
  71    * such as scroll bars, page indicators.
  72    * @param[in] actor Actor overlay to remove.
  73    */
  74   virtual void RemoveOverlay(Actor actor) = 0;
  75
  76   /**
  77    * Retrieves current scroll position.
  78    * @returns The current scroll position.
  79    */
  80   virtual Vector2 GetCurrentScrollPosition() const = 0;
  81
  82   /**
  83    * Scrolls Scrollable to position specified (contents will scroll to this position)
  84    * Position 0,0 is the origin. Increasing X scrolls contents left, while
  85    * increasing Y scrolls contents up.
  86    * @param[in] position The position to scroll to.
  87    * @param[in] duration The duration of the animation in seconds
  88    */
  89   virtual void ScrollTo(const Vector2 &position, float duration) = 0;
  90
  91   /**
  92    * Set the color of the overshoot effect.
  93    * @parm[in] color The color of the overshoot effect
  94    */
  95   virtual void SetOvershootEffectColor( const Vector4& color ) = 0;
  96
  97   /**
  98    * Retrieve the color of the overshoot effect.
  99    * @return The color of the overshoot effect.
 100    */
 101   Vector4 GetOvershootEffectColor() const;
 102
 103   /**
 104    * @copydoc Dali::Toolkit::Scrollable::SetOvershootAnimationSpeed(float pixelsPerSecond)
 105    */
 106   void SetOvershootAnimationSpeed( float pixelsPerSecond );
 107
 108   /**
 109    * @copydoc Dali::Toolkit::Scrollable::GetOvershootAnimationSpeed()
 110    */
 111   float GetOvershootAnimationSpeed() const;
 112
 113 private:
 114
 115   /**
 116    * Temporary function to override EnableScrollOvershoot functionality for overshoot
 117    * Only ScrollView needs to override this as HQ has not requested disable functionality in ItemView
 118    * @param[in] enable true to enable, false to disable overshoot indicator
 119    */
 120   virtual void EnableScrollOvershoot(bool enable) {}
 121
 122 public: //Signals
 123
 124   /**
 125    * @copydoc Dali::Toolkit::Scrollable::ScrollStartedSignal()
 126    */
 127   Toolkit::Scrollable::ScrollStartedSignalType& ScrollStartedSignal();
 128
 129   /**
 130    * @copydoc Dali::Toolkit::Scrollable::ScrollUpdatedSignal()
 131    */
 132   Toolkit::Scrollable::ScrollUpdatedSignalType& ScrollUpdatedSignal();
 133
 134   /**
 135    * @copydoc Dali::Toolkit::Scrollable::ScrollCompletedSignal()
 136    */
 137   Toolkit::Scrollable::ScrollCompletedSignalType& ScrollCompletedSignal();
 138
 139   /**
 140    * Connects a callback function with the object's signals.
 141    * @param[in] object The object providing the signal.
 142    * @param[in] tracker Used to disconnect the signal.
 143    * @param[in] signalName The signal to connect to.
 144    * @param[in] functor A newly allocated FunctorDelegate.
 145    * @return True if the signal was connected.
 146    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 147    */
 148   static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
 149
 150   //properties
 151
 152   /**
 153    * Called when a property of an object of this type is set.
 154    * @param[in] object The object whose property is set.
 155    * @param[in] index The property index.
 156    * @param[in] value The new property value.
 157    */
 158   static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
 159
 160   /**
 161    * Called to retrieve a property of an object of this type.
 162    * @param[in] object The object whose property is to be retrieved.
 163    * @param[in] index The property index.
 164    * @return The current value of the property.
 165    */
 166   static Property::Value GetProperty( BaseObject* object, Property::Index index );
 167
 168 protected:
 169
 170   /**
 171    * Construct a new Scrollable.
 172    */
 173   Scrollable();
 174
 175   /**
 176    * @brief Construct a new Scrollable.
 177    *
 178    * @param[in] behaviourFlags Flags to enable
 179    */
 180   Scrollable( ControlBehaviour behaviourFlags );
 181
 182   /**
 183    * A reference counted object may only be deleted by calling Unreference()
 184    */
 185   virtual ~Scrollable();
 186
 187 private:
 188
 189   /**
 190    * Gets position property.
 191    *
 192    * @return The current position
 193    */
 194   Vector2 GetPropertyPosition() const;
 195
 196 private:
 197
 198   // Undefined
 199   Scrollable(const Scrollable&);
 200
 201   // Undefined
 202   Scrollable& operator=(const Scrollable& rhs);
 203
 204 protected:
 205
 206   Vector4         mOvershootEffectColor;    ///<The color of the overshoot bouncing effect
 207   float           mOvershootAnimationSpeed; ///<The speed of the overshoot animation (pixels per second)
 208
 209   Toolkit::Scrollable::ScrollStartedSignalType mScrollStartedSignal;
 210   Toolkit::Scrollable::ScrollUpdatedSignalType mScrollUpdatedSignal;
 211   Toolkit::Scrollable::ScrollCompletedSignalType mScrollCompletedSignal;
 212
 213 private:
 214
 215   bool mOvershootEnabled:1;
 216 };
 217
 218 } // namespace Internal
 219
 220 // Helpers for public-api forwarding methods
 221
 222 inline Toolkit::Internal::Scrollable& GetImpl(Toolkit::Scrollable& scrollable)
 223 {
 224   DALI_ASSERT_ALWAYS(scrollable);
 225
 226   Dali::RefObject& handle = scrollable.GetImplementation();
 227
 228   return static_cast<Toolkit::Internal::Scrollable&>(handle);
 229 }
 230
 231 inline const Toolkit::Internal::Scrollable& GetImpl(const Toolkit::Scrollable& scrollable)
 232 {
 233   DALI_ASSERT_ALWAYS(scrollable);
 234
 235   const Dali::RefObject& handle = scrollable.GetImplementation();
 236
 237   return static_cast<const Toolkit::Internal::Scrollable&>(handle);
 238 }
 239
 240 } // namespace Toolkit
 241
 242 } // namespace Dali
 243
 244 #endif // __DALI_TOOLKIT_INTERNAL_SCROLLABLE_H__