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 <cstring> // for strcmp
20 #include <dali/public-api/object/type-registry.h>
21 #include <dali/public-api/object/type-registry-helper.h>
24 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
25 #include <dali-toolkit/internal/controls/scroll-component/scroll-bar-internal-impl.h>
43 // empty handle as we cannot create Scrollable (but type registered for scroll signal)
47 // Setup properties, signals and actions using the type-registry.
48 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::Scrollable, Toolkit::Control, Create );
50 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshoot-effect-color", VECTOR4, OVERSHOOT_EFFECT_COLOR )
51 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshoot-animation-speed", FLOAT, OVERSHOOT_ANIMATION_SPEED )
53 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-relative-position", VECTOR3, SCROLL_RELATIVE_POSITION )
54 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-position-min", VECTOR3, SCROLL_POSITION_MIN )
55 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-position-max", VECTOR3, SCROLL_POSITION_MAX )
56 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-direction", VECTOR3, SCROLL_DIRECTION )
57 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "can-scroll-vertical", BOOLEAN, CAN_SCROLL_VERTICAL )
58 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "can-scroll-horizontal", BOOLEAN, CAN_SCROLL_HORIZONTAL )
60 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scroll-started", SIGNAL_SCROLL_STARTED )
61 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scroll-completed", SIGNAL_SCROLL_COMPLETED )
62 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scroll-updated", SIGNAL_SCROLL_UPDATED )
64 DALI_TYPE_REGISTRATION_END()
66 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
67 const float DEFAULT_OVERSHOOT_ANIMATION_SPEED(120.0f); // 120 pixels per second
71 ///////////////////////////////////////////////////////////////////////////////////////////////////
73 ///////////////////////////////////////////////////////////////////////////////////////////////////
75 // Scrollable controls are not layout containers so they dont need size negotiation..
76 // we dont want size negotiation while scrolling if we can avoid it
77 Scrollable::Scrollable()
78 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | DISABLE_SIZE_NEGOTIATION ) ),
79 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
80 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
81 mOvershootEnabled(false)
85 Scrollable::Scrollable( ControlBehaviour behaviourFlags )
86 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | behaviourFlags ) ),
87 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
88 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
89 mOvershootEnabled(false)
93 Scrollable::~Scrollable()
95 // Clear scroll components, forces their destruction before Scrollable is destroyed.
99 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
101 if(type == Toolkit::Scrollable::OvershootIndicator)
103 return mOvershootEnabled;
105 return (mComponents.find(type) != mComponents.end());
108 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
110 if(type == Toolkit::Scrollable::OvershootIndicator)
112 if( !mOvershootEnabled )
114 SetOvershootEnabled(true);
115 mOvershootEnabled = true;
119 if( mComponents.find(type) == mComponents.end() )
121 // Create ScrollComponent
122 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Self());
123 Toolkit::ScrollComponent scrollComponent = NewScrollComponent(scrollable, type);
124 Toolkit::ScrollComponentImpl& component = static_cast<Toolkit::ScrollComponentImpl&>(scrollComponent.GetImplementation());
125 ScrollComponentPtr componentPtr(&component);
127 mComponents[type] = componentPtr;
131 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
133 if(type == Toolkit::Scrollable::OvershootIndicator)
135 if( mOvershootEnabled )
137 SetOvershootEnabled(false);
138 mOvershootEnabled = false;
142 ComponentIter pair = mComponents.find( type );
144 if( mComponents.end() != pair )
146 ScrollComponentPtr component = pair->second;
148 // Disconnect the scroll component first.
149 component->OnDisconnect();
151 // Destroy ScrollComponent.
152 mComponents.erase( type );
156 Vector4 Scrollable::GetOvershootEffectColor() const
158 return mOvershootEffectColor;
161 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
163 mOvershootAnimationSpeed = pixelsPerSecond;
166 float Scrollable::GetOvershootAnimationSpeed() const
168 return mOvershootAnimationSpeed;
171 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
173 return mScrollStartedSignal;
176 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
178 return mScrollUpdatedSignal;
181 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
183 return mScrollCompletedSignal;
186 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
188 Dali::BaseHandle handle( object );
190 bool connected( true );
191 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
193 if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
195 scrollable.ScrollStartedSignal().Connect( tracker, functor );
197 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
199 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
201 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
203 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
207 // signalName does not match any signal
214 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
216 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
220 Scrollable& scrollableImpl( GetImpl( scrollable ) );
223 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
225 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
228 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
230 scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
237 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
239 Property::Value value;
241 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
245 Scrollable& scrollableImpl( GetImpl( scrollable ) );
248 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
250 value = scrollableImpl.GetOvershootEffectColor();
253 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
255 value = scrollableImpl.GetOvershootAnimationSpeed();
264 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
266 Toolkit::ScrollComponent instance;
270 case Toolkit::Scrollable::VerticalScrollBar:
272 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
275 case Toolkit::Scrollable::HorizontalScrollBar:
277 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
280 case Toolkit::Scrollable::OvershootIndicator:
282 DALI_ASSERT_ALWAYS(!"Unrecognized component type");
290 } // namespace Internal
292 } // namespace Toolkit