2 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
8 // http://floralicense.org/license/
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.
18 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
19 #include <dali-toolkit/internal/controls/scroll-component/scroll-bar-internal-impl.h>
26 } // unnamed namespace
42 // empty handle as we cannot create Scrollable (but type registered for scroll signal)
46 TypeRegistration mType( typeid(Toolkit::Scrollable), typeid(Toolkit::Control), Create );
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);
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" );
58 ///////////////////////////////////////////////////////////////////////////////////////////////////
60 ///////////////////////////////////////////////////////////////////////////////////////////////////
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)
72 Scrollable::~Scrollable()
74 // Clear scroll components, forces their destruction before Scrollable is destroyed.
78 void Scrollable::RegisterCommonProperties()
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);
91 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
93 if(type == Toolkit::Scrollable::OvershootIndicator)
95 return mOvershootEnabled;
97 return (mComponents.find(type) != mComponents.end());
100 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
102 if(type == Toolkit::Scrollable::OvershootIndicator)
104 SetOvershootEnabled(true);
105 mOvershootEnabled = true;
108 if( mComponents.find(type) == mComponents.end() )
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);
116 mComponents[type] = componentPtr;
120 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
122 if(type == Toolkit::Scrollable::OvershootIndicator)
124 SetOvershootEnabled(false);
125 mOvershootEnabled = false;
128 ComponentIter pair = mComponents.find( type );
130 if( mComponents.end() != pair )
132 ScrollComponentPtr component = pair->second;
134 // Disconnect the scroll component first.
135 component->OnDisconnect();
137 // Destroy ScrollComponent.
138 mComponents.erase( type );
142 Toolkit::Scrollable::ScrollStartedSignalV2& Scrollable::ScrollStartedSignal()
144 return mScrollStartedSignalV2;
147 Toolkit::Scrollable::ScrollUpdatedSignalV2& Scrollable::ScrollUpdatedSignal()
149 return mScrollUpdatedSignalV2;
152 Toolkit::Scrollable::ScrollCompletedSignalV2& Scrollable::ScrollCompletedSignal()
154 return mScrollCompletedSignalV2;
157 Toolkit::Scrollable::ScrollClampedSignalV2& Scrollable::ScrollClampedSignal()
159 return mScrollClampedSignalV2;
162 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
164 Dali::BaseHandle handle( object );
166 bool connected( true );
167 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
169 if( Toolkit::Scrollable::SIGNAL_SCROLL_STARTED == signalName )
171 scrollable.ScrollStartedSignal().Connect( tracker, functor );
173 else if( Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED == signalName )
175 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
177 else if( Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED == signalName )
179 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
181 else if( Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED == signalName )
183 scrollable.ScrollClampedSignal().Connect( tracker, functor );
187 // signalName does not match any signal
194 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
196 Toolkit::ScrollComponent instance;
200 case Toolkit::Scrollable::VerticalScrollBar:
202 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
205 case Toolkit::Scrollable::HorizontalScrollBar:
207 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
212 DALI_ASSERT_ALWAYS(true && "Unrecognized component type");
219 } // namespace Internal
221 } // namespace Toolkit