2 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
20 #include <dali-toolkit/internal/controls/scroll-component/scroll-bar-internal-impl.h>
27 } // unnamed namespace
43 // empty handle as we cannot create Scrollable (but type registered for scroll signal)
47 TypeRegistration mType( typeid(Toolkit::Scrollable), typeid(Toolkit::Control), Create );
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);
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);
60 ///////////////////////////////////////////////////////////////////////////////////////////////////
62 ///////////////////////////////////////////////////////////////////////////////////////////////////
64 Scrollable::Scrollable()
65 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS ) ),
66 mPropertyRelativePosition(Property::INVALID_INDEX),
67 mPropertyPositionMin(Property::INVALID_INDEX),
68 mPropertyPositionMax(Property::INVALID_INDEX),
69 mPropertyScrollDirection(Property::INVALID_INDEX),
70 mOvershootEnabled(false)
74 Scrollable::~Scrollable()
76 // Clear scroll components, forces their destruction before Scrollable is destroyed.
80 void Scrollable::RegisterCommonProperties()
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);
93 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
95 if(type == Toolkit::Scrollable::OvershootIndicator)
97 return mOvershootEnabled;
99 return (mComponents.find(type) != mComponents.end());
102 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
104 if(type == Toolkit::Scrollable::OvershootIndicator)
106 if( !mOvershootEnabled )
108 SetOvershootEnabled(true);
109 mOvershootEnabled = true;
113 if( mComponents.find(type) == mComponents.end() )
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);
121 mComponents[type] = componentPtr;
125 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
127 if(type == Toolkit::Scrollable::OvershootIndicator)
129 if( mOvershootEnabled )
131 SetOvershootEnabled(false);
132 mOvershootEnabled = false;
136 ComponentIter pair = mComponents.find( type );
138 if( mComponents.end() != pair )
140 ScrollComponentPtr component = pair->second;
142 // Disconnect the scroll component first.
143 component->OnDisconnect();
145 // Destroy ScrollComponent.
146 mComponents.erase( type );
150 Toolkit::Scrollable::ScrollStartedSignalV2& Scrollable::ScrollStartedSignal()
152 return mScrollStartedSignalV2;
155 Toolkit::Scrollable::ScrollUpdatedSignalV2& Scrollable::ScrollUpdatedSignal()
157 return mScrollUpdatedSignalV2;
160 Toolkit::Scrollable::ScrollCompletedSignalV2& Scrollable::ScrollCompletedSignal()
162 return mScrollCompletedSignalV2;
165 Toolkit::Scrollable::ScrollClampedSignalV2& Scrollable::ScrollClampedSignal()
167 return mScrollClampedSignalV2;
170 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
172 Dali::BaseHandle handle( object );
174 bool connected( true );
175 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
177 if( Toolkit::Scrollable::SIGNAL_SCROLL_STARTED == signalName )
179 scrollable.ScrollStartedSignal().Connect( tracker, functor );
181 else if( Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED == signalName )
183 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
185 else if( Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED == signalName )
187 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
189 else if( Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED == signalName )
191 scrollable.ScrollClampedSignal().Connect( tracker, functor );
195 // signalName does not match any signal
202 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
204 Toolkit::ScrollComponent instance;
208 case Toolkit::Scrollable::VerticalScrollBar:
210 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
213 case Toolkit::Scrollable::HorizontalScrollBar:
215 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
220 DALI_ASSERT_ALWAYS(true && "Unrecognized component type");
227 } // namespace Internal
229 } // namespace Toolkit