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( Scrollable, "overshoot-effect-color", VECTOR4, OVERSHOOT_EFFECT_COLOR )
51 DALI_PROPERTY_REGISTRATION( Scrollable, "overshoot-animation-speed", FLOAT, OVERSHOOT_ANIMATION_SPEED )
53 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "scroll-relative-position", VECTOR3, SCROLL_RELATIVE_POSITION)
54 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "scroll-position-min", VECTOR3, SCROLL_POSITION_MIN)
55 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "scroll-position-max", VECTOR3, SCROLL_POSITION_MAX)
56 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "scroll-direction", VECTOR3, SCROLL_DIRECTION)
57 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "can-scroll-vertical", BOOLEAN, CAN_SCROLL_VERTICAL)
58 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "can-scroll-horizontal", BOOLEAN, CAN_SCROLL_HORIZONTAL)
60 DALI_SIGNAL_REGISTRATION( Scrollable, "scroll-started", SIGNAL_SCROLL_STARTED )
61 DALI_SIGNAL_REGISTRATION( Scrollable, "scroll-completed", SIGNAL_SCROLL_COMPLETED )
62 DALI_SIGNAL_REGISTRATION( 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 | NO_SIZE_NEGOTIATION ) ),
79 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
80 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
81 mOvershootEnabled(false)
85 Scrollable::~Scrollable()
87 // Clear scroll components, forces their destruction before Scrollable is destroyed.
91 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
93 if(type == Toolkit::Scrollable::OvershootIndicator)
95 return mOvershootEnabled;
97 return (mComponents.find(type) != mComponents.end());
100 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
102 if(type == Toolkit::Scrollable::OvershootIndicator)
104 if( !mOvershootEnabled )
106 SetOvershootEnabled(true);
107 mOvershootEnabled = true;
111 if( mComponents.find(type) == mComponents.end() )
113 // Create ScrollComponent
114 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Self());
115 Toolkit::ScrollComponent scrollComponent = NewScrollComponent(scrollable, type);
116 Toolkit::ScrollComponentImpl& component = static_cast<Toolkit::ScrollComponentImpl&>(scrollComponent.GetImplementation());
117 ScrollComponentPtr componentPtr(&component);
119 mComponents[type] = componentPtr;
123 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
125 if(type == Toolkit::Scrollable::OvershootIndicator)
127 if( mOvershootEnabled )
129 SetOvershootEnabled(false);
130 mOvershootEnabled = false;
134 ComponentIter pair = mComponents.find( type );
136 if( mComponents.end() != pair )
138 ScrollComponentPtr component = pair->second;
140 // Disconnect the scroll component first.
141 component->OnDisconnect();
143 // Destroy ScrollComponent.
144 mComponents.erase( type );
148 Vector4 Scrollable::GetOvershootEffectColor() const
150 return mOvershootEffectColor;
153 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
155 mOvershootAnimationSpeed = pixelsPerSecond;
158 float Scrollable::GetOvershootAnimationSpeed() const
160 return mOvershootAnimationSpeed;
163 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
165 return mScrollStartedSignal;
168 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
170 return mScrollUpdatedSignal;
173 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
175 return mScrollCompletedSignal;
178 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
180 Dali::BaseHandle handle( object );
182 bool connected( true );
183 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
185 if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
187 scrollable.ScrollStartedSignal().Connect( tracker, functor );
189 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
191 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
193 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
195 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
199 // signalName does not match any signal
206 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
208 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
212 Scrollable& scrollableImpl( GetImpl( scrollable ) );
215 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
217 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
220 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
222 scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
229 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
231 Property::Value value;
233 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
237 Scrollable& scrollableImpl( GetImpl( scrollable ) );
240 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
242 value = scrollableImpl.GetOvershootEffectColor();
245 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
247 value = scrollableImpl.GetOvershootAnimationSpeed();
256 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
258 Toolkit::ScrollComponent instance;
262 case Toolkit::Scrollable::VerticalScrollBar:
264 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
267 case Toolkit::Scrollable::HorizontalScrollBar:
269 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
272 case Toolkit::Scrollable::OvershootIndicator:
274 DALI_ASSERT_ALWAYS(!"Unrecognized component type");
282 } // namespace Internal
284 } // namespace Toolkit