dali-toolkit/internal/controls/scrollable/scrollable-impl.cpp

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