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/control/control-data-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, "overshootEffectColor", VECTOR4, OVERSHOOT_EFFECT_COLOR )
51 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshootAnimationSpeed", FLOAT, OVERSHOOT_ANIMATION_SPEED )
52 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshootEnabled", BOOLEAN, OVERSHOOT_ENABLED )
53 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshootSize", VECTOR2, OVERSHOOT_SIZE )
54 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollToAlphaFunction", INTEGER, SCROLL_TO_ALPHA_FUNCTION )
56 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollRelativePosition", VECTOR2, SCROLL_RELATIVE_POSITION)
57 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollPositionMin", VECTOR2, SCROLL_POSITION_MIN)
58 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMinX", SCROLL_POSITION_MIN_X, SCROLL_POSITION_MIN, 0)
59 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMinY", SCROLL_POSITION_MIN_Y, SCROLL_POSITION_MIN, 1)
60 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollPositionMax", VECTOR2, SCROLL_POSITION_MAX)
61 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMaxX", SCROLL_POSITION_MAX_X, SCROLL_POSITION_MAX, 0)
62 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMaxY", SCROLL_POSITION_MAX_Y, SCROLL_POSITION_MAX, 1)
63 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "canScrollVertical", BOOLEAN, CAN_SCROLL_VERTICAL)
64 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "canScrollHorizontal", BOOLEAN, CAN_SCROLL_HORIZONTAL)
66 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scrollStarted", SIGNAL_SCROLL_STARTED )
67 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scrollCompleted", SIGNAL_SCROLL_COMPLETED )
68 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scrollUpdated", SIGNAL_SCROLL_UPDATED )
70 DALI_TYPE_REGISTRATION_END()
72 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
73 const float DEFAULT_OVERSHOOT_ANIMATION_SPEED(120.0f); // 120 pixels per second
74 const Vector2 OVERSHOOT_DEFAULT_SIZE( 720.0f, 42.0f );
78 ///////////////////////////////////////////////////////////////////////////////////////////////////
80 ///////////////////////////////////////////////////////////////////////////////////////////////////
82 Scrollable::Scrollable( ControlBehaviour behaviourFlags )
83 : Control( ControlBehaviour( behaviourFlags ) ),
84 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
85 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
86 mOvershootSize( OVERSHOOT_DEFAULT_SIZE ),
87 mScrollToAlphaFunction( AlphaFunction::EASE_OUT ),
88 mScrollStartedSignal(),
89 mScrollUpdatedSignal(),
90 mScrollCompletedSignal(),
91 mOvershootEnabled(true)
95 Scrollable::~Scrollable()
99 bool Scrollable::AccessibleImpl::IsScrollable()
104 void Scrollable::OnInitialize()
106 DevelControl::SetAccessibilityConstructor( Self(), []( Dali::Actor actor ) {
107 return std::unique_ptr< Dali::Accessibility::Accessible >(
108 new AccessibleImpl( actor, Dali::Accessibility::Role::SCROLL_PANE ) );
112 bool Scrollable::IsOvershootEnabled() const
114 return mOvershootEnabled;
117 void Scrollable::SetOvershootEnabled(bool enable)
119 EnableScrollOvershoot(enable);
120 mOvershootEnabled = enable;
123 Vector4 Scrollable::GetOvershootEffectColor() const
125 return mOvershootEffectColor;
128 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
130 mOvershootAnimationSpeed = pixelsPerSecond;
133 float Scrollable::GetOvershootAnimationSpeed() const
135 return mOvershootAnimationSpeed;
138 const Vector2& Scrollable::GetOvershootSize() const
140 return mOvershootSize;
143 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
145 return mScrollStartedSignal;
148 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
150 return mScrollUpdatedSignal;
153 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
155 return mScrollCompletedSignal;
158 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
160 Dali::BaseHandle handle( object );
162 bool connected( true );
163 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
165 if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
167 scrollable.ScrollStartedSignal().Connect( tracker, functor );
169 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
171 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
173 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
175 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
179 // signalName does not match any signal
186 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
188 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
192 Scrollable& scrollableImpl( GetImpl( scrollable ) );
195 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
197 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
200 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
202 scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
205 case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
207 scrollableImpl.SetOvershootEnabled( value.Get<bool>() );
210 case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
212 scrollableImpl.SetOvershootSize( value.Get<Vector2>() );
215 case Toolkit::Scrollable::Property::SCROLL_TO_ALPHA_FUNCTION:
217 int alphaFunction = value.Get<int>();
219 if( alphaFunction >= AlphaFunction::DEFAULT &&
220 alphaFunction < AlphaFunction::COUNT )
222 scrollableImpl.mScrollToAlphaFunction = static_cast< AlphaFunction::BuiltinFunction >( alphaFunction );
230 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
232 Property::Value value;
234 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
238 Scrollable& scrollableImpl( GetImpl( scrollable ) );
241 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
243 value = scrollableImpl.GetOvershootEffectColor();
246 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
248 value = scrollableImpl.GetOvershootAnimationSpeed();
251 case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
253 value = scrollableImpl.IsOvershootEnabled();
256 case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
258 value = scrollableImpl.mOvershootSize;
261 case Toolkit::Scrollable::Property::SCROLL_TO_ALPHA_FUNCTION:
263 value = static_cast<int>( scrollableImpl.mScrollToAlphaFunction );
272 } // namespace Internal
274 } // namespace Toolkit