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
  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, "overshoot-effect-color",    VECTOR4, OVERSHOOT_EFFECT_COLOR    )
  50 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshoot-animation-speed", FLOAT,   OVERSHOOT_ANIMATION_SPEED )
  51
  52 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-relative-position", VECTOR2, SCROLL_RELATIVE_POSITION)
  53 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-position-min",      VECTOR2, SCROLL_POSITION_MIN)
  54 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scroll-position-min-x", SCROLL_POSITION_MIN_X, SCROLL_POSITION_MIN, 0)
  55 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scroll-position-min-y", SCROLL_POSITION_MIN_Y, SCROLL_POSITION_MIN, 1)
  56 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-position-max",      VECTOR2, SCROLL_POSITION_MAX)
  57 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scroll-position-max-x", SCROLL_POSITION_MAX_X, SCROLL_POSITION_MAX, 0)
  58 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scroll-position-max-y", SCROLL_POSITION_MAX_Y, SCROLL_POSITION_MAX, 1)
  59 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "can-scroll-vertical",      BOOLEAN, CAN_SCROLL_VERTICAL)
  60 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "can-scroll-horizontal",    BOOLEAN, CAN_SCROLL_HORIZONTAL)
  61
  62 DALI_SIGNAL_REGISTRATION(              Toolkit, Scrollable, "scroll-started",                    SIGNAL_SCROLL_STARTED    )
  63 DALI_SIGNAL_REGISTRATION(              Toolkit, Scrollable, "scroll-completed",                  SIGNAL_SCROLL_COMPLETED  )
  64 DALI_SIGNAL_REGISTRATION(              Toolkit, Scrollable, "scroll-updated",                    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
  71 }
  72
  73 ///////////////////////////////////////////////////////////////////////////////////////////////////
  74 // Scrollable
  75 ///////////////////////////////////////////////////////////////////////////////////////////////////
  76
  77 // Scrollable controls are not layout containers so they dont need size negotiation..
  78 // we dont want size negotiation while scrolling if we can avoid it
  79 Scrollable::Scrollable()
  80 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | DISABLE_SIZE_NEGOTIATION ) ),
  81   mOvershootEffectColor(  DEFAULT_OVERSHOOT_COLOUR ),
  82   mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
  83   mOvershootEnabled(false)
  84 {
  85 }
  86
  87 Scrollable::Scrollable( ControlBehaviour behaviourFlags )
  88 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | behaviourFlags ) ),
  89   mOvershootEffectColor(  DEFAULT_OVERSHOOT_COLOUR ),
  90   mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
  91   mOvershootEnabled(false)
  92 {
  93 }
  94
  95 Scrollable::~Scrollable()
  96 {
  97 }
  98
  99 bool Scrollable::IsOvershootEnabled() const
 100 {
 101   return mOvershootEnabled;
 102 }
 103
 104 void Scrollable::SetOvershootEnabled(bool enable)
 105 {
 106   EnableScrollOvershoot(enable);
 107   mOvershootEnabled = enable;
 108 }
 109
 110 Vector4 Scrollable::GetOvershootEffectColor() const
 111 {
 112   return mOvershootEffectColor;
 113 };
 114
 115 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
 116 {
 117   mOvershootAnimationSpeed = pixelsPerSecond;
 118 }
 119
 120 float Scrollable::GetOvershootAnimationSpeed() const
 121 {
 122   return mOvershootAnimationSpeed;
 123 };
 124
 125 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
 126 {
 127   return mScrollStartedSignal;
 128 }
 129
 130 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
 131 {
 132   return mScrollUpdatedSignal;
 133 }
 134
 135 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
 136 {
 137   return mScrollCompletedSignal;
 138 }
 139
 140 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
 141 {
 142   Dali::BaseHandle handle( object );
 143
 144   bool connected( true );
 145   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
 146
 147   if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
 148   {
 149     scrollable.ScrollStartedSignal().Connect( tracker, functor );
 150   }
 151   else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
 152   {
 153     scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
 154   }
 155   else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
 156   {
 157     scrollable.ScrollCompletedSignal().Connect( tracker, functor );
 158   }
 159   else
 160   {
 161     // signalName does not match any signal
 162     connected = false;
 163   }
 164
 165   return connected;
 166 }
 167
 168 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 169 {
 170   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
 171
 172   if( scrollable )
 173   {
 174     Scrollable& scrollableImpl( GetImpl( scrollable ) );
 175     switch( index )
 176     {
 177       case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
 178       {
 179         scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
 180         break;
 181       }
 182       case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
 183       {
 184         scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
 185         break;
 186       }
 187     }
 188   }
 189 }
 190
 191 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
 192 {
 193   Property::Value value;
 194
 195   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
 196
 197   if( scrollable )
 198   {
 199     Scrollable& scrollableImpl( GetImpl( scrollable ) );
 200     switch( index )
 201     {
 202       case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
 203       {
 204         value = scrollableImpl.GetOvershootEffectColor();
 205         break;
 206       }
 207       case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
 208       {
 209         value = scrollableImpl.GetOvershootAnimationSpeed();
 210         break;
 211       }
 212     }
 213   }
 214
 215   return value;
 216 }
 217
 218 } // namespace Internal
 219
 220 } // namespace Toolkit
 221
 222 } // namespace Dali