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>
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( Toolkit, Scrollable, "overshootEffectColor", VECTOR4, OVERSHOOT_EFFECT_COLOR )
50 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshootAnimationSpeed", FLOAT, OVERSHOOT_ANIMATION_SPEED )
51 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshootEnabled", BOOLEAN, OVERSHOOT_ENABLED )
52 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshootSize", VECTOR2, OVERSHOOT_SIZE )
53 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollToAlphaFunction", INTEGER, SCROLL_TO_ALPHA_FUNCTION )
55 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollRelativePosition", VECTOR2, SCROLL_RELATIVE_POSITION)
56 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollPositionMin", VECTOR2, SCROLL_POSITION_MIN)
57 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMinX", SCROLL_POSITION_MIN_X, SCROLL_POSITION_MIN, 0)
58 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMinY", SCROLL_POSITION_MIN_Y, SCROLL_POSITION_MIN, 1)
59 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollPositionMax", VECTOR2, SCROLL_POSITION_MAX)
60 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMaxX", SCROLL_POSITION_MAX_X, SCROLL_POSITION_MAX, 0)
61 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMaxY", SCROLL_POSITION_MAX_Y, SCROLL_POSITION_MAX, 1)
62 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "canScrollVertical", BOOLEAN, CAN_SCROLL_VERTICAL)
63 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "canScrollHorizontal", BOOLEAN, CAN_SCROLL_HORIZONTAL)
65 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scrollStarted", SIGNAL_SCROLL_STARTED )
66 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scrollCompleted", SIGNAL_SCROLL_COMPLETED )
67 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scrollUpdated", SIGNAL_SCROLL_UPDATED )
69 DALI_TYPE_REGISTRATION_END()
71 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
72 const float DEFAULT_OVERSHOOT_ANIMATION_SPEED(120.0f); // 120 pixels per second
73 const Vector2 OVERSHOOT_DEFAULT_SIZE( 720.0f, 42.0f );
77 ///////////////////////////////////////////////////////////////////////////////////////////////////
79 ///////////////////////////////////////////////////////////////////////////////////////////////////
81 // Scrollable controls are not layout containers so they dont need size negotiation..
82 // we dont want size negotiation while scrolling if we can avoid it
83 Scrollable::Scrollable()
84 : Control( ControlBehaviour( DISABLE_SIZE_NEGOTIATION ) ),
85 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
86 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
87 mOvershootSize( OVERSHOOT_DEFAULT_SIZE ),
88 mScrollToAlphaFunction( AlphaFunction::EASE_OUT ),
89 mScrollStartedSignal(),
90 mScrollUpdatedSignal(),
91 mScrollCompletedSignal(),
92 mOvershootEnabled(true)
96 Scrollable::Scrollable( ControlBehaviour behaviourFlags )
97 : Control( ControlBehaviour( behaviourFlags ) ),
98 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
99 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
100 mOvershootSize( OVERSHOOT_DEFAULT_SIZE ),
101 mScrollToAlphaFunction( AlphaFunction::EASE_OUT ),
102 mScrollStartedSignal(),
103 mScrollUpdatedSignal(),
104 mScrollCompletedSignal(),
105 mOvershootEnabled(true)
109 Scrollable::~Scrollable()
113 bool Scrollable::IsOvershootEnabled() const
115 return mOvershootEnabled;
118 void Scrollable::SetOvershootEnabled(bool enable)
120 EnableScrollOvershoot(enable);
121 mOvershootEnabled = enable;
124 Vector4 Scrollable::GetOvershootEffectColor() const
126 return mOvershootEffectColor;
129 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
131 mOvershootAnimationSpeed = pixelsPerSecond;
134 float Scrollable::GetOvershootAnimationSpeed() const
136 return mOvershootAnimationSpeed;
139 const Vector2& Scrollable::GetOvershootSize() const
141 return mOvershootSize;
144 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
146 return mScrollStartedSignal;
149 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
151 return mScrollUpdatedSignal;
154 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
156 return mScrollCompletedSignal;
159 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
161 Dali::BaseHandle handle( object );
163 bool connected( true );
164 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
166 if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
168 scrollable.ScrollStartedSignal().Connect( tracker, functor );
170 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
172 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
174 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
176 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
180 // signalName does not match any signal
187 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
189 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
193 Scrollable& scrollableImpl( GetImpl( scrollable ) );
196 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
198 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
201 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
203 scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
206 case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
208 scrollableImpl.SetOvershootEnabled( value.Get<bool>() );
211 case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
213 scrollableImpl.SetOvershootSize( value.Get<Vector2>() );
216 case Toolkit::Scrollable::Property::SCROLL_TO_ALPHA_FUNCTION:
218 int alphaFunction = value.Get<int>();
220 if( alphaFunction >= AlphaFunction::DEFAULT &&
221 alphaFunction < AlphaFunction::COUNT )
223 scrollableImpl.mScrollToAlphaFunction = static_cast< AlphaFunction::BuiltinFunction >( alphaFunction );
231 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
233 Property::Value value;
235 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
239 Scrollable& scrollableImpl( GetImpl( scrollable ) );
242 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
244 value = scrollableImpl.GetOvershootEffectColor();
247 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
249 value = scrollableImpl.GetOvershootAnimationSpeed();
252 case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
254 value = scrollableImpl.IsOvershootEnabled();
257 case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
259 value = scrollableImpl.mOvershootSize;
262 case Toolkit::Scrollable::Property::SCROLL_TO_ALPHA_FUNCTION:
264 value = static_cast<int>( scrollableImpl.mScrollToAlphaFunction );
273 } // namespace Internal
275 } // namespace Toolkit