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>
20 #include <dali/public-api/object/type-registry-helper.h>
23 #include <dali-toolkit/internal/controls/scrollable/scrollable-impl.h>
24 #include <dali-toolkit/internal/controls/scroll-component/scroll-bar-internal-impl.h>
42 // empty handle as we cannot create Scrollable (but type registered for scroll signal)
46 // Setup properties, signals and actions using the type-registry.
47 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::Scrollable, Toolkit::Control, Create );
49 DALI_PROPERTY_REGISTRATION( Scrollable, "overshoot-effect-color", VECTOR4, OVERSHOOT_EFFECT_COLOR )
50 DALI_PROPERTY_REGISTRATION( Scrollable, "overshoot-animation-speed", FLOAT, OVERSHOOT_ANIMATION_SPEED )
52 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "scroll-relative-position", VECTOR3, SCROLL_RELATIVE_POSITION)
53 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "scroll-position-min", VECTOR3, SCROLL_POSITION_MIN)
54 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "scroll-position-max", VECTOR3, SCROLL_POSITION_MAX)
55 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "scroll-direction", VECTOR3, SCROLL_DIRECTION)
56 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "can-scroll-vertical", BOOLEAN, CAN_SCROLL_VERTICAL)
57 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Scrollable, "can-scroll-horizontal", BOOLEAN, CAN_SCROLL_HORIZONTAL)
59 DALI_SIGNAL_REGISTRATION( Scrollable, "scroll-started", SIGNAL_SCROLL_STARTED )
60 DALI_SIGNAL_REGISTRATION( Scrollable, "scroll-completed", SIGNAL_SCROLL_COMPLETED )
61 DALI_SIGNAL_REGISTRATION( Scrollable, "scroll-updated", SIGNAL_SCROLL_UPDATED )
63 DALI_TYPE_REGISTRATION_END()
65 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
66 const float DEFAULT_OVERSHOOT_ANIMATION_SPEED(120.0f); // 120 pixels per second
70 ///////////////////////////////////////////////////////////////////////////////////////////////////
72 ///////////////////////////////////////////////////////////////////////////////////////////////////
74 // Scrollable controls are not layout containers so they dont need size negotiation..
75 // we dont want size negotiation while scrolling if we can avoid it
76 Scrollable::Scrollable()
77 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | NO_SIZE_NEGOTIATION ) ),
78 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
79 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
80 mOvershootEnabled(false)
84 Scrollable::~Scrollable()
86 // Clear scroll components, forces their destruction before Scrollable is destroyed.
90 bool Scrollable::IsScrollComponentEnabled(Toolkit::Scrollable::ScrollComponentType type) const
92 if(type == Toolkit::Scrollable::OvershootIndicator)
94 return mOvershootEnabled;
96 return (mComponents.find(type) != mComponents.end());
99 void Scrollable::EnableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
101 if(type == Toolkit::Scrollable::OvershootIndicator)
103 if( !mOvershootEnabled )
105 SetOvershootEnabled(true);
106 mOvershootEnabled = true;
110 if( mComponents.find(type) == mComponents.end() )
112 // Create ScrollComponent
113 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast(Self());
114 Toolkit::ScrollComponent scrollComponent = NewScrollComponent(scrollable, type);
115 Toolkit::ScrollComponentImpl& component = static_cast<Toolkit::ScrollComponentImpl&>(scrollComponent.GetImplementation());
116 ScrollComponentPtr componentPtr(&component);
118 mComponents[type] = componentPtr;
122 void Scrollable::DisableScrollComponent(Toolkit::Scrollable::ScrollComponentType type)
124 if(type == Toolkit::Scrollable::OvershootIndicator)
126 if( mOvershootEnabled )
128 SetOvershootEnabled(false);
129 mOvershootEnabled = false;
133 ComponentIter pair = mComponents.find( type );
135 if( mComponents.end() != pair )
137 ScrollComponentPtr component = pair->second;
139 // Disconnect the scroll component first.
140 component->OnDisconnect();
142 // Destroy ScrollComponent.
143 mComponents.erase( type );
147 Vector4 Scrollable::GetOvershootEffectColor() const
149 return mOvershootEffectColor;
152 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
154 mOvershootAnimationSpeed = pixelsPerSecond;
157 float Scrollable::GetOvershootAnimationSpeed() const
159 return mOvershootAnimationSpeed;
162 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
164 return mScrollStartedSignal;
167 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
169 return mScrollUpdatedSignal;
172 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
174 return mScrollCompletedSignal;
177 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
179 Dali::BaseHandle handle( object );
181 bool connected( true );
182 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
184 if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
186 scrollable.ScrollStartedSignal().Connect( tracker, functor );
188 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
190 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
192 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
194 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
198 // signalName does not match any signal
205 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
207 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
211 Scrollable& scrollableImpl( GetImpl( scrollable ) );
214 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
216 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
219 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
221 scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
228 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
230 Property::Value value;
232 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
236 Scrollable& scrollableImpl( GetImpl( scrollable ) );
239 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
241 value = scrollableImpl.GetOvershootEffectColor();
244 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
246 value = scrollableImpl.GetOvershootAnimationSpeed();
255 Toolkit::ScrollComponent Scrollable::NewScrollComponent(Toolkit::Scrollable& scrollable, Toolkit::Scrollable::ScrollComponentType type)
257 Toolkit::ScrollComponent instance;
261 case Toolkit::Scrollable::VerticalScrollBar:
263 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, true));
266 case Toolkit::Scrollable::HorizontalScrollBar:
268 instance = static_cast<Toolkit::ScrollComponent>(Toolkit::ScrollBarInternal::New(scrollable, false));
271 case Toolkit::Scrollable::OvershootIndicator:
273 DALI_ASSERT_ALWAYS(!"Unrecognized component type");
281 } // namespace Internal
283 } // namespace Toolkit