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 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)
78 Scrollable::~Scrollable()
80 // Clear scroll components, forces their destruction before Scrollable is destroyed.
84 void Scrollable::RegisterCommonProperties()
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);
97 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
99 if(type == Toolkit::Scrollable::OvershootIndicator)
101 return mOvershootEnabled;
103 return (mComponents.find(type) != mComponents.end());
106 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
108 if(type == Toolkit::Scrollable::OvershootIndicator)
110 if( !mOvershootEnabled )
112 SetOvershootEnabled(true);
113 mOvershootEnabled = true;
117 if( mComponents.find(type) == mComponents.end() )
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);
125 mComponents[type] = componentPtr;
129 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
131 if(type == Toolkit::Scrollable::OvershootIndicator)
133 if( mOvershootEnabled )
135 SetOvershootEnabled(false);
136 mOvershootEnabled = false;
140 ComponentIter pair = mComponents.find( type );
142 if( mComponents.end() != pair )
144 ScrollComponentPtr component = pair->second;
146 // Disconnect the scroll component first.
147 component->OnDisconnect();
149 // Destroy ScrollComponent.
150 mComponents.erase( type );
154 Toolkit::Scrollable::ScrollStartedSignalV2& Scrollable::ScrollStartedSignal()
156 return mScrollStartedSignalV2;
159 Toolkit::Scrollable::ScrollUpdatedSignalV2& Scrollable::ScrollUpdatedSignal()
161 return mScrollUpdatedSignalV2;
164 Toolkit::Scrollable::ScrollCompletedSignalV2& Scrollable::ScrollCompletedSignal()
166 return mScrollCompletedSignalV2;
169 Toolkit::Scrollable::ScrollClampedSignalV2& Scrollable::ScrollClampedSignal()
171 return mScrollClampedSignalV2;
174 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
176 Dali::BaseHandle handle( object );
178 bool connected( true );
179 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
181 if( Toolkit::Scrollable::SIGNAL_SCROLL_STARTED == signalName )
183 scrollable.ScrollStartedSignal().Connect( tracker, functor );
185 else if( Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED == signalName )
187 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
189 else if( Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED == signalName )
191 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
193 else if( Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED == signalName )
195 scrollable.ScrollClampedSignal().Connect( tracker, functor );
199 // signalName does not match any signal
206 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
208 Toolkit::ScrollComponent instance;
212 case Toolkit::Scrollable::VerticalScrollBar:
214 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
217 case Toolkit::Scrollable::HorizontalScrollBar:
219 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
224 DALI_ASSERT_ALWAYS(true && "Unrecognized component type");
231 } // namespace Internal
233 } // namespace Toolkit