dali-toolkit/internal/controls/scrollable/scrollable-impl.cpp

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // EXTERNAL INCLUDES
  19 #include <dali/public-api/object/type-registry-helper.h>
  20 #include <dali/public-api/object/type-registry.h>
  21 #include <cstring> // for strcmp
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  25 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
  26
  27 using namespace Dali;
  28
  29 namespace Dali
  30 {
  31 namespace Toolkit
  32 {
  33 namespace Internal
  34 {
  35 namespace
  36 {
  37 BaseHandle Create()
  38 {
  39   // empty handle as we cannot create Scrollable (but type registered for scroll signal)
  40   return BaseHandle();
  41 }
  42
  43 // Setup properties, signals and actions using the type-registry.
  44 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::Scrollable, Toolkit::Control, Create);
  45
  46 DALI_PROPERTY_REGISTRATION(Toolkit, Scrollable, "overshootEffectColor", VECTOR4, OVERSHOOT_EFFECT_COLOR)
  47 DALI_PROPERTY_REGISTRATION(Toolkit, Scrollable, "overshootAnimationSpeed", FLOAT, OVERSHOOT_ANIMATION_SPEED)
  48 DALI_PROPERTY_REGISTRATION(Toolkit, Scrollable, "overshootEnabled", BOOLEAN, OVERSHOOT_ENABLED)
  49 DALI_PROPERTY_REGISTRATION(Toolkit, Scrollable, "overshootSize", VECTOR2, OVERSHOOT_SIZE)
  50 DALI_PROPERTY_REGISTRATION(Toolkit, Scrollable, "scrollToAlphaFunction", INTEGER, SCROLL_TO_ALPHA_FUNCTION)
  51
  52 DALI_ANIMATABLE_PROPERTY_REGISTRATION(Toolkit, Scrollable, "scrollRelativePosition", VECTOR2, SCROLL_RELATIVE_POSITION)
  53 DALI_ANIMATABLE_PROPERTY_REGISTRATION(Toolkit, Scrollable, "scrollPositionMin", VECTOR2, SCROLL_POSITION_MIN)
  54 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, Scrollable, "scrollPositionMinX", SCROLL_POSITION_MIN_X, SCROLL_POSITION_MIN, 0)
  55 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, Scrollable, "scrollPositionMinY", SCROLL_POSITION_MIN_Y, SCROLL_POSITION_MIN, 1)
  56 DALI_ANIMATABLE_PROPERTY_REGISTRATION(Toolkit, Scrollable, "scrollPositionMax", VECTOR2, SCROLL_POSITION_MAX)
  57 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, Scrollable, "scrollPositionMaxX", SCROLL_POSITION_MAX_X, SCROLL_POSITION_MAX, 0)
  58 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION(Toolkit, Scrollable, "scrollPositionMaxY", SCROLL_POSITION_MAX_Y, SCROLL_POSITION_MAX, 1)
  59 DALI_ANIMATABLE_PROPERTY_REGISTRATION(Toolkit, Scrollable, "canScrollVertical", BOOLEAN, CAN_SCROLL_VERTICAL)
  60 DALI_ANIMATABLE_PROPERTY_REGISTRATION(Toolkit, Scrollable, "canScrollHorizontal", BOOLEAN, CAN_SCROLL_HORIZONTAL)
  61
  62 DALI_SIGNAL_REGISTRATION(Toolkit, Scrollable, "scrollStarted", SIGNAL_SCROLL_STARTED)
  63 DALI_SIGNAL_REGISTRATION(Toolkit, Scrollable, "scrollCompleted", SIGNAL_SCROLL_COMPLETED)
  64 DALI_SIGNAL_REGISTRATION(Toolkit, Scrollable, "scrollUpdated", SIGNAL_SCROLL_UPDATED)
  65
  66 DALI_TYPE_REGISTRATION_END()
  67
  68 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
  69 const float   DEFAULT_OVERSHOOT_ANIMATION_SPEED(120.0f); // 120 pixels per second
  70 const Vector2 OVERSHOOT_DEFAULT_SIZE(720.0f, 42.0f);
  71
  72 } // namespace
  73
  74 ///////////////////////////////////////////////////////////////////////////////////////////////////
  75 // Scrollable
  76 ///////////////////////////////////////////////////////////////////////////////////////////////////
  77
  78 Scrollable::Scrollable(ControlBehaviour behaviourFlags)
  79 : Control(ControlBehaviour(behaviourFlags)),
  80   mOvershootEffectColor(DEFAULT_OVERSHOOT_COLOUR),
  81   mOvershootAnimationSpeed(DEFAULT_OVERSHOOT_ANIMATION_SPEED),
  82   mOvershootSize(OVERSHOOT_DEFAULT_SIZE),
  83   mScrollToAlphaFunction(AlphaFunction::EASE_OUT),
  84   mScrollStartedSignal(),
  85   mScrollUpdatedSignal(),
  86   mScrollCompletedSignal(),
  87   mOvershootEnabled(true)
  88 {
  89 }
  90
  91 Scrollable::~Scrollable()
  92 {
  93 }
  94
  95 bool Scrollable::ScrollableAccessible::IsScrollable() const
  96 {
  97   return true;
  98 }
  99
 100 void Scrollable::OnInitialize()
 101 {
 102   Self().SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::SCROLL_PANE);
 103 }
 104
 105 DevelControl::ControlAccessible* Scrollable::CreateAccessibleObject()
 106 {
 107   return new ScrollableAccessible(Self());
 108 }
 109
 110 bool Scrollable::IsOvershootEnabled() const
 111 {
 112   return mOvershootEnabled;
 113 }
 114
 115 void Scrollable::SetOvershootEnabled(bool enable)
 116 {
 117   EnableScrollOvershoot(enable);
 118   mOvershootEnabled = enable;
 119 }
 120
 121 Vector4 Scrollable::GetOvershootEffectColor() const
 122 {
 123   return mOvershootEffectColor;
 124 };
 125
 126 void Scrollable::SetOvershootAnimationSpeed(float pixelsPerSecond)
 127 {
 128   mOvershootAnimationSpeed = pixelsPerSecond;
 129 }
 130
 131 float Scrollable::GetOvershootAnimationSpeed() const
 132 {
 133   return mOvershootAnimationSpeed;
 134 };
 135
 136 const Vector2& Scrollable::GetOvershootSize() const
 137 {
 138   return mOvershootSize;
 139 }
 140
 141 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
 142 {
 143   return mScrollStartedSignal;
 144 }
 145
 146 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
 147 {
 148   return mScrollUpdatedSignal;
 149 }
 150
 151 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
 152 {
 153   return mScrollCompletedSignal;
 154 }
 155
 156 bool Scrollable::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
 157 {
 158   Dali::BaseHandle handle(object);
 159
 160   bool                connected(true);
 161   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(handle);
 162
 163   if(0 == strcmp(signalName.c_str(), SIGNAL_SCROLL_STARTED))
 164   {
 165     scrollable.ScrollStartedSignal().Connect(tracker, functor);
 166   }
 167   else if(0 == strcmp(signalName.c_str(), SIGNAL_SCROLL_UPDATED))
 168   {
 169     scrollable.ScrollUpdatedSignal().Connect(tracker, functor);
 170   }
 171   else if(0 == strcmp(signalName.c_str(), SIGNAL_SCROLL_COMPLETED))
 172   {
 173     scrollable.ScrollCompletedSignal().Connect(tracker, functor);
 174   }
 175   else
 176   {
 177     // signalName does not match any signal
 178     connected = false;
 179   }
 180
 181   return connected;
 182 }
 183
 184 void Scrollable::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
 185 {
 186   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Dali::BaseHandle(object));
 187
 188   if(scrollable)
 189   {
 190     Scrollable& scrollableImpl(GetImpl(scrollable));
 191     switch(index)
 192     {
 193       case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
 194       {
 195         scrollableImpl.SetOvershootEffectColor(value.Get<Vector4>());
 196         break;
 197       }
 198       case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
 199       {
 200         scrollableImpl.SetOvershootAnimationSpeed(value.Get<float>());
 201         break;
 202       }
 203       case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
 204       {
 205         scrollableImpl.SetOvershootEnabled(value.Get<bool>());
 206         break;
 207       }
 208       case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
 209       {
 210         scrollableImpl.SetOvershootSize(value.Get<Vector2>());
 211         break;
 212       }
 213       case Toolkit::Scrollable::Property::SCROLL_TO_ALPHA_FUNCTION:
 214       {
 215         int alphaFunction = value.Get<int>();
 216
 217         if(alphaFunction >= AlphaFunction::DEFAULT &&
 218            alphaFunction < AlphaFunction::COUNT)
 219         {
 220           scrollableImpl.mScrollToAlphaFunction = static_cast<AlphaFunction::BuiltinFunction>(alphaFunction);
 221         }
 222         break;
 223       }
 224     }
 225   }
 226 }
 227
 228 Property::Value Scrollable::GetProperty(BaseObject* object, Property::Index index)
 229 {
 230   Property::Value value;
 231
 232   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Dali::BaseHandle(object));
 233
 234   if(scrollable)
 235   {
 236     Scrollable& scrollableImpl(GetImpl(scrollable));
 237     switch(index)
 238     {
 239       case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
 240       {
 241         value = scrollableImpl.GetOvershootEffectColor();
 242         break;
 243       }
 244       case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
 245       {
 246         value = scrollableImpl.GetOvershootAnimationSpeed();
 247         break;
 248       }
 249       case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
 250       {
 251         value = scrollableImpl.IsOvershootEnabled();
 252         break;
 253       }
 254       case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
 255       {
 256         value = scrollableImpl.mOvershootSize;
 257         break;
 258       }
 259       case Toolkit::Scrollable::Property::SCROLL_TO_ALPHA_FUNCTION:
 260       {
 261         value = static_cast<int>(scrollableImpl.mScrollToAlphaFunction);
 262         break;
 263       }
 264     }
 265   }
 266
 267   return value;
 268 }
 269
 270 } // namespace Internal
 271
 272 } // namespace Toolkit
 273
 274 } // namespace Dali