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::Scrollable()
  65 : ControlImpl(true/*requires touch*/),
  66   mPropertyRelativePosition(Property::INVALID_INDEX),
  67   mPropertyPositionMin(Property::INVALID_INDEX),
  68   mPropertyPositionMax(Property::INVALID_INDEX),
  69   mPropertyScrollDirection(Property::INVALID_INDEX),
  70   mOvershootEnabled(false)
  71 {
  72 }
  73
  74 Scrollable::~Scrollable()
  75 {
  76   // Clear scroll components, forces their destruction before Scrollable is destroyed.
  77   mComponents.clear();
  78 }
  79
  80 void Scrollable::RegisterCommonProperties()
  81 {
  82   Actor self = Self();
  83
  84   // Register properties.
  85   mPropertyRelativePosition = self.RegisterProperty(Toolkit::Scrollable::SCROLL_RELATIVE_POSITION_PROPERTY_NAME, Vector3::ZERO);
  86   mPropertyPositionMin = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MIN_PROPERTY_NAME, Vector3::ZERO);
  87   mPropertyPositionMax = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MAX_PROPERTY_NAME, Vector3::ZERO);
  88   mPropertyScrollDirection = self.RegisterProperty(Toolkit::Scrollable::SCROLL_DIRECTION_PROPERTY_NAME, Vector3::ZERO);
  89   mPropertyCanScrollVertical = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_VERTICAL, true);
  90   mPropertyCanScrollHorizontal = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_HORIZONTAL, true);
  91 }
  92
  93 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
  94 {
  95   if(type == Toolkit::Scrollable::OvershootIndicator)
  96   {
  97     return mOvershootEnabled;
  98   }
  99   return (mComponents.find(type) != mComponents.end());
 100 }
 101
 102 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
 103 {
 104   if(type == Toolkit::Scrollable::OvershootIndicator)
 105   {
 106     if( !mOvershootEnabled )
 107     {
 108       SetOvershootEnabled(true);
 109       mOvershootEnabled = true;
 110     }
 111     return;
 112   }
 113   if( mComponents.find(type) == mComponents.end() )
 114   {
 115     // Create ScrollComponent
 116     Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Self());
 117     Toolkit::ScrollComponent scrollComponent = NewScrollComponent(scrollable, type);
 118     Toolkit::ScrollComponentImpl& component = static_cast<Toolkit::ScrollComponentImpl&>(scrollComponent.GetImplementation());
 119     ScrollComponentPtr componentPtr(&component);
 120
 121     mComponents[type] = componentPtr;
 122   }
 123 }
 124
 125 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
 126 {
 127   if(type == Toolkit::Scrollable::OvershootIndicator)
 128   {
 129     if( mOvershootEnabled )
 130     {
 131       SetOvershootEnabled(false);
 132       mOvershootEnabled = false;
 133     }
 134     return;
 135   }
 136   ComponentIter pair = mComponents.find( type );
 137
 138   if( mComponents.end() != pair )
 139   {
 140     ScrollComponentPtr component = pair->second;
 141
 142     // Disconnect the scroll component first.
 143     component->OnDisconnect();
 144
 145     // Destroy ScrollComponent.
 146     mComponents.erase( type );
 147   }
 148 }
 149
 150 Toolkit::Scrollable::ScrollStartedSignalV2& Scrollable::ScrollStartedSignal()
 151 {
 152   return mScrollStartedSignalV2;
 153 }
 154
 155 Toolkit::Scrollable::ScrollUpdatedSignalV2& Scrollable::ScrollUpdatedSignal()
 156 {
 157   return mScrollUpdatedSignalV2;
 158 }
 159
 160 Toolkit::Scrollable::ScrollCompletedSignalV2& Scrollable::ScrollCompletedSignal()
 161 {
 162   return mScrollCompletedSignalV2;
 163 }
 164
 165 Toolkit::Scrollable::ScrollClampedSignalV2& Scrollable::ScrollClampedSignal()
 166 {
 167   return mScrollClampedSignalV2;
 168 }
 169
 170 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
 171 {
 172   Dali::BaseHandle handle( object );
 173
 174   bool connected( true );
 175   Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
 176
 177   if( Toolkit::Scrollable::SIGNAL_SCROLL_STARTED == signalName )
 178   {
 179     scrollable.ScrollStartedSignal().Connect( tracker, functor );
 180   }
 181   else if( Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED == signalName )
 182   {
 183     scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
 184   }
 185   else if( Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED == signalName )
 186   {
 187     scrollable.ScrollCompletedSignal().Connect( tracker, functor );
 188   }
 189   else if( Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED == signalName )
 190   {
 191     scrollable.ScrollClampedSignal().Connect( tracker, functor );
 192   }
 193   else
 194   {
 195     // signalName does not match any signal
 196     connected = false;
 197   }
 198
 199   return connected;
 200 }
 201
 202 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
 203 {
 204   Toolkit::ScrollComponent instance;
 205
 206   switch(type)
 207   {
 208     case Toolkit::Scrollable::VerticalScrollBar:
 209     {
 210       instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
 211       break;
 212     }
 213     case Toolkit::Scrollable::HorizontalScrollBar:
 214     {
 215       instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
 216       break;
 217     }
 218     default:
 219     {
 220       DALI_ASSERT_ALWAYS(true && "Unrecognized component type");
 221     }
 222   }
 223
 224   return instance;
 225 }
 226
 227 } // namespace Internal
 228
 229 } // namespace Toolkit
 230
 231 } // namespace Dali