base/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 // INTERNAL INCLUDES
  19 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
  20 #include <dali-toolkit/internal/controls/scroll-component/scroll-bar-internal-impl.h>
  21
  22 using namespace Dali;
  23
  24 namespace
  25 {
  26
  27 } // unnamed namespace
  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 TypeRegistration mType( typeid(Toolkit::Scrollable), typeid(Toolkit::Control), Create );
  48
  49 SignalConnectorType s1(mType, Toolkit::Scrollable::SIGNAL_SCROLL_STARTED,   &Scrollable::DoConnectSignal);
  50 SignalConnectorType s2(mType, Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED, &Scrollable::DoConnectSignal);
  51 SignalConnectorType s3(mType, Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED,   &Scrollable::DoConnectSignal);
  52 SignalConnectorType s4(mType, Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED,   &Scrollable::DoConnectSignal);
  53
  54 }
  55
  56 const std::string Scrollable::SCROLLABLE_CAN_SCROLL_VERTICAL( "scrollable-can-scroll-vertical" );
  57 const std::string Scrollable::SCROLLABLE_CAN_SCROLL_HORIZONTAL( "scrollable-can-scroll-horizontal" );
  58 const Vector4     Scrollable::DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.6f);
  59
  60 ///////////////////////////////////////////////////////////////////////////////////////////////////
  61 // Scrollable
  62 ///////////////////////////////////////////////////////////////////////////////////////////////////
  63
  64 // Scrollable controls are not layout containers so they dont need size negotiation..
  65 // we dont want size negotiation while scrolling if we can avoid it
  66 Scrollable::Scrollable()
  67 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | NO_SIZE_NEGOTIATION ) ),
  68   mPropertyRelativePosition(Property::INVALID_INDEX),
  69   mPropertyPositionMin(Property::INVALID_INDEX),
  70   mPropertyPositionMax(Property::INVALID_INDEX),
  71   mPropertyScrollDirection(Property::INVALID_INDEX),
  72   mPropertyCanScrollVertical(Property::INVALID_INDEX),
  73   mPropertyCanScrollHorizontal(Property::INVALID_INDEX),
  74   mOvershootEnabled(false)
  75 {
  76 }
  77
  78 Scrollable::~Scrollable()
  79 {
  80   // Clear scroll components, forces their destruction before Scrollable is destroyed.
  81   mComponents.clear();
  82 }
  83
  84 void Scrollable::RegisterCommonProperties()
  85 {
  86   Actor self = Self();
  87
  88   // Register properties.
  89   mPropertyRelativePosition = self.RegisterProperty(Toolkit::Scrollable::SCROLL_RELATIVE_POSITION_PROPERTY_NAME, Vector3::ZERO);
  90   mPropertyPositionMin = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MIN_PROPERTY_NAME, Vector3::ZERO);
  91   mPropertyPositionMax = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MAX_PROPERTY_NAME, Vector3::ZERO);
  92   mPropertyScrollDirection = self.RegisterProperty(Toolkit::Scrollable::SCROLL_DIRECTION_PROPERTY_NAME, Vector3::ZERO);
  93   mPropertyCanScrollVertical = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_VERTICAL, true);
  94   mPropertyCanScrollHorizontal = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_HORIZONTAL, true);
  95 }
  96
  97 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
  98 {
  99   if(type == Toolkit::Scrollable::OvershootIndicator)
 100   {
 101     return mOvershootEnabled;
 102   }
 103   return (mComponents.find(type) != mComponents.end());
 104 }
 105
 106 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
 107 {
 108   if(type == Toolkit::Scrollable::OvershootIndicator)
 109   {
 110     if( !mOvershootEnabled )
 111     {
 112       SetOvershootEnabled(true);
 113       mOvershootEnabled = true;
 114     }
 115     return;
 116   }
 117   if( mComponents.find(type) == mComponents.end() )
 118   {
 119     // Create ScrollComponent
 120     Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Self());
 121     Toolkit::ScrollComponent scrollComponent = NewScrollComponent(scrollable, type);
 122     Toolkit::ScrollComponentImpl& component = static_cast<Toolkit::ScrollComponentImpl&>(scrollComponent.GetImplementation());
 123     ScrollComponentPtr componentPtr(&component);
 124
 125     mComponents[type] = componentPtr;
 126   }
 127 }
 128
 129 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
 130 {
 131   if(type == Toolkit::Scrollable::OvershootIndicator)
 132   {
 133     if( mOvershootEnabled )
 134     {
 135       SetOvershootEnabled(false);
 136       mOvershootEnabled = false;
 137     }
 138     return;
 139   }
 140   ComponentIter pair = mComponents.find( type );
 141
 142   if( mComponents.end() != pair )
 143   {
 144     ScrollComponentPtr component = pair->second;
 145
 146     // Disconnect the scroll component first.
 147     component->OnDisconnect();
 148
 149     // Destroy ScrollComponent.
 150     mComponents.erase( type );
 151   }
 152 }
 153
 154 Toolkit::Scrollable::ScrollStartedSignalV2& Scrollable::ScrollStartedSignal()
 155 {
 156   return mScrollStartedSignalV2;
 157 }
 158
 159 Toolkit::Scrollable::ScrollUpdatedSignalV2& Scrollable::ScrollUpdatedSignal()
 160 {
 161   return mScrollUpdatedSignalV2;
 162 }
 163
 164 Toolkit::Scrollable::ScrollCompletedSignalV2& Scrollable::ScrollCompletedSignal()
 165 {
 166   return mScrollCompletedSignalV2;
 167 }
 168
 169 Toolkit::Scrollable::ScrollClampedSignalV2& Scrollable::ScrollClampedSignal()
 170 {
 171   return mScrollClampedSignalV2;
 172 }
 173
 174 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
 175 {
 176   Dali::BaseHandle handle( object );
 177
 178   bool connected( true );
 179   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
 180
 181   if( Toolkit::Scrollable::SIGNAL_SCROLL_STARTED == signalName )
 182   {
 183     scrollable.ScrollStartedSignal().Connect( tracker, functor );
 184   }
 185   else if( Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED == signalName )
 186   {
 187     scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
 188   }
 189   else if( Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED == signalName )
 190   {
 191     scrollable.ScrollCompletedSignal().Connect( tracker, functor );
 192   }
 193   else if( Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED == signalName )
 194   {
 195     scrollable.ScrollClampedSignal().Connect( tracker, functor );
 196   }
 197   else
 198   {
 199     // signalName does not match any signal
 200     connected = false;
 201   }
 202
 203   return connected;
 204 }
 205
 206 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
 207 {
 208   Toolkit::ScrollComponent instance;
 209
 210   switch(type)
 211   {
 212     case Toolkit::Scrollable::VerticalScrollBar:
 213     {
 214       instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
 215       break;
 216     }
 217     case Toolkit::Scrollable::HorizontalScrollBar:
 218     {
 219       instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
 220       break;
 221     }
 222     default:
 223     {
 224       DALI_ASSERT_ALWAYS(true && "Unrecognized component type");
 225     }
 226   }
 227
 228   return instance;
 229 }
 230
 231 } // namespace Internal
 232
 233 } // namespace Toolkit
 234
 235 } // namespace Dali