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/public-api/object/type-registry.h>
22 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
23 #include <dali-toolkit/internal/controls/scroll-component/scroll-bar-internal-impl.h>
30 } // unnamed namespace
38 const Property::Index Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR( Toolkit::Internal::Control::CONTROL_PROPERTY_END_INDEX + 1 );
39 const Property::Index Scrollable::PROPERTY_OVERSHOOT_ANIMATION_SPEED( Toolkit::Internal::Control::CONTROL_PROPERTY_END_INDEX + 2 );
46 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
47 const float DEFAULT_OVERSHOOT_ANIMATION_SPEED(120.0f); // 120 pixels per second
51 const char* const SIGNAL_SCROLL_STARTED = "scroll-started";
52 const char* const SIGNAL_SCROLL_COMPLETED = "scroll-completed";
53 const char* const SIGNAL_SCROLL_UPDATED = "scroll-updated";
54 const char* const SIGNAL_SCROLL_CLAMPED = "scroll-clamped";
58 // empty handle as we cannot create Scrollable (but type registered for scroll signal)
62 TypeRegistration mType( typeid( Toolkit::Scrollable ), typeid( Toolkit::Control ), Create );
64 SignalConnectorType s1( mType, SIGNAL_SCROLL_STARTED, &Scrollable::DoConnectSignal );
65 SignalConnectorType s2( mType, SIGNAL_SCROLL_COMPLETED, &Scrollable::DoConnectSignal );
66 SignalConnectorType s3( mType, SIGNAL_SCROLL_UPDATED, &Scrollable::DoConnectSignal );
67 SignalConnectorType s4( mType, SIGNAL_SCROLL_CLAMPED, &Scrollable::DoConnectSignal );
69 PropertyRegistration property1( mType,
70 "overshoot-effect-color",
71 Toolkit::Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR,
73 &Scrollable::SetProperty,
74 &Scrollable::GetProperty );
76 PropertyRegistration property2( mType,
77 "overshoot-animation-speed",
78 Toolkit::Scrollable::PROPERTY_OVERSHOOT_ANIMATION_SPEED,
80 &Scrollable::SetProperty,
81 &Scrollable::GetProperty );
85 const std::string Scrollable::SCROLLABLE_CAN_SCROLL_VERTICAL( "scrollable-can-scroll-vertical" );
86 const std::string Scrollable::SCROLLABLE_CAN_SCROLL_HORIZONTAL( "scrollable-can-scroll-horizontal" );
88 ///////////////////////////////////////////////////////////////////////////////////////////////////
90 ///////////////////////////////////////////////////////////////////////////////////////////////////
92 // Scrollable controls are not layout containers so they dont need size negotiation..
93 // we dont want size negotiation while scrolling if we can avoid it
94 Scrollable::Scrollable()
95 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | NO_SIZE_NEGOTIATION ) ),
96 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
97 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
98 mPropertyRelativePosition(Property::INVALID_INDEX),
99 mPropertyPositionMin(Property::INVALID_INDEX),
100 mPropertyPositionMax(Property::INVALID_INDEX),
101 mPropertyScrollDirection(Property::INVALID_INDEX),
102 mPropertyCanScrollVertical(Property::INVALID_INDEX),
103 mPropertyCanScrollHorizontal(Property::INVALID_INDEX),
104 mOvershootEnabled(false)
108 Scrollable::~Scrollable()
110 // Clear scroll components, forces their destruction before Scrollable is destroyed.
114 void Scrollable::RegisterCommonProperties()
118 // Register properties.
119 mPropertyRelativePosition = self.RegisterProperty(Toolkit::Scrollable::SCROLL_RELATIVE_POSITION_PROPERTY_NAME, Vector3::ZERO);
120 mPropertyPositionMin = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MIN_PROPERTY_NAME, Vector3::ZERO);
121 mPropertyPositionMax = self.RegisterProperty(Toolkit::Scrollable::SCROLL_POSITION_MAX_PROPERTY_NAME, Vector3::ZERO);
122 mPropertyScrollDirection = self.RegisterProperty(Toolkit::Scrollable::SCROLL_DIRECTION_PROPERTY_NAME, Vector3::ZERO);
123 mPropertyCanScrollVertical = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_VERTICAL, true);
124 mPropertyCanScrollHorizontal = self.RegisterProperty(SCROLLABLE_CAN_SCROLL_HORIZONTAL, true);
127 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
129 if(type == Toolkit::Scrollable::OvershootIndicator)
131 return mOvershootEnabled;
133 return (mComponents.find(type) != mComponents.end());
136 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
138 if(type == Toolkit::Scrollable::OvershootIndicator)
140 if( !mOvershootEnabled )
142 SetOvershootEnabled(true);
143 mOvershootEnabled = true;
147 if( mComponents.find(type) == mComponents.end() )
149 // Create ScrollComponent
150 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Self());
151 Toolkit::ScrollComponent scrollComponent = NewScrollComponent(scrollable, type);
152 Toolkit::ScrollComponentImpl& component = static_cast<Toolkit::ScrollComponentImpl&>(scrollComponent.GetImplementation());
153 ScrollComponentPtr componentPtr(&component);
155 mComponents[type] = componentPtr;
159 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
161 if(type == Toolkit::Scrollable::OvershootIndicator)
163 if( mOvershootEnabled )
165 SetOvershootEnabled(false);
166 mOvershootEnabled = false;
170 ComponentIter pair = mComponents.find( type );
172 if( mComponents.end() != pair )
174 ScrollComponentPtr component = pair->second;
176 // Disconnect the scroll component first.
177 component->OnDisconnect();
179 // Destroy ScrollComponent.
180 mComponents.erase( type );
184 Vector4 Scrollable::GetOvershootEffectColor() const
186 return mOvershootEffectColor;
189 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
191 mOvershootAnimationSpeed = pixelsPerSecond;
194 float Scrollable::GetOvershootAnimationSpeed() const
196 return mOvershootAnimationSpeed;
199 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
201 return mScrollStartedSignal;
204 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
206 return mScrollUpdatedSignal;
209 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
211 return mScrollCompletedSignal;
214 Toolkit::Scrollable::ScrollClampedSignalType& Scrollable::ScrollClampedSignal()
216 return mScrollClampedSignal;
219 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
221 Dali::BaseHandle handle( object );
223 bool connected( true );
224 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
226 if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
228 scrollable.ScrollStartedSignal().Connect( tracker, functor );
230 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
232 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
234 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
236 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
238 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_CLAMPED ) )
240 scrollable.ScrollClampedSignal().Connect( tracker, functor );
244 // signalName does not match any signal
251 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
253 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
257 Scrollable& scrollableImpl( GetImpl( scrollable ) );
260 case Toolkit::Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR:
262 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
265 case Toolkit::Scrollable::PROPERTY_OVERSHOOT_ANIMATION_SPEED:
267 scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
274 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
276 Property::Value value;
278 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
282 Scrollable& scrollableImpl( GetImpl( scrollable ) );
285 case Toolkit::Scrollable::PROPERTY_OVERSHOOT_EFFECT_COLOR:
287 value = scrollableImpl.GetOvershootEffectColor();
290 case Toolkit::Scrollable::PROPERTY_OVERSHOOT_ANIMATION_SPEED:
292 value = scrollableImpl.GetOvershootAnimationSpeed();
301 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
303 Toolkit::ScrollComponent instance;
307 case Toolkit::Scrollable::VerticalScrollBar:
309 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
312 case Toolkit::Scrollable::HorizontalScrollBar:
314 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
317 case Toolkit::Scrollable::OvershootIndicator:
319 DALI_ASSERT_ALWAYS(!"Unrecognized component type");
327 } // namespace Internal
329 } // namespace Toolkit