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
35 const Property::Index Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR( Toolkit::Internal::Control::CONTROL_PROPERTY_END_INDEX + 1 );
42 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
46 // empty handle as we cannot create Scrollable (but type registered for scroll signal)
50 TypeRegistration mType( typeid(Toolkit::Scrollable), typeid(Toolkit::Control), Create );
52 SignalConnectorType s1(mType, Toolkit::Scrollable::SIGNAL_SCROLL_STARTED, &Scrollable::DoConnectSignal);
53 SignalConnectorType s2(mType, Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED, &Scrollable::DoConnectSignal);
54 SignalConnectorType s3(mType, Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED, &Scrollable::DoConnectSignal);
55 SignalConnectorType s4(mType, Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED, &Scrollable::DoConnectSignal);
57 PropertyRegistration property1( mType,
58 "overshoot-effect-color",
59 Toolkit::Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR,
61 &Scrollable::SetProperty,
62 &Scrollable::GetProperty );
66 const std::string Scrollable::SCROLLABLE_CAN_SCROLL_VERTICAL( "scrollable-can-scroll-vertical" );
67 const std::string Scrollable::SCROLLABLE_CAN_SCROLL_HORIZONTAL( "scrollable-can-scroll-horizontal" );
69 ///////////////////////////////////////////////////////////////////////////////////////////////////
71 ///////////////////////////////////////////////////////////////////////////////////////////////////
73 // Scrollable controls are not layout containers so they dont need size negotiation..
74 // we dont want size negotiation while scrolling if we can avoid it
75 Scrollable::Scrollable()
76 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | NO_SIZE_NEGOTIATION ) ),
77 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
78 mPropertyRelativePosition(Property::INVALID_INDEX),
79 mPropertyPositionMin(Property::INVALID_INDEX),
80 mPropertyPositionMax(Property::INVALID_INDEX),
81 mPropertyScrollDirection(Property::INVALID_INDEX),
82 mPropertyCanScrollVertical(Property::INVALID_INDEX),
83 mPropertyCanScrollHorizontal(Property::INVALID_INDEX),
84 mOvershootEnabled(false)
88 Scrollable::~Scrollable()
90 // Clear scroll components, forces their destruction before Scrollable is destroyed.
94 void Scrollable::RegisterCommonProperties()
98 // Register properties.
99 mPropertyRelativePosition = self.RegisterProperty(Toolkit::Scrollable::SCROLL_RELATIVE_POSITION_PROPERTY_NAME, Vector3::ZERO);
100 mPropertyPositionMin = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MIN_PROPERTY_NAME, Vector3::ZERO);
101 mPropertyPositionMax = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MAX_PROPERTY_NAME, Vector3::ZERO);
102 mPropertyScrollDirection = self.RegisterProperty(Toolkit::Scrollable::SCROLL_DIRECTION_PROPERTY_NAME, Vector3::ZERO);
103 mPropertyCanScrollVertical = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_VERTICAL, true);
104 mPropertyCanScrollHorizontal = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_HORIZONTAL, true);
107 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
109 if(type == Toolkit::Scrollable::OvershootIndicator)
111 return mOvershootEnabled;
113 return (mComponents.find(type) != mComponents.end());
116 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
118 if(type == Toolkit::Scrollable::OvershootIndicator)
120 if( !mOvershootEnabled )
122 SetOvershootEnabled(true);
123 mOvershootEnabled = true;
127 if( mComponents.find(type) == mComponents.end() )
129 // Create ScrollComponent
130 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Self());
131 Toolkit::ScrollComponent scrollComponent = NewScrollComponent(scrollable, type);
132 Toolkit::ScrollComponentImpl& component = static_cast<Toolkit::ScrollComponentImpl&>(scrollComponent.GetImplementation());
133 ScrollComponentPtr componentPtr(&component);
135 mComponents[type] = componentPtr;
139 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
141 if(type == Toolkit::Scrollable::OvershootIndicator)
143 if( mOvershootEnabled )
145 SetOvershootEnabled(false);
146 mOvershootEnabled = false;
150 ComponentIter pair = mComponents.find( type );
152 if( mComponents.end() != pair )
154 ScrollComponentPtr component = pair->second;
156 // Disconnect the scroll component first.
157 component->OnDisconnect();
159 // Destroy ScrollComponent.
160 mComponents.erase( type );
164 Vector4 Scrollable::GetOvershootEffectColor() const
166 return mOvershootEffectColor;
169 Toolkit::Scrollable::ScrollStartedSignalV2& Scrollable::ScrollStartedSignal()
171 return mScrollStartedSignalV2;
174 Toolkit::Scrollable::ScrollUpdatedSignalV2& Scrollable::ScrollUpdatedSignal()
176 return mScrollUpdatedSignalV2;
179 Toolkit::Scrollable::ScrollCompletedSignalV2& Scrollable::ScrollCompletedSignal()
181 return mScrollCompletedSignalV2;
184 Toolkit::Scrollable::ScrollClampedSignalV2& Scrollable::ScrollClampedSignal()
186 return mScrollClampedSignalV2;
189 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
191 Dali::BaseHandle handle( object );
193 bool connected( true );
194 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
196 if( Toolkit::Scrollable::SIGNAL_SCROLL_STARTED == signalName )
198 scrollable.ScrollStartedSignal().Connect( tracker, functor );
200 else if( Toolkit::Scrollable::SIGNAL_SCROLL_UPDATED == signalName )
202 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
204 else if( Toolkit::Scrollable::SIGNAL_SCROLL_COMPLETED == signalName )
206 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
208 else if( Toolkit::Scrollable::SIGNAL_SCROLL_CLAMPED == signalName )
210 scrollable.ScrollClampedSignal().Connect( tracker, functor );
214 // signalName does not match any signal
221 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
223 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
227 Scrollable& scrollableImpl( GetImpl( scrollable ) );
230 case Toolkit::Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR:
232 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
239 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
241 Property::Value value;
243 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
247 Scrollable& scrollableImpl( GetImpl( scrollable ) );
250 case Toolkit::Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR:
252 value = scrollableImpl.GetOvershootEffectColor();
261 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
263 Toolkit::ScrollComponent instance;
267 case Toolkit::Scrollable::VerticalScrollBar:
269 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
272 case Toolkit::Scrollable::HorizontalScrollBar:
274 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
279 DALI_ASSERT_ALWAYS(true && "Unrecognized component type");
286 } // namespace Internal
288 } // namespace Toolkit