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