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