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/devel-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 )
54 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollRelativePosition", VECTOR2, SCROLL_RELATIVE_POSITION)
55 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollPositionMin", VECTOR2, SCROLL_POSITION_MIN)
56 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMinX", SCROLL_POSITION_MIN_X, SCROLL_POSITION_MIN, 0)
57 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMinY", SCROLL_POSITION_MIN_Y, SCROLL_POSITION_MIN, 1)
58 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scrollPositionMax", VECTOR2, SCROLL_POSITION_MAX)
59 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMaxX", SCROLL_POSITION_MAX_X, SCROLL_POSITION_MAX, 0)
60 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scrollPositionMaxY", SCROLL_POSITION_MAX_Y, SCROLL_POSITION_MAX, 1)
61 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "canScrollVertical", BOOLEAN, CAN_SCROLL_VERTICAL)
62 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "canScrollHorizontal", BOOLEAN, CAN_SCROLL_HORIZONTAL)
64 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scrollStarted", SIGNAL_SCROLL_STARTED )
65 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scrollCompleted", SIGNAL_SCROLL_COMPLETED )
66 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scrollUpdated", SIGNAL_SCROLL_UPDATED )
68 DALI_TYPE_REGISTRATION_END()
70 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
71 const float DEFAULT_OVERSHOOT_ANIMATION_SPEED(120.0f); // 120 pixels per second
72 const Vector2 OVERSHOOT_DEFAULT_SIZE( 720.0f, 42.0f );
76 ///////////////////////////////////////////////////////////////////////////////////////////////////
78 ///////////////////////////////////////////////////////////////////////////////////////////////////
80 // Scrollable controls are not layout containers so they dont need size negotiation..
81 // we dont want size negotiation while scrolling if we can avoid it
82 Scrollable::Scrollable()
83 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | DISABLE_SIZE_NEGOTIATION ) ),
84 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
85 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
86 mOvershootSize( OVERSHOOT_DEFAULT_SIZE ),
87 mOvershootEnabled(true)
91 Scrollable::Scrollable( ControlBehaviour behaviourFlags )
92 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | behaviourFlags ) ),
93 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
94 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
95 mOvershootSize( OVERSHOOT_DEFAULT_SIZE ),
96 mOvershootEnabled(true)
100 Scrollable::~Scrollable()
104 bool Scrollable::IsOvershootEnabled() const
106 return mOvershootEnabled;
109 void Scrollable::SetOvershootEnabled(bool enable)
111 EnableScrollOvershoot(enable);
112 mOvershootEnabled = enable;
115 Vector4 Scrollable::GetOvershootEffectColor() const
117 return mOvershootEffectColor;
120 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
122 mOvershootAnimationSpeed = pixelsPerSecond;
125 float Scrollable::GetOvershootAnimationSpeed() const
127 return mOvershootAnimationSpeed;
130 const Vector2& Scrollable::GetOvershootSize() const
132 return mOvershootSize;
135 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
137 return mScrollStartedSignal;
140 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
142 return mScrollUpdatedSignal;
145 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
147 return mScrollCompletedSignal;
150 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
152 Dali::BaseHandle handle( object );
154 bool connected( true );
155 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
157 if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
159 scrollable.ScrollStartedSignal().Connect( tracker, functor );
161 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
163 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
165 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
167 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
171 // signalName does not match any signal
178 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
180 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
184 Scrollable& scrollableImpl( GetImpl( scrollable ) );
187 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
189 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
192 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
194 scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
197 case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
199 scrollableImpl.SetOvershootEnabled( value.Get<bool>() );
202 case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
205 if( value.Get( input ) )
207 scrollableImpl.mOvershootSize = input;
209 scrollableImpl.EnableScrollOvershoot( scrollableImpl.IsOvershootEnabled() );
216 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
218 Property::Value value;
220 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
224 Scrollable& scrollableImpl( GetImpl( scrollable ) );
227 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
229 value = scrollableImpl.GetOvershootEffectColor();
232 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
234 value = scrollableImpl.GetOvershootAnimationSpeed();
237 case Toolkit::Scrollable::Property::OVERSHOOT_ENABLED:
239 value = scrollableImpl.IsOvershootEnabled();
242 case Toolkit::Scrollable::Property::OVERSHOOT_SIZE:
244 value = scrollableImpl.mOvershootSize;
253 } // namespace Internal
255 } // namespace Toolkit