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::AccessibleImpl::IsScrollable()
  96 {
  97   return true;
  98 }
  99
 100 void Scrollable::OnInitialize()
 101 {
 102   DevelControl::SetAccessibilityConstructor(Self(), [](Dali::Actor actor) {
 103     return std::unique_ptr<Dali::Accessibility::Accessible>(
 104       new AccessibleImpl(actor, Dali::Accessibility::Role::SCROLL_PANE));
 105   });
 106 }
 107
 108 bool Scrollable::IsOvershootEnabled() const
 109 {
 110   return mOvershootEnabled;
 111 }
 112
 113 void Scrollable::SetOvershootEnabled(bool enable)
 114 {
 115   EnableScrollOvershoot(enable);
 116   mOvershootEnabled = enable;
 117 }
 118
 119 Vector4 Scrollable::GetOvershootEffectColor() const
 120 {
 121   return mOvershootEffectColor;
 122 };
 123
 124 void Scrollable::SetOvershootAnimationSpeed(float pixelsPerSecond)
 125 {
 126   mOvershootAnimationSpeed = pixelsPerSecond;
 127 }
 128
 129 float Scrollable::GetOvershootAnimationSpeed() const
 130 {
 131   return mOvershootAnimationSpeed;
 132 };
 133
 134 const Vector2& Scrollable::GetOvershootSize() const
 135 {
 136   return mOvershootSize;
 137 }
 138
 139 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
 140 {
 141   return mScrollStartedSignal;
 142 }
 143
 144 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
 145 {
 146   return mScrollUpdatedSignal;
 147 }
 148
 149 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
 150 {
 151   return mScrollCompletedSignal;
 152 }
 153
 154 bool Scrollable::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
 155 {
 156   Dali::BaseHandle handle(object);
 157
 158   bool                connected(true);
 159   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(handle);
 160
 161   if(0 == strcmp(signalName.c_str(), SIGNAL_SCROLL_STARTED))
 162   {
 163     scrollable.ScrollStartedSignal().Connect(tracker, functor);
 164   }
 165   else if(0 == strcmp(signalName.c_str(), SIGNAL_SCROLL_UPDATED))
 166   {
 167     scrollable.ScrollUpdatedSignal().Connect(tracker, functor);
 168   }
 169   else if(0 == strcmp(signalName.c_str(), SIGNAL_SCROLL_COMPLETED))
 170   {
 171     scrollable.ScrollCompletedSignal().Connect(tracker, functor);
 172   }
 173   else
 174   {
 175     // signalName does not match any signal
 176     connected = false;
 177   }
 178
 179   return connected;
 180 }
 181
 182 void Scrollable::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
 183 {
 184   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Dali::BaseHandle(object));
 185
 186   if(scrollable)
 187   {
 188     Scrollable& scrollableImpl(GetImpl(scrollable));
 189     switch(index)
 190     {
 191       case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
 192       {
 193         scrollableImpl.SetOvershootEffectColor(value.Get<Vector4>());
 194         break;
 195       }
 196       case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
 197       {
 198         scrollableImpl.SetOvershootAnimationSpeed(value.Get<float>());
 199         break;
 200       }
 201       case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
 202       {
 203         scrollableImpl.SetOvershootEnabled(value.Get<bool>());
 204         break;
 205       }
 206       case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
 207       {
 208         scrollableImpl.SetOvershootSize(value.Get<Vector2>());
 209         break;
 210       }
 211       case Toolkit::Scrollable::Property::SCROLL_TO_ALPHA_FUNCTION:
 212       {
 213         int alphaFunction = value.Get<int>();
 214
 215         if(alphaFunction >= AlphaFunction::DEFAULT &&
 216            alphaFunction < AlphaFunction::COUNT)
 217         {
 218           scrollableImpl.mScrollToAlphaFunction = static_cast<AlphaFunction::BuiltinFunction>(alphaFunction);
 219         }
 220         break;
 221       }
 222     }
 223   }
 224 }
 225
 226 Property::Value Scrollable::GetProperty(BaseObject* object, Property::Index index)
 227 {
 228   Property::Value value;
 229
 230   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Dali::BaseHandle(object));
 231
 232   if(scrollable)
 233   {
 234     Scrollable& scrollableImpl(GetImpl(scrollable));
 235     switch(index)
 236     {
 237       case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
 238       {
 239         value = scrollableImpl.GetOvershootEffectColor();
 240         break;
 241       }
 242       case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
 243       {
 244         value = scrollableImpl.GetOvershootAnimationSpeed();
 245         break;
 246       }
 247       case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
 248       {
 249         value = scrollableImpl.IsOvershootEnabled();
 250         break;
 251       }
 252       case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
 253       {
 254         value = scrollableImpl.mOvershootSize;
 255         break;
 256       }
 257       case Toolkit::Scrollable::Property::SCROLL_TO_ALPHA_FUNCTION:
 258       {
 259         value = static_cast<int>(scrollableImpl.mScrollToAlphaFunction);
 260         break;
 261       }
 262     }
 263   }
 264
 265   return value;
 266 }
 267
 268 } // namespace Internal
 269
 270 } // namespace Toolkit
 271
 272 } // namespace Dali