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