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, "overshoot-effect-color", VECTOR4, OVERSHOOT_EFFECT_COLOR )
50 DALI_PROPERTY_REGISTRATION( Toolkit, Scrollable, "overshoot-animation-speed", FLOAT, OVERSHOOT_ANIMATION_SPEED )
52 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-relative-position", VECTOR2, SCROLL_RELATIVE_POSITION)
53 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-position-min", VECTOR2, SCROLL_POSITION_MIN)
54 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scroll-position-min-x", SCROLL_POSITION_MIN_X, SCROLL_POSITION_MIN, 0)
55 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scroll-position-min-y", SCROLL_POSITION_MIN_Y, SCROLL_POSITION_MIN, 1)
56 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "scroll-position-max", VECTOR2, SCROLL_POSITION_MAX)
57 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scroll-position-max-x", SCROLL_POSITION_MAX_X, SCROLL_POSITION_MAX, 0)
58 DALI_ANIMATABLE_PROPERTY_COMPONENT_REGISTRATION( Toolkit, Scrollable, "scroll-position-max-y", SCROLL_POSITION_MAX_Y, SCROLL_POSITION_MAX, 1)
59 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "can-scroll-vertical", BOOLEAN, CAN_SCROLL_VERTICAL)
60 DALI_ANIMATABLE_PROPERTY_REGISTRATION( Toolkit, Scrollable, "can-scroll-horizontal", BOOLEAN, CAN_SCROLL_HORIZONTAL)
62 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scroll-started", SIGNAL_SCROLL_STARTED )
63 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scroll-completed", SIGNAL_SCROLL_COMPLETED )
64 DALI_SIGNAL_REGISTRATION( Toolkit, Scrollable, "scroll-updated", SIGNAL_SCROLL_UPDATED )
66 DALI_TYPE_REGISTRATION_END()
68 const Vector4 DEFAULT_OVERSHOOT_COLOUR(0.0f, 0.64f, 0.85f, 0.25f);
69 const float DEFAULT_OVERSHOOT_ANIMATION_SPEED(120.0f); // 120 pixels per second
73 ///////////////////////////////////////////////////////////////////////////////////////////////////
75 ///////////////////////////////////////////////////////////////////////////////////////////////////
77 // Scrollable controls are not layout containers so they dont need size negotiation..
78 // we dont want size negotiation while scrolling if we can avoid it
79 Scrollable::Scrollable()
80 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | DISABLE_SIZE_NEGOTIATION ) ),
81 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
82 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
83 mOvershootEnabled(false)
87 Scrollable::Scrollable( ControlBehaviour behaviourFlags )
88 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS | REQUIRES_STYLE_CHANGE_SIGNALS | behaviourFlags ) ),
89 mOvershootEffectColor( DEFAULT_OVERSHOOT_COLOUR ),
90 mOvershootAnimationSpeed ( DEFAULT_OVERSHOOT_ANIMATION_SPEED ),
91 mOvershootEnabled(false)
95 Scrollable::~Scrollable()
99 bool Scrollable::IsOvershootEnabled() const
101 return mOvershootEnabled;
104 void Scrollable::SetOvershootEnabled(bool enable)
106 EnableScrollOvershoot(enable);
107 mOvershootEnabled = enable;
110 Vector4 Scrollable::GetOvershootEffectColor() const
112 return mOvershootEffectColor;
115 void Scrollable::SetOvershootAnimationSpeed( float pixelsPerSecond )
117 mOvershootAnimationSpeed = pixelsPerSecond;
120 float Scrollable::GetOvershootAnimationSpeed() const
122 return mOvershootAnimationSpeed;
125 Toolkit::Scrollable::ScrollStartedSignalType& Scrollable::ScrollStartedSignal()
127 return mScrollStartedSignal;
130 Toolkit::Scrollable::ScrollUpdatedSignalType& Scrollable::ScrollUpdatedSignal()
132 return mScrollUpdatedSignal;
135 Toolkit::Scrollable::ScrollCompletedSignalType& Scrollable::ScrollCompletedSignal()
137 return mScrollCompletedSignal;
140 bool Scrollable::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
142 Dali::BaseHandle handle( object );
144 bool connected( true );
145 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( handle );
147 if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_STARTED ) )
149 scrollable.ScrollStartedSignal().Connect( tracker, functor );
151 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_UPDATED ) )
153 scrollable.ScrollUpdatedSignal().Connect( tracker, functor );
155 else if( 0 == strcmp( signalName.c_str(), SIGNAL_SCROLL_COMPLETED ) )
157 scrollable.ScrollCompletedSignal().Connect( tracker, functor );
161 // signalName does not match any signal
168 void Scrollable::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
170 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
174 Scrollable& scrollableImpl( GetImpl( scrollable ) );
177 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
179 scrollableImpl.SetOvershootEffectColor( value.Get<Vector4>() );
182 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
184 scrollableImpl.SetOvershootAnimationSpeed( value.Get<float>() );
191 Property::Value Scrollable::GetProperty( BaseObject* object, Property::Index index )
193 Property::Value value;
195 Toolkit::Scrollable scrollable = Toolkit::Scrollable::DownCast( Dali::BaseHandle( object ) );
199 Scrollable& scrollableImpl( GetImpl( scrollable ) );
202 case Toolkit::Scrollable::Property::OVERSHOOT_EFFECT_COLOR:
204 value = scrollableImpl.GetOvershootEffectColor();
207 case Toolkit::Scrollable::Property::OVERSHOOT_ANIMATION_SPEED:
209 value = scrollableImpl.GetOvershootAnimationSpeed();
218 } // namespace Internal
220 } // namespace Toolkit