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/scroll-component/scroll-bar-internal-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, "overshoot-effect-color",    VECTOR4, OVERSHOOT_EFFECT_COLOR    )
  51 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshoot-animation-speed", FLOAT,   OVERSHOOT_ANIMATION_SPEED )
  52
  53 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-relative-position", VECTOR3, SCROLL_RELATIVE_POSITION )
  54 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-position-min",      VECTOR3, SCROLL_POSITION_MIN      )
  55 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-position-max",      VECTOR3, SCROLL_POSITION_MAX      )
  56 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-direction",         VECTOR3, SCROLL_DIRECTION         )
  57 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "can-scroll-vertical",      BOOLEAN, CAN_SCROLL_VERTICAL      )
  58 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "can-scroll-horizontal",    BOOLEAN, CAN_SCROLL_HORIZONTAL    )
  59
  60 DALI_SIGNAL_REGISTRATION(              Toolkit, Scrollable, "scroll-started",                    SIGNAL_SCROLL_STARTED    )
  61 DALI_SIGNAL_REGISTRATION(              Toolkit, Scrollable, "scroll-completed",                  SIGNAL_SCROLL_COMPLETED  )
  62 DALI_SIGNAL_REGISTRATION(              Toolkit, Scrollable, "scroll-updated",                    SIGNAL_SCROLL_UPDATED    )
  63
  64 DALI_TYPE_REGISTRATION_END()
  65
  66 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
  67 const float DEFAULT_OVERSHOOT_ANIMATION_SPEED(120.0f); // 120 pixels per second
  68
  69 }
  70
  71 ///////////////////////////////////////////////////////////////////////////////////////////////////
  72 // Scrollable
  73 ///////////////////////////////////////////////////////////////////////////////////////////////////
  74
  75 // Scrollable controls are not layout containers so they dont need size negotiation..
  76 // we dont want size negotiation while scrolling if we can avoid it
  77 Scrollable::Scrollable()
  78 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | DISABLE_SIZE_NEGOTIATION ) ),
  79   mOvershootEffectColor(  DEFAULT_OVERSHOOT_COLOUR ),
  80   mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
  81   mOvershootEnabled(false)
  82 {
  83 }
  84
  85 Scrollable::Scrollable( ControlBehaviour behaviourFlags )
  86 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | behaviourFlags ) ),
  87   mOvershootEffectColor(  DEFAULT_OVERSHOOT_COLOUR ),
  88   mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
  89   mOvershootEnabled(false)
  90 {
  91 }
  92
  93 Scrollable::~Scrollable()
  94 {
  95   // Clear scroll components, forces their destruction before Scrollable is destroyed.
  96   mComponents.clear();
  97 }
  98
  99 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
 100 {
 101   if(type == Toolkit::Scrollable::OvershootIndicator)
 102   {
 103     return mOvershootEnabled;
 104   }
 105   return (mComponents.find(type) != mComponents.end());
 106 }
 107
 108 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
 109 {
 110   if(type == Toolkit::Scrollable::OvershootIndicator)
 111   {
 112     if( !mOvershootEnabled )
 113     {
 114       SetOvershootEnabled(true);
 115       mOvershootEnabled = true;
 116     }
 117     return;
 118   }
 119   if( mComponents.find(type) == mComponents.end() )
 120   {
 121     // Create ScrollComponent
 122     Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Self());
 123     Toolkit::ScrollComponent scrollComponent = NewScrollComponent(scrollable, type);
 124     Toolkit::ScrollComponentImpl& component = static_cast<Toolkit::ScrollComponentImpl&>(scrollComponent.GetImplementation());
 125     ScrollComponentPtr componentPtr(&component);
 126
 127     mComponents[type] = componentPtr;
 128   }
 129 }
 130
 131 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
 132 {
 133   if(type == Toolkit::Scrollable::OvershootIndicator)
 134   {
 135     if( mOvershootEnabled )
 136     {
 137       SetOvershootEnabled(false);
 138       mOvershootEnabled = false;
 139     }
 140     return;
 141   }
 142   ComponentIter pair = mComponents.find( type );
 143
 144   if( mComponents.end() != pair )
 145   {
 146     ScrollComponentPtr component = pair->second;
 147
 148     // Disconnect the scroll component first.
 149     component->OnDisconnect();
 150
 151     // Destroy ScrollComponent.
 152     mComponents.erase( type );
 153   }
 154 }
 155
 156 Vector4 Scrollable::GetOvershootEffectColor() const
 157 {
 158   return mOvershootEffectColor;
 159 };
 160
 161 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
 162 {
 163   mOvershootAnimationSpeed = pixelsPerSecond;
 164 }
 165
 166 float Scrollable::GetOvershootAnimationSpeed() const
 167 {
 168   return mOvershootAnimationSpeed;
 169 };
 170
 171 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
 172 {
 173   return mScrollStartedSignal;
 174 }
 175
 176 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
 177 {
 178   return mScrollUpdatedSignal;
 179 }
 180
 181 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
 182 {
 183   return mScrollCompletedSignal;
 184 }
 185
 186 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
 187 {
 188   Dali::BaseHandle handle( object );
 189
 190   bool connected( true );
 191   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
 192
 193   if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
 194   {
 195     scrollable.ScrollStartedSignal().Connect( tracker, functor );
 196   }
 197   else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
 198   {
 199     scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
 200   }
 201   else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
 202   {
 203     scrollable.ScrollCompletedSignal().Connect( tracker, functor );
 204   }
 205   else
 206   {
 207     // signalName does not match any signal
 208     connected = false;
 209   }
 210
 211   return connected;
 212 }
 213
 214 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 215 {
 216   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
 217
 218   if( scrollable )
 219   {
 220     Scrollable& scrollableImpl( GetImpl( scrollable ) );
 221     switch( index )
 222     {
 223       case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
 224       {
 225         scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
 226         break;
 227       }
 228       case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
 229       {
 230         scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
 231         break;
 232       }
 233     }
 234   }
 235 }
 236
 237 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
 238 {
 239   Property::Value value;
 240
 241   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
 242
 243   if( scrollable )
 244   {
 245     Scrollable& scrollableImpl( GetImpl( scrollable ) );
 246     switch( index )
 247     {
 248       case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
 249       {
 250         value = scrollableImpl.GetOvershootEffectColor();
 251         break;
 252       }
 253       case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
 254       {
 255         value = scrollableImpl.GetOvershootAnimationSpeed();
 256         break;
 257       }
 258     }
 259   }
 260
 261   return value;
 262 }
 263
 264 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
 265 {
 266   Toolkit::ScrollComponent instance;
 267
 268   switch(type)
 269   {
 270     case Toolkit::Scrollable::VerticalScrollBar:
 271     {
 272       instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
 273       break;
 274     }
 275     case Toolkit::Scrollable::HorizontalScrollBar:
 276     {
 277       instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
 278       break;
 279     }
 280     case Toolkit::Scrollable::OvershootIndicator:
 281     {
 282       DALI_ASSERT_ALWAYS(!"Unrecognized component type");
 283       break;
 284     }
 285   }
 286
 287   return instance;
 288 }
 289
 290 } // namespace Internal
 291
 292 } // namespace Toolkit
 293
 294 } // namespace Dali